ADD BuyerCredit API Version 1

Timothy Johnson

Modified on: Mon, 18 Jan, 2021 at 9:57 AM

Add BuyerCredit API V1

Updated on 2015-06-12
Current Version: Version 1
Deprecated Version: N/A
Requests Allowed: GET/SOAP

This API allows you to add credit for a specific Buyer. NOTE: This API adds a prepay amount. Regular credit is handled through ADDEDIT Buyer API.

http://<your_domain_here>/api/1/add.asmx?op=BuyerCredit

api_key Required Type: STRING Length (Max/Min): 50	This api_key will provide you with the ability to export Campaigns for your instance. You can obtain this api_key from within CAKE >> Setup >> Permissions in the API Key list. Must be a valid API key (existing and NOT expired) Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh
buyer_id Required Type: INTEGER Length (Max/Min): N/A	Specific Buyer ID. Obtained via Export Buyers API Example Values: 530
credit_type Required Type: ENUMERATION Length (Max/Min): N/A	Allows you to state whether you’re using credit or not. Pass 'limited' for a limited amount and enter the amount in credit_to_add. Pass 'unlimited' for an unlimited amount and credit will be turned off. Pass 'no_change' for no change
credit_to_add Required Type: STRING Length (Max/Min): N/A	Credit amount to add Example Values: 500, 50

Sample XML Response:

<buyer_credit_add_response><success>true</success><message>Buyer Credit Updated Successfully</message></buyer_credit_add_response>

Example Error Messages:

Error Message	Likely Cause
Invalid API Key	API key does not exist or is expired.