Get Payment

Retrieve a payment data using a payment unique identifier. This operation retrieve detailed payment data from the system.

SecurityoAuth2

Request

path Parameters

paymentUID

required

string

Payment Unique Identifier

Responses

200

400

Bad request

401

You are not authorized to access the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

500

Internal server error

503

Service unavailable

default

Successful

get/v3/payments/{paymentUID}

Request samples

curl
JavaScript
Node.js

Response samples

200
500
default

application/json

[{"status": "Success",
"code": "PAYMENT00",
"message": "Failed to retrieve a payment: <Reason>",
"data": {"paymentUID": 110289,
"externalReferenceId": "pymtref10012",
"sourceReferenceId": "10011",
"counterParty": "ABCShipping",
"counterPartyId": "10920",
"customerType": "Corporate",
"businessUnit": "BankA",
"businessUnitId": "189",
"channel": "API",
"costCenter": "Global",
"book": "ACH",
"paymentDate": "2024-04-26",
"senderAmount": "100",
"senderCurrency": "USD",
"receiverAmount": 100,
"receiverCurrency": "USD",
"deliveryMethod": "ACH",
"paymentNotes": "Payment for the invoice ABC123",
"deliveryAgentType": "DepositA",
"wireType": "OUTGOING_PAYMENT",
"senderName": "FinzlyCorp",
"senderAccountNumber": "8982618",
"senderAccountName": "DDA Account",
"senderAddress1": "1211 My Street",
"senderAddress2": "Suite 210",
"senderCity": "Charlotte",
"senderState": "North Carolina",
"senderZip": "28269",
"senderCountryCode": "US",
"senderCountry": "UNITED STATES OF AMERICA",
"senderAccountType": "Deposit",
"senderAccountSubType": "Checking",
"senderBankIdType": "NID",
"senderBankId": "101019615",
"senderBankName": "LEAD BANK",
"senderBankAddress1": "1801 MAIN ST",
"senderBankAddress2": "string",
"senderBankCity": "Charlotte",
"senderBankState": "North Carolina",
"senderBankZip": "28269",
"senderBankCountry": "UNITED STATES OF AMERICA",
"senderAccountUID": "464564564",
"senderEmail": "test@gmail.com",
"intermediarySender": false,
"intermediarySenderName": "Bank Of America",
"intermediarySenderAddress1": "1801 MAIN ST",
"intermediarySenderAddress2": "string",
"intermediarySenderCity": "KANSAS CITY",
"intermediarySenderState": "MO",
"intermediarySenderZip": "64108",
"intermediarySenderCountry": "UNITED STATES OF AMERICA",
"intermediarySenderId": "101019615",
"intermediarySenderIdType": "NID",
"ultimateSenderName": "test 112266",
"ultimateSenderAccountNumber": "9901020301",
"ultimateSenderAddress1": "119 N. MAIN ST",
"ultimateSenderAddress2": "119 N. MAIN ST",
"ultimateSenderTaxId": "98989898",
"ultimateSenderCity": "Charlotte",
"ultimateSenderState": "North Carolina",
"ultimateSenderZip": "28269",
"ultimateSenderCountry": "UNITED STATES OF AMERICA",
"fboAccountName": "string",
"fboAccountNumber": "85989823",
"fboAccountType": "Deposit",
"receiverName": "Pravin Ramchandra Gurav",
"receiverAccountNumber": "15115",
"receiverAccountType": "Deposit",
"receiverAccountSubType": "Saving",
"receiverType": "string",
"receiverAddress1": "111 My Street",
"receiverAddress2": "111 My Street",
"receiverCity": "Charlotte",
"receiverState": "North Carolina",
"receiverZip": "28269",
"receiverCountry": "UNITED STATES OF AMERICA",
"receiverPhoneNumber": "9896565998",
"receiverEmail": "xyz@gmail.com",
"receiverBankIdType": "NID",
"receiverBankId": "071212128",
"receiverBankName": "ABC Bank",
"receiverBankAddress1": "11 My Street",
"receiverBankAddress2": "11 My Street",
"receiverBankCity": "Charlotte",
"receiverBankState": "North Carolina",
"receiverBankZip": "28269",
"receiverBankCountry": "UNITED STATES OF AMERICA",
"intermediaryReceiver": false,
"intermediaryReceiverIdType": "NID",
"intermediaryReceiverId": "071212128",
"intermediaryReceiverName": "ABC Bank",
"intermediaryReceiverAddress1": "111 My Street",
"intermediaryReceiverAddress2": "Suite 210",
"intermediaryReceiverCity": "Charlotte",
"intermediaryReceiverState": "North Carolina",
"intermediaryReceiverZip": "28269",
"intermediaryReceiverCountry": "UNITED STATES OF AMERICA",
"ultimateReceiverName": "ABC",
"ultimateReceiverAccountNumber": "343532",
"ultimateReceiverAddress1": "11 My Street",
"ultimateReceiverAddress2": "11 My Street",
"ultimateReceiverTaxId": "238956",
"ultimateReceiverCity": "Charlotte",
"ultimateReceiverState": "North Carolina",
"ultimateReceiverZip": "238956",
"ultimateReceiverCountry": "UNITED STATES OF AMERICA",
"quoteId": "9f75ad52-7c2a-4b95-bb83-74d5e2b61b69",
"forexContract": "1325",
"entryType": "CREDIT",
"fee": [{"feeName": "Custom",
"currency": "USD",
"amount": 10.88
}
],
"recurrence": {"paymentRecurrenceId": "12898",
"paymentOccurrenceId": "12898",
"endAmount": 10.12,
"frequency": "Daily",
"payUntil": "Cancelled",
"startDate": "2023-06-23",
"endDate": "2023-07-23",
"endNumberPayments": 10,
"status": "Active",
"nextPaymentDate": "2023-07-23",
"lastPaymentReference": 5757
},
"fedWireDetails": {"businessFunctionCode": "Custom",
"comments": "some comments.",
"originatorToBeneficiaryInformation": "some notes for the beneficiary",
"imad": "20220627MMQCTR7B000012",
"omad": "0328QMGFNP6400002503281343FT0120232023"
},
"status": "FUTURE_DATED",
"createdBy": "System",
"creationDateTime": "2023-06-23T14:56:59"
}
}
]