Settlements
A settlement is created from completed Payment Requests over a specified period for each supported Asset Type for each Merchant.
Settlements can only be created if the merchant has a Settlement Config.
Contents
Models
Settlement
Mandatory Fields
Field | Type | Description |
---|---|---|
id | String | The unique identifier for the settlement. |
status | String | The status of the settlement. |
assetType | String | The Asset Type being settled. |
currency | String | The settlement currency. |
createdAt | Timestamp | When the Settlement was created. |
createdBy | CRN | The User or API Key that created the Settlement. |
Optional Fields
Field | Type | Description |
---|---|---|
settledAt | Timestamp | The time when settlement was completed. |
settledBy | CRN | The User or API Key that completed the Settlement. |
settlementAmount | BigNumber | The total amount of the settlement. |
settlementBankAccountId | String | The ID of the bank account used for settlement. |
Operations
List Settlements
GET /
curl https://service.centrapay.com/api/merchants/5ee0c486308f590260d9a07f/settlements \
-H "X-Api-Key: $api_key"
Example response payload
{
"items": [
{
"id": "89028sh9308f590260d9a07f",
"status": "confirmed",
"assetType": "centrapay.nzd.main",
"currency": "NZD",
"createdAt": "2021-11-12T01:17:46.499Z",
"createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
"settledAt": "2021-11-13T11:59:59.999Z",
"settledBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
"settlementAmount": "2500",
"settlementBankAccountId": "67e0c486308f590260d9a139"
},
{
"id": "9ds2cs89028sh90260d9f91h",
"status": "awaiting-confirmation",
"assetType": "centrapay.nzd.main",
"currency": "NZD",
"createdAt": "2021-11-13T01:17:46.499Z",
"createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
"settlementAmount": "2200",
"settlementBankAccountId": "67e0c486308f590260d9a139"
}
]
}