ADD BuyerCredit API Version 1
Modified on: Mon, 18 Jan, 2021 at 9:57 AM
Summary
This API allows you to add credit for a specific Buyer.
Note This API adds a prepay amount. Regular credit is handled through the ADDEDIT Buyer API.
Current Version: Version 1
Deprecated Versions: N/A
Requests Allowed: GET & SOAP
Resource / WSDL Page
http://<your_domain_here>/api/1/add.asmx?op=BuyerCredit
Parameters
All parameters are required in every API call. Parameters not being used should be passed as a null value.
| Parameter | Required | Type | Description |
|---|---|---|---|
api_key | Required | STRING | Valid API key (not expired). Max 50 chars. Obtained from CAKE >> Setup >> Permissions >> API Key list. Example: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh |
buyer_id | Required | INTEGER | Unique Buyer ID. Obtained via Export Buyers API. Example: 530 |
credit_type | Required | ENUMERATION | Specifies the credit type to apply:
|
credit_to_add | Required | STRING | Credit amount to add. Used when credit_type is set to limited.Example: 500, 50 |
Example Request
GET https://demo-new.cakemarketing.com/api/1/add.asmx/BuyerCredit ?api_key=3YmDJeT3VHTFhDqAjr2OlQ &buyer_id=1326 &credit_type=limited &credit_to_add=23000
Sample XML Response
<buyer_credit_add_response> <success>true</success> <message>Buyer Credit Updated Successfully</message> </buyer_credit_add_response>
Error Messages
| Error Message | Likely Cause |
|---|---|
| Invalid API Key | API key does not exist or is expired. |