List counterparty instruments

GET

/counterparty-instruments

Returns a paginated list of bank account instruments saved for counterparties belonging to the authenticated entity, sorted by creation date (newest first).

Pagination is cursor-based: to retrieve the next page, pass the cursor value returned in meta.pagination.cursor from the previous response. When meta.pagination.has_more is false, you have reached the end of the list.

Use the optional counterparty_id filter to scope the results to a single counterparty's saved instruments.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

A page of counterparty instruments returned successfully. If there are no instruments matching the query, data will be an empty array.

Bodyapplication/json

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location '/counterparty-instruments?counterparty_id=01HZ9KPQR3VTXMN84JWYB65CD0&cursor=01HZ9ABCDEFGH1234567890LMNO&limit=25' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Page with results and a next cursor

{
    "message": "Counterparty instruments retrieved successfully",
    "status": "success",
    "data": [
        {
            "id": "01HZ9ABCDEFGH1234567890LMNO",
            "entity_id": "01HZ9ABCD1234EFGH5678IJKL90",
            "counterparty_id": "01HZ9KPQR3VTXMN84JWYB65CD0",
            "account_number": "0123456789",
            "account_name": "Jane Doe",
            "bank_code": "044",
            "bank_name": "Access Bank",
            "status": "active",
            "country": "NG",
            "display_name": "Payroll account",
            "created": 1722870000000,
            "updated": 1722870000000
        },
        {
            "id": "01HZ9ZZZZZZZZZZZZZZZZZZZZZZ",
            "entity_id": "01HZ9ABCD1234EFGH5678IJKL90",
            "counterparty_id": "01HZ9KPQR3VTXMN84JWYB65CD0",
            "account_number": "0987654321",
            "account_name": "Jane Doe",
            "bank_code": "058",
            "bank_name": "GTBank",
            "status": "active",
            "country": "NG",
            "created": 1722860000000,
            "updated": 1722860000000
        }
    ],
    "meta": {
        "pagination": {
            "cursor": "01HZ9ZZZZZZZZZZZZZZZZZZZZZZ",
            "has_more": true
        }
    }
}

Modified at 2026-09-30 00:29:30

Add a bank account to a counterparty

Remove a counterparty's bank account