Create domestic US payment
Here, you can find one of the examples of how to create a draft payment using the initialise payment API endpoint.
Use case
In this scenario, we will create a domestic US payment - ACC2LOCAL payment type.
Our party details gives the information about the sender of the payment.
In this example, the payment is initialised from the Tuum bank account with 190021824474
BBAN.
{
"typeCode": "OUR_PARTY",
"accountNumber": {
"value": "190021824474",
"type":
}
The payer's account country is the USA. Note: the payer's bank account financial institution id is the ABA Routing number.
"accountNumberCountryCode": "US",
"financialInstitutionId": "021000018"
Counterparty details.
"typeCode": "COUNTERPARTY",
"name": "Robert Receiver",
"accountNumber": {
"value": "231123456789",
"type": "BBAN"
The payer's account country is the USA. Note: the payer's bank account financial institution id is the ABA Routing number.
"accountNumberCountryCode": "US",
"financialInstitutionId": "021000322"
Payment amount and currency.
"money": {
"amount": 17,
"currencyCode": "USD"
}
Payment details.
"details": "Test payment with both parties with BBAN for domestic US payment"
The payment also includes payment steering data, such as usageLimitCode. Note: the usageLimitCode is an optional parameter.
"usageLimitCode": "test"
Sample API call
To initialise the payment, use the following endpoint:
https://payment-api.sandbox.tuumplatform.com/api/v3/payments/initialise
Sample request
The sample request body is as follows:
{
"paymentParties": [
{
"typeCode": "OUR_PARTY",
"accountNumber": {
"value": "190021824474",
"type": "BBAN"
},
"accountNumberCountryCode": "US",
"financialInstitutionId": "021000018"
},
{
"typeCode": "COUNTERPARTY",
"name": "Robert Receiver",
"accountNumber": {
"value": "231123456789",
"type": "BBAN"
},
"accountNumberCountryCode": "US",
"financialInstitutionId": "021000322"
}
],
"money": {
"amount": 17,
"currencyCode": "USD"
},
"details": "Test payment with both parties with BBAN for domestic US payment",
"usageLimitCode": "test"
}
Sample response
Below you will find the response to the sample request:
Result
The draft payment has been created with a paymentId: PAYM-21726
and the statusCode: INSERTED
.
Possible next steps
After creating a draft payment, you have the following options:
Change the draft payment - modify the draft payment.
Cancel the draft payment - discard the draft payment if it is no longer required.
Confirm the draft payment - complete payment to initiate further payment processing.
Last updated
Was this helpful?