GET
/v2/payment-instrument/{PaymentInstrumentId}Get Payment Instrument Details
Returns detailed information for a single payment instrument.
Path variables
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
PaymentInstrumentId | string | Required | {paymentInstrumentID} | Unique payment instrument ID from Create or List Payment Instruments. |
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. |
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 | Payment instrument details (bank, account, status, supported currencies). |
Example response
{
"ResponseCode": 200,
"ResponseMessage": "Success",
"ResponseData": {
"CreatedBy": "Rishav_Business - Rishav",
"CreatedOn": "2022-12-09T02:01:29.769-04:00",
"PaymentInstrumentID": "2732450556708040533",
"Beneficiary": "Earnest-TRF - (rishav.0727@gmail.com)",
"Account": "Account (USD)",
"Payment_Type": "Payment - International Wire",
"Nickname": "Wire-Domestic-Instrument",
"Supported_Currencies": "USD",
…Requires `Authorization: Bearer {SessionToken}` from Get Session Token. Refresh via `x-refresh-token` when supplied; use the same client IP as authentication.