GET
/counterparty/{userId}/counterpartiesList Counterparties By User ID
Returns counterparties associated with a specific user. Supports optional filters for transfer type, currencies, status, and free-text search.
Path variables
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
userId | string | Required | — | Unique user ID. |
Query parameters
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
pageNumber | number | Optional | — | Page number (enter 1 for the first page, 2 for the second, etc.). |
pageSize | number | Optional | 10 | 20 | 40 | 100 | Number of records to return per page. |
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 Filter by transfer / payment instrument type. |
currencies | string | Optional | USD | AED | ARS | BRL | CAD | EUR | GBP | HKD | JPY | MXN | SGD | ZAR | PYUSD | Comma-separated list of currencies to filter by. |
searchText | string | Optional | — | Free-text search across name, email, country, currency, and counterparty type. |
statuses | string | Optional | active | pending | blocked | disabled | rejected | Comma-separated list of statuses to filter by. |
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 counterparties for the user. |
Example response
{
"ResponseCode": 200,
"ResponseMessage": "Success",
"ResponseData": {
"Data": [
{
"CprId": "4209631234485563357",
"CpUserId": "4196120435603451734",
"FullName": "Test User",
"Type": "Individual",
"Email": "testuser@example.com",
"Status": "Active",
"VirtualAccountNumber": "",
"Country": "US",
"DestinationCurrencies": [
"BRL"
]
},
{
"CprId": "4299703227032973277",
"CpUserId": "4317717625542455126",
"FullName": "Sample Corp Ltd",
"Type": "Business",
"Email": "accounting@example.com",
"Status": "Active",
"VirtualAccountNumber": "",
"Country": "US",
"DestinationCurrencies": [
"USD"
]
},
{
"CprId": "4146580839702376413",
"CpUserId": "4083530444919189334",
"FullName": "Test Corp Ltd",
"Type": "Business",
"Email": "accounting@example.com",
"Status": "Active",
"VirtualAccountNumber": "",
"Country": "US",
"DestinationCurrencies": [
"AED"
]
},
{
"CprId": "4155588038957117405",
"CpUserId": "4101544843428671318",
"FullName": "Acme Corporation private ltd",
"Type": "Business",
"Email": "accounting@example.com",
"Status": "Active",
"VirtualAccountNumber": "",
"Country": "US",
"DestinationCurrencies": [
"MXN"
]
},
{
"CprId": "2867558545529155549",
"CpUserId": "4083530444919189334",
"FullName": "Test Corp Ltd",
"Type": "Business",
"Email": "sandbox.user@example.com",
"Status": "Active",
"VirtualAccountNumber": "",
"Country": "US",
"DestinationCurrencies": []
},
{
"CprId": "2872062145156526045",
"CpUserId": "4083530444919189334",
"FullName": "Test Corp Ltd",
"Type": "Business",
"Email": "sandbox.user@example.com",
"Status": "Active",
"VirtualAccountNumber": "",
"Country": "US",
"DestinationCurrencies": []
},
{
"CprId": "2881069344411267037",
"CpUserId": "4083530444919189334",
"FullName": "Test Corp Ltd",
"Type": "Business",
"Email": "sandbox.user@example.com",
"Status": "Active",
"VirtualAccountNumber": "",
"Country": "US",
"DestinationCurrencies": []
},
{
"CprId": "2854047746647044061",
"CpUserId": "4088034044546559830",
"FullName": "Jane Smith",
"Type": "Individual",
"Email": "test.user@example.com",
"Status": "Active",
"VirtualAccountNumber": "",
"Country": "US",
"DestinationCurrencies": []
},
{
"CprId": "2520781374221627357",
"CpUserId": "4061012446782336854",
"FullName": "John Michael Doe",
"Type": "Individual",
"Email": "john.michael.doe@example.com",
"Status": "Active",
"VirtualAccountNumber": "",
"Country": "US",
"DestinationCurrencies": [
"USD"
]
},
{
"CprId": "2471241778320551901",
"CpUserId": "-6810677053690040496",
"FullName": "Acme Corporation Ltd",
"Type": "Business",
"Email": "accounting@example.com",
"Status": "Active",
"VirtualAccountNumber": "",
"Country": "CA",
"DestinationCurrencies": [
"USD"
]
}
],
"CurrentPage": 1,
"PageSize": 10,
"TotalCount": 25
}
}Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.