ADD AdvertiserCredit API

Updated on 2014-05-02
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET&SOAP

 

Summary:

Returns "Advertiser Credit Transaction Added" 

Resource/WSDL Page:

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


Parameters

api_key
Required
Type: STRING
Length (Max/Min): 50

Must be a valid API key (existing and NOT expired)

Example Values: Fo35NRAqvFLXoZxqB4aVMhh

advertiser_id
Required
Type: INT
Length (Max/Min): NA

Advertiser ID

Example Values: 12345

currency_id
Required
Type: BYTE
Length (Max/Min): NA

Received Currency ID.  0 to skip, only used if currency is enabled

Example Values: 0

amount
Required
Type: DECIMAL
Length (Max/Min): NA

The amount of credit allotted for digital spend

Example Values: 12.2

invoice_number
Required
Type: STRING
Length (Max/Min): NA

Invoice number.  No way to skip

Example Values: 1234

verification_code
Required
Type: STRING
Length (Max/Min): NA

Verification Code.  No way to skip

Example Values: 1234

notes
Required
Type: STRING
Length (Max/Min): NA

Freeform Notes

Example Values: These are notes

 **Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value). 

 

Example Request

GET

http://demo.cakemarketing.com/api/1/add.asmx/AdvertiserCredit?api_key=dNJFmId9rI&advertiser_id=178&currency_id=1&amount=40000&invoice_number=AlphaNumeric+123&verification_code=AlphaNumeric+456&notes=Funded+account

 

Sample XML Response:


<advertisercredit_add_response>
<success>true</success>
<message>Advertiser Credit Transaction Added</message>
</advertisercredit_add_response>

Example Error Messages:  

Error Message

Likely Cause

Invalid API Key

API key does not exist or is expired

Invalid Advertiser ID

advertiser_id does not match an advertiser in the system

Invalid Currency

Currency is enabled and currency_id does not match a currency in the system