Balance Module
The Balance Module can be used to retrieve a current balance of a merchant account.
Entry point: /rest/v1/balance [/<merchant-id>]
REST request elements
| Field name | Type | Description |
|---|---|---|
[request] | container | General container for this resource. (XML only) |
Optional request URL field
| Field name | Description | |
|---|---|---|
merchant-id | merchant_id to retrieve for resellers/partners. Default will be the id of the account accessing the API. |
Response
The response will be in the format specified in the request (see API Format) and will contain the following elements:
| Parameter | Type | Description |
|---|---|---|
success | boolean (1/TRUE/0/FALSE) indicating the result of the call | |
message | optional textual message indicating what went wrong in case the call was unsuccessful | |
auth | API session key; can be used in subsequent calls to the API |
| Parameter | Type | Description |
|---|---|---|
balance | array | Array with balance details (see below) |
balance array:
| Parameter | Description | |
|---|---|---|
currency | currency of the balance | |
cents | total balance in cents (can also be negative).1 | |
merchant_id | merchant-id of the balance (for reseller/agents retrieving other accounts) |
1Notes about total balance:
NoteTotal Balance
- This is the total balance available for batches or refunds which also includes any delayed amounts which may not yet have been received by CURO!
- Total balance is including any fees + 21% VAT (if applicable); these fees are automatically deducted from the total.
Balance Details
Request additional balance details for a merchant account.
Entry point: /rest/v1/balancedetails[/<merchant-id>]
REST request elements
| Field name | Type | Description |
|---|---|---|
[request] | container | General container for this resource. (XML only) |
Optional request URL fields
| Field name | Description | |
|---|---|---|
merchant-id | merchant_id to retrieve for resellers/partners. Default will be the id of the account accessing the API. |
Response
The response will be in the format specified in the request (see API Format) and will contain the following elements:
| Parameter | Description | |
|---|---|---|
success | boolean (1/TRUE/0/FALSE) indicating the result of the call | |
message | optional textual message indicating what went wrong in case the call was unsuccessful | |
auth | API session key; can be used in subsequent calls to the API |
| Parameter | Description | |
|---|---|---|
merchant_id | merchant-id of the balance (for reseller/agents retrieving other accounts) | |
balances | array | Array with balance details (see below) |
balances array:
| Parameter | Description | |
|---|---|---|
type | type of balance (see below) | |
currency | currency of the balance | |
cents | balance in cents (can also be negative) |
type of balance:
| Value | Description |
|---|---|
total1 | total balance. |
outstanding 2 | total outstanding amount including delayed and reserves. |
delayed | total amount of delayed balance that is scheduled to be paid out in the future. This is including any revenue ready to be cleared but not yet received by CURO. |
reserve | total amount of reserved balance. |
commission | total amount of commission for resellers/partners. |
1 Notes about total:
- This is the total balance available for batches or refunds which also includes any delayed amounts which may not yet have been received by CURO!
- Total balance is including any fees + 21% VAT (if applicable); these fees are automatically deducted from the total.
2 Notes about outstanding:
- This is the total balance including any fees but without 21% VAT (if applicable).
Updated 2 months ago
Did this page help you?