Initiate a Real-Time Payments request
In this tutorial, you will learn how to use the Global Payments API to initiate a Real-Time Payments (RTP) request for several common use cases. By the end of this tutorial, you will know how to:
- Create a well-formed RTP request payload
- Interpret a successful response
Before you begin
To retrieve the status of an RTP request, you will need the following:
- A registered and fully onboarded Developer Account on the J.P. Morgan Payments Developer Portal.
- An active project that provides you with the credentials used to make a request.
- A bank account configured for each country where you want to perform an RTP transaction.
Create and send an RTP request
RTP request payloads may vary depending on the use case. In this step, you’ll learn how to create and send RTP requests for vendor payments, wallet withdrawals and drawdowns, and merchant payouts.
Vendor payments
Use RTP to pay vendors for goods and services and reduce costly follow-ups. The following shows an example for a vendor payment in the United States:
{
"payments": {
"paymentIdentifiers": {
"endToEndId": "pl210g9t231r13541130"
},
"requestedExecutionDate": "2022-10-15",
"transferType": "CREDIT",
"paymentType": "RTP",
"paymentCurrency": "USD",
"paymentAmount": 500,
"debtor": {
"debtorName": "Paula Smitty",
"debtorAccount": {
"accountId": "000678901234567",
"accountType": "DDA"
},
"ultimateDebtor": {
"ultimateDebtorName": "Raj Patel",
"postalAddress": {
"addressType": "ADDR",
"streetName": "Hancock Ave",
"buildingNumber": "121",
"postalCode": "07302",
"townName": "Jersey City",
"country": "US",
"countrySubDvsn": "Hudson"
},
"dateAndPlaceOfBirth": {
"birthDate": "1984-01-01",
"cityOfBirth": "Hull city",
"countryOfBirth": "BR"
},
"individualId": {
"id": "001"
}
}
},
"debtorAgent": {
"financialInstitutionId": {
"clearingSystemId": {
"id": "021000021",
"idType": "USABA"
}
}
},
"creditorAgent": {
"financialInstitutionId": {
"clearingSystemId": {
"id": "071000013",
"idType": "USABA"
}
}
},
"creditor": {
"creditorName": "Clint Davos",
"postalAddress": {
"addressType": "ADDR",
"streetName": "Cow Hollow",
"buildingNumber": "65",
"postalCode": "05483",
"townName": "San Francisco",
"country": "US",
"countrySubDvsn": "SFO"
},
"dateAndPlaceOfBirth": {
"birthDate": "2001-01-12",
"cityOfBirth": "London",
"countryOfBirth": "UK"
},
"creditorAccount": {
"accountId": "000000034257284"
},
"ultimateCreditor": {
"ultimateCreditorName": "Max Payne",
"postalAddress": {
"addressType": "ADDR",
"streetName": "Flint Ave",
"buildingNumber": "89",
"postalCode": "88793",
"townName": "Los Angeles",
"country": "US",
"countrySubDvsn": "LAX"
},
"dateAndPlaceOfBirth": {
"birthDate": "1999-04-01",
"cityOfBirth": "Rio",
"countryOfBirth": "BR"
},
"organizationId": {
"id": "003"
}
}
},
"remittanceInformation": {
"unstructuredInformation": [
"Payment for rustic vintage furniture"
]
}
}
}Wallet withdrawals and drawdowns
Use RTP to give users immediate access to funds by initiating transfers from digital wallets to bank accounts. This allows for instantaneous wallet drawdowns and withdrawals.
Before you begin
To enable this use case, you must first integrate the Global Payments API with your wallet ecosystem. Then, when your consumer triggers a wallet push-out request, you receive instant confirmation if the payment is successful.
The following example shows the minimum required fields for a wallet withdrawal request in the United States:
{
"payments": {
"paymentIdentifiers": {
"endToEndId": "6ZUS5JFPLAFRFDM"
},
"requestedExecutionDate": "2023-08-07",
"transferType": "CREDIT",
"paymentType": "RTP",
"paymentCurrency": "USD",
"paymentAmount": 1202.08,
"debtor": {
"debtorName": "PLATFORM PROVIDER",
"debtorAccount": {
"accountId": "000001234567890"
}
},
"debtorAgent": {
"financialInstitutionId": {
"clearingSystemId": {
"id": "021000021",
"idType": "USABA"
}
}
},
"creditor": {
"creditorName": "John Doe",
"creditorAccount": {
"accountId": "000000034257284"
}
},
"creditorAgent": {
"financialInstitutionId": {
"clearingSystemId": {
"id": "063100277",
"idType": "USABA"
}
}
}
}
}Merchant payouts
Use RTP to enable instantaneous (“on-demand”) payouts to your platform sellers or merchants, sending their current sales proceeds directly to their bank accounts.
Before you begin
To enable this use case, you must first integrate the Global Payments API with your platform ecosystem. Then, you can trigger payouts to your sellers/vendors according to their settlement cycles or allow them to receive payouts "on-demand". You will receive instant confirmation if payments are successful.
The following example shows the minimum required fields for a merchant payout request in the United States:
{
"payments": {
"paymentIdentifiers": {
"endToEndId": "6ZUS5JFPLAFRFDM"
},
"requestedExecutionDate": "2023-08-07",
"transferType": "CREDIT",
"paymentType": "RTP",
"paymentCurrency": "USD",
"paymentAmount": 1202.08,
"debtor": {
"debtorName": "PLATFORM PROVIDER",
"debtorAccount": {
"accountId": "000001234567890"
}
},
"debtorAgent": {
"financialInstitutionId": {
"clearingSystemId": {
"id": "021000021",
"idType": "USABA"
}
}
},
"creditor": {
"creditorName": "John Doe",
"creditorAccount": {
"accountId": "000000034257284"
}
},
"creditorAgent": {
"financialInstitutionId": {
"clearingSystemId": {
"id": "063100277",
"idType": "USABA"
}
}
}
}
}Confirm response
For all use cases, you should receive a successful response containing a firmRootId and an endToEndId. These values can be used to retrieve the status or payment details of your request.
{
"paymentInitiationResponse": {
"endToEndId": "6ZUS5JFPLAFRFDM",
"firmRootId": "0b4e7629-5460-401f-8c53-03a0843c4584"
}
}There are a number of error messages that you may receive when submitting your payment request. The Global Payments API uses standard HTTP response codes and provides additional detail through the error response payload. For more information, see Error Codes.
Related
Connect to the Global Payments API.
Next Steps
- Learn how to retrieve the status of your RTP request.
- Understand the required payment parameters for your region.