Retrieve GPA Balances

Action: GET
Endpoint: /balances/{token}

To return the general pupose account (GPA) ledger balance, available balance, and credit balance for a user or business, aggregated per campaign, issue a GET request to the /balances/{token} endpoint. Include the token path parameter to specify the user/business for which to return balances.

The return object includes a link to balances of existing MSAs.

URL Path Parameters

Name Type Required? Description Allowable Values
token string Yes The token identifying the user/business whose GPA balances you want to retrieve. Existing user/business token.

Issue GET to /users or /businesses to retrieve user/business tokens.

Sample Response Body

{
"gpa": {
"currency_code": "USD",
"ledger_balance": 1000,
"available_balance": 990,
"credit_balance": 0,
"pending_credits": 0,
"balances": {
"USD": {
"currency_code": "USD",
"ledger_balance": 1000,
"available_balance": 990,
"credit_balance": 0,
"pending_credits": 0
}
}
},
"links": [
{
"rel": "msas",
"method": "GET",
"href": "/v3/balances/my_user_01/msas"
}
]
}


Retrieve MSA Balances

Action: GET
Endpoint: /balances/{token}/msas

To return the merchant-specific account (MSA) balances for a user or business, aggregated per campaign, issue a GET request to the /balances/{token}/msas endpoint. Include the token path parameter to specify the user/business for which to return balances.

This endpoint supports sorting and pagination.

URL Path Parameters

Name Type Required? Description Allowable Values
token string Yes The token identifying the user/business whose MSA balances you want to retrieve. Existing user/business token.

Issue GET to /users or /businesses to retrieve existing user/business tokens.

Sample Response Body

{
"count": 1,
"start_index": 0,
"end_index": 1,
"is_more": false,
"data": [
{
"currency_code": "USD",
"ledger_balance": 100,
"available_balance": 100,
"credit_balance": 0,
"pending_credits": 0,
"name": "My Campaign 01",
"campaign_token": "my_campaign_01"
}
]
}


Retrieve Reserve Account Balances

Action: GET
Endpoint: /programreserve/balances

To return the program reserve account balances, issue a GET request to the /programreserve/balances endpoint.

Sample Response Body

{
"currency_code": "USD",
"ledger_balance": 10100,
"available_balance": 10100,
"credit_balance": 0,
"pending_credits": 0,
"balances": {
"USD": {
"currency_code": "USD",
"ledger_balance": 10100,
"available_balance": 10100,
"credit_balance": 0,
"pending_credits": 0
}
}


List Reserve Account Deposits

Action: GET
Endpoint: /programreserve/deposits

To return a list of program reserve account deposits, issue a GET request to the /programreserve/deposits
endpoint.

This endpoint supports sorting and pagination.

Sample Response Body

{
"count": 2,
"start_index": 0,
"end_index": 1,
"is_more": false,
"data": [
{
"created_time": "2017-05-10T21:52:18Z",
"last_modified_time": "2017-05-10T21:52:18Z",
"token": "my_deposit_02",
"amount": 120,
"currency_code": "USD",
"memo": "my_memo",
"tags": "my, tags",
"transaction_token": "154"
},
{
"created_time": "2017-05-10T21:51:28Z",
"last_modified_time": "2017-05-10T21:51:28Z",
"token": "my_deposit_01",
"amount": 100,
"currency_code": "USD",
"memo": "my_memo",
"tags": "my, tags",
"transaction_token": "153"
}
]
}