Check Account Funds via API

GetAvailableFunds

This operation returns the amount of funds currently available in your Amazon Incentives account. It provides an alternative to logging into the Incentives API Portal to view available funds. You can use this operation to monitor your balance and raise alerts.

This is also a great call to use as an ‘Echo’ call to check to see if the Amazon Gift Card Services are working as expected.

Important: This operation is throttled at one transaction per second. Attempts to send requests at a greater rate will be ignored.

Note: Since there is no actual account balance in a Sandbox, the GetAvailableFunds operation will always return a zero balance.

GetAvailableFunds
- Requests
- Responses

Requests

Request Parameters

Parameter Name	Req.	Constraints	Type	Description
`partnerId`	Yes	Pre-Defined Value	String	A unique identifier (CASE SENSITIVE, 1st letter is capitalized and the next four are lower case) provided by the Amazon team. This value appears in the payload of every AGCOD Gateway request

Example Request

JSON
XML

XML

<GetAvailableFundsRequest>
	<partnerId>Aptuk</partnerId>
</GetAvailableFundsRequest>

JSON

POST/GetAvailableFunds 
HTTP/1.1accept:application/json
host:agcod-v2-gamma.amazon.com
x-amz-date:20170111T000339Z
x-amz-target:com.amazonaws.agcod.AGCODService.GetAvailableFunds
Authorization:AWS4-HMAC-SHA256 
Credential=AKIAIGHKAVYIDBOH3O3A/20170111/us-east-1/AGCODService/aws4_request,
SignedHeaders=accept;host;x-amz-date;x-amz-target, 
Signature=ec86661c1d39f74b5891666505bb7656b172b0d060d911bee3b6a1c29ae17657
{
  "partnerId": "Aptuk"
}

Responses

Response Parameters

Parameter Name	Constraints	Type	Description
`availableFunds`		Object	Contains the values for `amount` and `currencyCode`
`amount`		Long	The value of funds currently available in your prepay/postpay account. Note: the Sandbox environment will always return a zero value
`currencyCode`	ISO-4217 Currency Code	String	The ISO-4217 currency code
`status`		String	The status of the request. In normal operation, this value is `success`.
`timestamp`		Timestamp	Date returned in UTC yyyy-MM-dd HH:mm:ss

Example Response

JSON
XML

XML

<GetAvailableFunds>
	<availableFunds>
		<amount>10</amount>
		<currencyCode>USD</currencyCode>
	</availableFunds>
	<status>SUCCESS</status>
	<timestamp>20170915T200959Z</timestamp>
</GetAvailableFunds>

JSON

{
  "availableFunds": {
    "amount": 10,
    "currencyCode": "USD"
  },
  "status": "SUCCESS",
  "timestamp": "20170915T200959Z"
}

↑ Back to top

Next

Prepare to launch with our Test Plan Guide

Last updated: Oct 11, 2021