GET/counterparty/{userId}/counterparties/{counterpartyId}/instruments

List Instruments By Counterparty ID

Returns payment instruments associated with a counterparty. Supports optional filters for transfer types, currencies, statuses, and free-text search.

Path variables

Field	Type	Required	Possible values	Description
`userId`	string	Required	—	Unique user ID.
`counterpartyId`	string	Required	—	Unique counterparty ID.

Query parameters

Field	Type	Required	Possible values	Description
`transferTypes`	string	Optional	FVNet \| ACH \| WIRE \| INTERNATIONAL_WIRE \| STABLECOIN_WITHDRAW \| CROSS_BORDER_AED_DOMESTIC \| CROSS_BORDER_AED_WIRE \| CROSS_BORDER_ARS_DOMESTIC \| CROSS_BORDER_BRL_DOMESTIC \| CROSS_BORDER_CAD_DOMESTIC \| CROSS_BORDER_CAD_WIRE \| CROSS_BORDER_SEPA \| CROSS_BORDER_EUR_WIRE \| CROSS_BORDER_FASTER_PAYMENTS \| CROSS_BORDER_GBP_WIRE \| CROSS_BORDER_HKD_DOMESTIC \| CROSS_BORDER_HKD_WIRE \| CROSS_BORDER_JPY_DOMESTIC \| CROSS_BORDER_JPY_WIRE \| CROSS_BORDER_CLABE \| CROSS_BORDER_MXN_WIRE \| CROSS_BORDER_SGD_DOMESTIC \| CROSS_BORDER_SGD_WIRE \| CROSS_BORDER_ZAR_DOMESTIC \| CROSS_BORDER_ZAR_WIRE	Comma-separated list of transfer types to filter by.
`currencies`	string	Optional	USD \| AED \| ARS \| BRL \| CAD \| EUR \| GBP \| HKD \| JPY \| MXN \| SGD \| ZAR \| PYUSD	Comma-separated list of currencies to filter by.
`statuses`	string	Optional	active \| pending \| blocked \| disabled	Comma-separated list of statuses to filter by.
`searchText`	string	Optional	—	Free-text search across instrument names.

Headers

Field	Type	Required	Possible values	Description
`session-token`	string	Required	—	SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Response

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 201 \| 204 \| 301 \| 400 \| 401 \| 403 \| 404 \| 410 \| 422 \| 500 \| 503	API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
`ResponseMessage`	string	Success \| Created \| NoContent \| BadRequest \| Unauthorized \| Forbidden \| NotFound \| Gone \| UnprocessableContent \| ServerError \| ResourceMoved \| ServiceUnAvailable \| UnProcessableEntity	Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
`ResponseData`	object	Please refer to below example for response body	List of payment instruments for the counterparty.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": [
    {
      "CprId": "1529989456200118209",
      "InstrumentId": "1723644240177049537",
      "AdrId": "1728147839804420033",
      "PaymentType": "CROSS_BORDER_BRL_DOMESTIC",
      "DisplayTransferType": "BRL Domestic Payment",
      "Currency": "BRL",
      "Status": "Active",
      "Details": [
        {
          "Label": "Nickname",
          "Value": "TESTBRL"
        },
        {
          "Label": "Account Number",
          "Value": "<Account Number>"
        },
        {
          "Label": "Account Type",
          "Value": "Saving"
        },
        {
          "Label": "Branch Number",
          "Value": "002"
        },
        {
          "Label": "Identity Type",
          "Value": "Passport"
        },
        {
          "Label": "Identity Number",
          "Value": "<Identity Number>"
        },
        {
          "Label": "Crossborder Bank Name",
          "Value": "<Crossborder Bank Name>"
        }
      ]
    }
  ]
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": [
    {
      "CprId": "1529989456200118209",
      "InstrumentId": "1723644240177049537",
      "AdrId": "1728147839804420033",
      "PaymentType": "CROSS_BORDER_BRL_DOMESTIC",
      "DisplayTransferType": "BRL Domestic Payment",
      "Currency": "BRL",
      "Status": "Active",
      "Details": [
        {
          "Label": "Nickname",
          "Value": "TESTBRL"
        },
        {
          "Label": "Account Number",
          "Value": "<Account Number>"
        },
        {
          "Label": "Account Type",
          "Value": "Saving"
        },
        {
          "Label": "Branch Number",
          "Value": "002"
        },
        {
          "Label": "Identity Type",
          "Value": "Passport"
        },
        {
          "Label": "Identity Number",
          "Value": "<Identity Number>"
        },
        {
          "Label": "Crossborder Bank Name",
          "Value": "<Crossborder Bank Name>"
        }
      ]
    }
  ]
}

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.