Get the details of a Real-Time Payments request
In this tutorial, you will learn how to use the Global Payments API to retrieve the payment details of an RTP payment request. By the end of this tutorial, you will know how to:
Use the endToEndId to retrieve the transaction details of your payment request.
Before you begin
To retrieve the details of an RTP request, you will need the following:
An endToEndId value for your payment request, which is provided in a successful payment response.
Create and send a payment details request
A successful response contains an endToEndId value that can be used to retrieve the status of the payment request.
Example request using paymentId
Curl
curl --request GET \
--url https://api-mock-payments.uat.aws.jpmchase.net/payment/v2/payments/98275a2d-1e88-beed-6938-0521a7e0aesf \
--header 'Accept: application/json'A successful response contains the transaction details for your payment request:
Example response using paymentId
Json
{
"paymentId": "253f67f3-b640-44cb-aabd-2cc348b52678",
"paymentStatus": "RECEIVED",
"paymentSubStatus": "PENDING_CLIENT_APPROVAL",
"statusUpdatedAt": "2019-08-24T14:15:22Z",
"gpi": {
"status": "string",
"statusDescription": "string",
"reason": "string"
},
"exceptions": [
{
"code": "strin",
"message": "string",
"location": "BODY",
"field": "string",
"additionalContext": [
{
"type": "string",
"code": "string",
"message": "string"
}
]
}
],
"clearingSystem": {
"name": "SPI",
"reference": "string"
},
"requestedExecutionDate": "2019-08-24",
"paymentIdentifiers": {
"endToEndId": "AD202109311354152",
"otherPaymentReferences": {
"relatedReferenceId": "string",
"uetr": "string"
}
},
"value": {
"currency": "AUD",
"amount": "string"
},
"transferType": "CREDIT",
"paymentType": "DEFAULT",
"paymentTypeInformation": {
"serviceLevelCode": "NURG",
"localInstrumentCode": {
"code": "string",
"proprietary": "string"
},
"paymentContext": "FI"
},
"debtor": {
"account": {
"accountNumber": "2367836484747",
"accountType": "DDA",
"accountCurrency": "AUD"
},
"name": "string",
"postalAddress": {
"type": "ADDR",
"addressLines": [
"string"
],
"buildingNumber": "string",
"buildingName": "string",
"streetName": "string",
"townName": "string",
"city": "string",
"postalCode": "string",
"countrySubDivision": "ACT",
"country": "AU"
},
"contactDetails": {
"phoneNumber": "string",
"mobileNumber": "string",
"faxNumber": "string",
"emailAddress": "string",
"emailPurpose": "string",
"jobTitle": "string",
"responsibility": "string",
"department": "string"
},
"dateAndPlaceOfBirth": {
"city": "string",
"countrySubDivision": "ACT",
"country": "AU",
"birthDate": "1984-05-19"
},
"countryOfResidence": "AU",
"device": {
"ipAddress": "string",
"geoCoordinates": {
"latitude": "3.140853",
"longitude": "101.693207"
}
},
"partyId": {
"organizationIds": [
{
"organizationId": "123456",
"schemeName": {
"proprietary": "JPMCOID"
}
}
]
}
},
"debtorAgent": {
"name": "JPM CHASE NEW YORK",
"financialInstitutionIds": [
{
"id": "string",
"idType": "BIC",
"branchNumber": "string"
}
],
"postalAddress": {
"type": "ADDR",
"addressLines": [
"string"
],
"buildingNumber": "string",
"buildingName": "string",
"streetName": "string",
"townName": "string",
"city": "string",
"postalCode": "string",
"countrySubDivision": "ACT",
"country": "AU"
},
"additionalInstitutions": [
{
"id": "string",
"idType": "BIC",
"name": "string",
"isForeignParty": true,
"postalAddress": {
"type": "ADDR",
"addressLines": [
"string"
],
"buildingNumber": "string",
"buildingName": "string",
"streetName": "string",
"townName": "string",
"city": "string",
"postalCode": "string",
"countrySubDivision": "ACT",
"country": "AU"
}
}
]
},
"creditor": {},
"creditorAgent": {
"name": "JPM CHASE NEW YORK",
"financialInstitutionIds": [
{
"id": "string",
"idType": "BIC",
"branchNumber": "string"
}
],
"postalAddress": {
"type": "ADDR",
"addressLines": [
"string"
],
"buildingNumber": "string",
"buildingName": "string",
"streetName": "string",
"townName": "string",
"city": "string",
"postalCode": "string",
"countrySubDivision": "ACT",
"country": "AU"
},
"additionalInstitutions": [
{
"id": "string",
"idType": "BIC",
"name": "string",
"isForeignParty": true,
"postalAddress": {
"type": "ADDR",
"addressLines": [
"string"
],
"buildingNumber": "string",
"buildingName": "string",
"streetName": "string",
"townName": "string",
"city": "string",
"postalCode": "string",
"countrySubDivision": "ACT",
"country": "AU"
}
}
]
},
"additionalParties": {
"ultimateDebtor": {
"individualIds": [
{
"individualId": "87654321"
}
],
"name": "Clint Hall",
"postalAddress": {
"addressType": "BIZZ",
"streetName": "Fratton Park",
"buildingNumber": "411",
"postalCode": "PO48RA",
"city": "Portsmouth",
"country": "GB",
"countrySubDivision": "HAM"
}
},
"ultimateCreditor": {
"individualIds": [
{
"individualId": "87654321"
}
],
"name": "Clint Hall",
"postalAddress": {
"addressType": "BIZZ",
"streetName": "Fratton Park",
"buildingNumber": "411",
"postalCode": "PO48RA",
"city": "Portsmouth",
"country": "GB",
"countrySubDivision": "HAM"
}
},
"initiatingParty": {
"organizationIds": [
{
"organizationId": "BANK"
}
]
},
"instructedAgent": {
"id": "string",
"idType": "BIC",
"branchNumber": "string"
},
"additionalDebtors": [
{
"name": "Gen Payment Solutions",
"financialInstitutionIds": [
{
"id": "string",
"idType": "BIC",
"branchNumber": "string"
}
],
"postalAddress": {
"type": "ADDR",
"addressLines": [
"string"
],
"buildingNumber": "string",
"buildingName": "string",
"streetName": "string",
"townName": "string",
"city": "string",
"postalCode": "string",
"countrySubDivision": "ACT",
"country": "AU"
}
}
],
"additionalCreditors": [
{
"name": "string",
"financialInstitutionIds": [
{
"id": "string",
"idType": "BIC",
"branchNumber": "string"
}
],
"postalAddress": {
"type": "ADDR",
"addressLines": [
"string"
],
"buildingNumber": "string",
"buildingName": "string",
"streetName": "string",
"townName": "string",
"city": "string",
"postalCode": "string",
"countrySubDivision": "ACT",
"country": "AU"
}
}
],
"intermediaryAgents": [
{
"position": 1,
"name": "string",
"financialInstitutionIds": [
{
"id": "string",
"idType": "BIC",
"branchNumber": "string"
}
],
"postalAddress": {
"type": "ADDR",
"addressLines": [
"string"
],
"buildingNumber": "string",
"buildingName": "string",
"streetName": "string",
"townName": "string",
"city": "string",
"postalCode": "string",
"countrySubDivision": "ACT",
"country": "AU"
}
}
]
},
"paymentPurpose": {
"purpose": {
"code": "string",
"type": "CODE"
},
"categoryPurpose": {
"code": "SALA",
"proprietary": "string"
}
},
"remittanceInformation": {
"unstructuredInformation": [
{
"text": "string",
"valueType": "MARKET_PLACE_NAME"
}
],
"structuredInformation": [
{
"creditReference": {
"reference": "string",
"issuer": "string",
"type": {
"code": "string",
"proprietary": "string"
}
},
"additionalRemittanceInformation": "string",
"referredDocumentInformation": {
"type": {
"code": "string",
"proprietary": "string"
},
"documentDate": "2019-08-24",
"documentIdentifier": "string",
"issuer": "string"
},
"referredDocumentAmount": [
{
"type": "DUE_PAYABLE",
"value": {
"currency": "AUD",
"amount": "string"
},
"additionalInformation": "string"
}
],
"invoicer": {
"name": "string",
"organizationIds": [
{
"organizationId": "string",
"bic": "string",
"issuer": "string",
"schemeName": {
"code": "string",
"proprietary": "string"
}
}
],
"dateAndPlaceOfBirth": {
"city": "string",
"countrySubDivision": "ACT",
"country": "AU",
"birthDate": "1984-05-19"
},
"countryOfResidence": "AU",
"postalAddress": {
"type": "ADDR",
"addressLines": [
"string"
],
"buildingNumber": "string",
"buildingName": "string",
"streetName": "string",
"townName": "string",
"city": "string",
"postalCode": "string",
"countrySubDivision": "ACT",
"country": "AU"
}
},
"invoicee": {
"name": "string",
"organizationIds": [
{
"organizationId": "string",
"bic": "string",
"issuer": "string",
"schemeName": {
"code": "string",
"proprietary": "string"
}
}
],
"dateAndPlaceOfBirth": {
"city": "string",
"countrySubDivision": "ACT",
"country": "AU",
"birthDate": "1984-05-19"
},
"countryOfResidence": "AU",
"postalAddress": {
"type": "ADDR",
"addressLines": [
"string"
],
"buildingNumber": "string",
"buildingName": "string",
"streetName": "string",
"townName": "string",
"city": "string",
"postalCode": "string",
"countrySubDivision": "ACT",
"country": "AU"
}
},
"deliveryDetails": {
"deliveryMethod": "string",
"deliveryAddress": "string"
}
}
],
"agentInstructions": {
"nextAgentInstructions": [
{
"code": "HOLD",
"instruction": "string"
}
],
"creditorAgentInstructions": [
{
"code": "HOLD",
"instruction": "string"
}
],
"debtorAgentInstructions": [
{
"code": "HOLD",
"instruction": "string"
}
]
},
"foreignCurrency": "string",
"fx": {
"appliedRate": "string"
}
},
"taxInformation": {
"type": "VATX",
"taxAmount": {
"currency": "AUD",
"amount": "string"
},
"creditorTaxInformation": {
"taxId": "string",
"taxpayerCategory": "INDIVIDUAL"
},
"debtorTaxInformation": {
"taxId": "string",
"taxpayerCategory": "INDIVIDUAL"
}
},
"regulatoryReporting": {
"authority": {
"name": "string",
"country": "AU"
},
"details": [
{
"type": "string",
"country": "AU",
"code": "string",
"additionalInfo": [
"string"
]
}
]
},
"settlementInformation": {
"settlementAccount": {
"accountNumber": "string",
"accountType": "DDA",
"accountCurrency": "AUD",
"companyId": "string"
},
"interbankSettlementAmount": {
"currency": "AUD",
"amount": "string"
}
},
"mandateInformation": {
"mandateId": "string",
"sequenceType": "FIRST",
"signatureDate": "2019-08-24",
"electronicSignature": "string",
"amendmentInformation": {
"originalMandateId": "string",
"originalCreditorId": {
"organizationIds": [
{
"organizationId": "123456",
"schemeName": {
"proprietary": "JPMCOID"
}
}
]
},
"originalDebtor": {
"accountNumber": "2367836484747",
"accountType": "DDA",
"accountCurrency": "AUD"
}
}
},
"fxInformation": {
"exchangeRate": "5.00",
"exchangeRateType": "SPOT",
"rateId": "string",
"contractId": "string",
"appliedRate": "string"
},
"secureVerification": [
{
"key": "string",
"secret": "string"
}
],
"paymentExpiresAt": "2019-08-24T14:15:22Z",
"chargesInformation": {
"chargeBearer": "CREDITOR",
"value": {
"currency": "AUD",
"amount": "string"
}
}
}Next steps
- Review payment limits.
- Understand the required payment parameters for your region.