Using an eCheck Token to Submit an eCheck Debit Transaction Using the REST API

This section shows how to use an eCheck token to submit an eCheck debit transaction using the REST API.

Using an eCheck Token to Submit an eCheck Transaction

Follow these steps to use an eCheck token to submit an eCheck debit transaction:

Create the message with the required API fields.

Send the message to one of these endpoints:

Production:

POST https://api.cybersource.com/pts/v2/payments

Test:

POST https://apitest.cybersource.com/pts/v2/payments

Verify the response messages to make sure that the request was successful. A 200-level HTTP response code indicates success.

See Transaction Response Codes.

Required Fields for Using an eCheck Token to Submit an eCheck Debit Transaction

orderInformation.amountDetails.currency: Set the value to
USD
.
orderInformation.amountDetails.totalAmount
orderInformation.billTo.address1
orderInformation.billTo.administrativeArea: Set the value to a valid USPS two-letter state or possession abbreviation.
orderInformation.billTo.country: Set the value to
US
.
orderInformation.billTo.email
orderInformation.billTo.firstName
orderInformation.billTo.lastName
orderInformation.billTo.locality
orderInformation.billTo.phoneNumber
orderInformation.billTo.postalCode
paymentInformation.customer.id
paymentInformation.paymentType.name.: Set the value to
check
.

Optional Fields for Using an eCheck Token to Submit an eCheck Debit Transaction

orderInformation.billTo.address2
orderInformation.billTo.company.name
paymentInformation.bank.account.number
paymentInformation.bank.account.type
paymentInformation.bank.routingNumber
processingInformation.bankTransferOptions: Set the value to
WEB
.
processingInformation.commerceIndicator: Set the value to
internet
.

REST Example: Using an eCheck Token to Submit an eCheck Debit Transaction

Request

12345678910111213141516171819202122232425
{"paymentInformation": {
        "paymentType": {
            "name": "check"
        },
        "customer": {
            "id": "22CC4C8BCC82EE54E0634136CF0A86E8"
        }
    },
    "orderInformation": {
        "billTo": {
            "country": "US",
            "firstName": "John",
            "lastName": "Doe",
            "phoneNumber": "2053040804",
            "address1": "12th Ave",
            "postalCode": "98105",
            "locality": "Seattle",
            "administrativeArea": "WA",
            "email": "test@example.com"
        },
        "amountDetails": {
            "currency": "USD",
            "totalAmount": "10.20"
        }
    }}

Response

12345678910111213
{"id": "7271080098361234567890",
    "reconciliationId": "0TT46FR91BDT7Y9",
    "submitTimeUtc": "2024-09-23T16:13:30Z",
    "status": "PENDING",
    "clientReferenceInformation": {
        "code": "TC1-060"
    },
    "orderInformation": {
        "amountDetails": {
            "currency": "USD",
            "totalAmount": "10.20"
        }
    }}