Initiate a domestic or international debit payment [one time or recurring]
Debit Payment Request fields
search results matching criteria
bad input parameter environment
Unauthorized
Forbidden
Not Found
bad input parameter environment
Internal server error
Service unavailable
return payment response
{- "externalReferenceId": "pymtref10012",
- "paymentAmount": 123,
- "paymentCurrency": "USD",
- "paymentDate": "07-21-2022",
- "speed": "Economy",
- "paymentNotes": "Payment Notes",
- "creditor": {
- "accountUID": "1021",
- "achCompanyID": "122334789",
- "accountNumber": "123452334",
- "accountType": "Deposit",
- "subAccountType": "Checking",
- "name": "Creditor name",
- "entityType": "Consumer",
- "address": {
- "addressLine1": "111 My Street",
- "addressLine2": "Suite 210",
- "city": "Charlotte",
- "state": "North Carolina",
- "postalCode": "28269",
- "countryCode": "US."
}, - "bankIdType": "NID",
- "bankId": "101206101 or FBOLUS6LXXX",
- "phone": "18001236754",
- "email": "email@domain.com"
}, - "debtor": {
- "accountUID": "1021",
- "accountNumber": "123422434",
- "accountType": "Deposit",
- "subAccountType": "Checking",
- "accountCurrency": "USD",
- "name": "XYZ Name",
- "address": {
- "addressLine1": "111 My Street",
- "addressLine2": "Suite 210",
- "city": "Charlotte",
- "state": "North Carolina",
- "postalCode": "28269",
- "countryCode": "US"
}, - "phone": "18001236754",
- "email": "email@domain.com",
- "bank": {
- "bankIdType": "NID",
- "bankId": "072000326",
- "swiftCode": "CHASUS33XXX",
- "name": "XYZ Bank",
- "countryCode": "US",
- "address": {
- "addressLine1": "111 My Street",
- "addressLine2": "Suite 210",
- "city": "Charlotte",
- "state": "North Carolina",
- "postalCode": "28269",
- "countryCode": "US"
}
}, - "intermediaryBank": {
- "bankIdType": "NID",
- "bankId": "072000326",
- "swiftCode": "CHASUS33XXX",
- "name": "XYZ Bank",
- "countryCode": "US",
- "address": {
- "addressLine1": "111 My Street",
- "addressLine2": "Suite 210",
- "city": "Charlotte",
- "state": "North Carolina",
- "postalCode": "28269",
- "countryCode": "US"
}
}
}, - "fee": {
- "feeName": "Custom",
- "currency": "USD",
- "amount": 10
}, - "recurrence": {
- "frequency": "Daily",
- "payUntil": "Cancelled",
- "endDate": "01-29-2023",
- "numberOfPayments": 10
}, - "additionalInfo": {
- "channel": "API",
- "costCenter": "12897",
- "requestMethod": "WALK-IN",
- "detailsOfCharges": "OUR",
- "secCode": "CCD",
- "transactionTypeCode": "ANN",
- "receiverIdentificationNumber": "12334356",
- "fxContractNumber": "111234",
- "originatortoBeneficiary": "OBI Notes",
- "senderToReceiverNotes": "Sender To Reciever Notes",
- "paymentRemittanceNotes": "Remittance Notes",
- "operationNote": "string",
- "requestedExecutionDate": "07-21-2022",
- "expiryDate": "07-21-2022",
- "amountModificationAllowed": true,
- "earlyPayment": true,
- "guaranteedPayment": true
}
}
{- "status": "Success",
- "code": "PAYMENT001",
- "message": "Failed to create a payment: <Reason>",
- "data": {
- "paymentUID": "12930",
- "paymentStatus": "INITTIATED",
- "externalReferenceId": "123e4567",
- "recurranceId": 5599
}
}