POST/v2/payment-instrument/list

List Payment Instruments

Returns a paginated list of payment instruments for the specified beneficiary.

Headers

Field	Type	Required	Possible values	Description
`Authorization`	string	Required	Bearer {SessionToken}	Session token from Get Session Token, sent as `Authorization: Bearer {SessionToken}`. Replace with the value from the `x-refresh-token` response header when present (typically within 2 minutes of expiry). Secured calls must use the same IP as the auth request.

Request body

Field	Type	Required	Possible values	Description
`PageNumber`	integer	Required	1 \| 2 \| 3 \| 4 ... N	Page index for paginated results (1-based).
`PageSize`	integer	Required	10 \| 20 \| 50 \| 100 \| ... N	Number of records to return per page.
`BeneficiaryId`	string	Required	{beneficiaryID}	Unique beneficiary ID returned from Create Beneficiary or List Beneficiaries.

Example request

{
  "PageNumber": 1,
  "PageSize": 100,
  "BeneficiaryId": "{beneficiaryID}"
}

Response

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 201 \| 204 \| 400 \| 401 \| 403 \| 404 \| 410 \| 422 \| 500 \| 301 \| 503 \| 422	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	Paginated payment instruments for the requested beneficiary.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Data": [
      {
        "CreatedBy": "Rishav_Business - Rishav",
        "CreatedOn": "2022-12-09T02:01:29.769-04:00",
        "Id": "2732450556708040533",
        "payment_type": "BUS_USD_Account.BUS_International_Transfer",
        "BeneficiaryId": "2705428958943817557",
        "Nickname": "Wire-Domestic-Instrument",
  …

Requires `Authorization: Bearer {SessionToken}` from Get Session Token. Refresh via `x-refresh-token` when supplied; use the same client IP as authentication.