Initiate a one-time or recurring domestic or international credit payment.
⚠️ Deprecation Notice: This endpoint is deprecated and will be retired on March 31, 2027.
The original retirement date of October 1, 2026 has been extended to March 31, 2027 to provide additional time for customers who are still using the v3 API to complete their migration to v4.
Customers are strongly encouraged to begin or complete their migration as soon as possible. Please migrate to the v4 Credit Payment API at /v4/payments/credit before March 31, 2027, to ensure uninterrupted service.
Credit Payment Request fields
The payment has been created successfully.
Bad request
Unauthorized
Forbidden
Not Found
bad input parameter environment
Internal server error
Service unavailable
{- "externalReferenceId": "123e4567-e89b-12d3-a456-4266141740",
- "paymentAmount": 175,
- "paymentCurrency": "USD",
- "paymentDate": "05-08-2024",
- "speed": "Economy",
- "paymentNotes": "Notes",
- "sender": {
- "accountUID": "1021",
- "achCompanyID": "122334789",
- "accountNumber": "123452334",
- "accountType": "Deposit",
- "subAccountType": "Checking",
- "name": "Sender Name",
- "entityType": "Consumer",
- "address": {
- "addressLine2": "Suite 210",
- "city": "Charlotte",
- "state": "North Carolina",
- "postalCode": "28269",
- "countryCode": "US"
}, - "bankIdType": "NID",
- "bankId": "101206101",
- "phone": "18001236754",
- "email": "email@domain.com",
- "swiftTag": "string",
- "swiftNote": "string",
- "correspondentBankId": "026009593"
}, - "ultimateSender": {
- "name": "ACME Holdings Inc.",
- "accountNumber": "9901020301",
- "address": {
- "addressLine1": "119 N. MAIN ST",
- "addressLine2": "Suite 210",
- "addressLine3": "Building B",
- "city": "FAYETTE",
- "state": "MO",
- "postalCode": "65248",
- "countryCode": "US"
}
}, - "receiver": {
- "accountUID": "209219",
- "accountNumber": "123422434",
- "accountType": "Deposit",
- "subAccountType": "Checking",
- "accountCurrency": "USD",
- "name": "Receiver 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",
- "accountType": "IBAN",
- "accountNumber": "DE89370400440532013000",
- "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"
}
}, - "swiftTag": "string",
- "swiftNote": "string"
}, - "ultimateReceiver": {
- "name": "Globex End Customer LLC",
- "accountNumber": "89895656",
- "address": {
- "addressLine1": "101 SR",
- "addressLine2": "Suite 210",
- "addressLine3": "Building B",
- "city": "TAMPA",
- "state": "FL",
- "postalCode": "33601",
- "countryCode": "US"
}
}, - "fee": {
- "feeName": "Custom",
- "currency": "USD",
- "amount": 10.88
}, - "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",
- "remittanceMethod": "EMAL",
- "paymentRemittanceNotes": "string",
- "localInstruments": "COVS",
- "referenceForBeneficiary": "string",
- "unstructuredAddendaInfo": {
- "addendaInformation": "string"
}, - "proprietaryCode": "string",
- "adviceRoutingNumber": "021000021",
- "processControlField": "ABC123",
- "itemResearchNumber": "RES1234567890123",
- "operationNote": "string",
- "benefitReceiver": {
- "federalBenefitType": "Social Security",
- "accountNumber": "10000002",
- "socialSecurityNumber": "555500559",
- "representativePayee": false,
- "firstName": "John",
- "lastName": "Doe",
- "subAccountType": "Checking"
}
}
}{- "status": "Success",
- "data": {
- "paymentUID": "377297",
- "recurrenceId": 0,
- "paymentStatus": "INITIATED",
- "externalReferenceId": "146Global@#-_"
}
}