ADD ManualCredit API V1
Updated on 2015-06-12
Current Version: Version 1
Deprecated Version: N/A
Requests Allowed: GET&SOAP
Summary:
Allows you to add manual credit (prepay) for a specific Buyer or Buyer Contract.
Resource/WSDL Page:
http://<your_domain_here>/api/1/add.asmx?op=ManualCredit
Parameters
| api_key Required Type: STRING Length (Max/Min): 50 | Must be a valid API key (existing and NOT expired) Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh |
| buyer_id Required Type: INTEGER Length (Max/Min): NA | Obtained via EXPORT Buyers API Example Values: 123 |
| buyer_contract_id Required Type: INTEGER Length (Max/Min): 50 | Obtained via EXPORT BuyerContracts API Example Values: Affiliate Name |
| amount Required Type: DECIMAL Length (Max/Min): NA | Credit amount Example Values: 44.50 |
| invoice_number Optional Type: BYTE Length (Max/Min): NA | Iinvoice number for this manual credit for tracking purposes Example Values: A33409B |
| verification_code Optional Type: BOOL Length (Max/Min): NA | Verification code for this manual credit for tracking purposes. Example Values: PPR54398 |
| notes Optional Type: STRING Length (Max/Min): 100 | Any notes you'd like to keep for this credit Example Values: adjustment+for+returns |
**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 | https://demo-new.cakemarketing.com/api/1/add.asmx/ManualCredit?api_key=3YmDJeT3VHTFhDqAjr2OlQ&amount=125000&invoice_number=&verification_code=¬es=&buyer_id=1326&buyer_contract_id=0 |
Sample XML Response:
| <string>Manual Credit Added Successfully</string> |
Example Error Messages:
| Error Message | Likely Cause |
| Invalid API Key | API key does not exist or is expired |