Sign in

v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB
Settlement Accounts

Get settlement rules

The GET /virtual-accounts/{accountId}/settlement-rules endpoint retrieves information about settlement rules, for a given settlement account, according to the settlement rule status in the request. If no status is provided, the endpoint retrieves all settlement rules for the settlement account.

get/virtual-accounts/{accountId}/settlement-rules

Path parameters

accountIdstring required

The system-generated, unique id which specifies the settlement account.

Request body

accountIdstring

The settlement account id.

status'ACTIVE' | 'INACTIVE'

The status of the settlement rule.

Example request

{
  "accountId": "pa:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV"
}

Response

Successful response

Example response

{
  "settlementRule": [
    {
      "payeeAccountDetails": {
        "name": "Customer Inc.",
        "ultimateCreditorName": "Customer Inc.",
        "accountNumber": "12345678",
        "bic": "HBUKGB7F261",
        "iban": "GB29NWBK60161331926819"
      },
      "description": "Auto Payout"
    }
  ]
}