Initiate a Push to Wallet payment
In this tutorial, you learn how to initiate a Push to Wallet payment.
Before you begin
To initiate a Push to Wallet payment, you 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 to make a request.
- A USD bank account from which you want to initiate a payment.
Send a request
From your command line, send a POST request to the /payments endpoint.
For example, the following code snippet contains a cURL command that initiates a Push to Wallet payment that uses a PayPal email address. It also contains the command's payload formatted in JSON so that it's easier to see.
curl --request POST \
--url https://api-mock.payments.jpmorgan.com/payment/v2/payments \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: 1b036f9c-8c84-4ce6-b1dd-5979472945a1' \
--header 'Request-Id: 1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p' \
--data '{
"requestedExecutionDate": "2024-10-01",
"paymentIdentifiers": {
"endToEndId": "PY202109202311354152"
},
"transferType": "CREDIT",
"value": {
"currency": "USD",
"amount": "10"
},
"paymentType": "PAYPAL",
"debtor": {
"name": "Delwin O",
"account": {
"accountNumber": "1000103",
"accountType": "DDA"
}
},
"debtorAgent": {
"financialInstitutionIds": [
{
"id": "CHASUS33",
"idType": "BIC"
}
]
},
"creditor": {
"name": "Robert Brown",
"account": {
"alternateAccountIdentifiers": [
{
"identifier": "robert.brown@example.com",
"idType": "PROPRIETARY",
"proprietarySchemeName": "EMAL"
}
]
},
"postalAddress": {
"postalCode": "33634",
"country": "US"
}
},
"paymentPurpose": {
"purpose": {
"code": "GOODS",
"type": "PROPRIETARY"
}
},
"remittanceInformation": {
"unstructuredInformation": [
{
"text": "Payment for Building materials - INVC009100"
}
]
}
}'Confirm the response
Confirm that you receive a response that contains an endToEndId and a paymentId. You can use these values later to get the status and details of a Push to Wallet payment.
For example, the following code snippet contains a response to the previous cURL command to initiate a Push to Wallet payment that uses a PayPal email address. It's formatted in JSON so that it's easier to see.
{
"endToEndId": "PY202109202311354152",
"paymentId": "b887bcaf-16b2-4e90-ace1-e54386cf4bd3"
}Related
- For more information about Push to Wallet payment parameters, see Payment parameters.
- For more information about status responses and error codes supported by the Global Payments API, see Global Payments 2 status responses and error codes.
Next steps
Learn how to get the status of a Push to Wallet payment request.