Go to home page
Docs API Reference

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 .

Settlement Model

Attributes

  • 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.

  • 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.

  • settlementBankTransferId

    string

    The ID of the Bank Transfer used for Settlement.

  • type

    string

    The type of the Settlement.

  • test

    boolean

    Flag indicating whether the Settlement is a test resource.

List Settlements

This endpoint allows you to list Settlements.

Request
curl -X GET \
 https://service.centrapay.com/api/merchants/5ee0c486308f590260d9a07f/settlements \
 -H 'x-api-key: <TOKEN>'
Response
{
  "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",
      "settlementBankTransferId": "MhocUmpxxmgdHjr7DgKoKw",
      "type": "centrapay",
      "test": false
    },
    {
      "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",
      "settlementBankTransferId": "57SyRRgZ1U8Kq2wKpCnSR5",
      "type": "centrapay",
      "test": false
    }
  ]
}