Processing an eCheck Debit Transaction Using the REST API

This section shows you how to process an eCheck debit transaction using the REST API.

Processing an eCheck Debit Transaction

Follow these steps to process an eCheck debit transaction:
  1. Create the message with the required API fields.
  2. 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
  3. Verify the response messages to make sure that the request was successful. A 200-level HTTP response code indicates success.

Required Fields for an eCheck Debit Transaction

clientReferenceInformation.code
orderInformation.amountDetails.currency
Value must be set to
USD
.
orderInformation.amountDetails.totalAmount
This field is required if you do not submit
orderInformation.lineItems[].unitPrice
 and
orderInformation.lineItems[].quantity
.
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.phoneNumber
orderInformation.billTo.locality
orderInformation.billTo.postalCode
paymentInformation.bank.account.number
paymentInformation.bank.account.type
paymentInformation.bank.routingNumber
paymentInformation.paymentType.name
Set the value to
check
.

Optional Fields for an eCheck Debit Transaction

processingInformation. bankTransferOptions.secCode
Supported values:
  • ccd
  • ppd
  • tel
  • web
processingInformation.commerceIndicator
Supported values:
  • internet
     (default)
  • moto
  • recurring

REST Example: eCheck Debit Transaction

Light Dark
Request
1234567891011121314151617181920212223242526272829303132
{"orderInformation": {
        "billTo": {
            "country": "US",
            "firstName": "Jane",
            "lastName": "Doe",
            "phoneNumber": "2053040804",
            "address1": "112 12 Ave",
            "postalCode": "98004",
            "locality": "Bellevue",
            "administrativeArea": "WA",
            "email": "test@example.com"
        },
       "amountDetails": {
            "currency": "USD",
            "totalAmount": 1200
        }
    },
    "clientReferenceInformation": {
        "code": "TC123"
    },
    "paymentInformation": {
        "bank": {
            "routingNumber": "071923284",
            "account": {
                "number": "12345678901234567",
                "type": "C"
            }
        },
        "paymentType": {
            "name": "check"
        }
    }}
Response to a Successful Request
12345678910111213
{"id": "16681201582270123456789",
    "reconciliationId": "9PK9Y6A8A75018I",
    "submitTimeUtc": "2022-11-10T22:42:38Z",
    "status": "PENDING",
    "clientReferenceInformation": {
        "code": "TC123"
    },
    "orderInformation": {
        "amountDetails": {
            "currency": "USD",
            "totalAmount": "1200"
        }
    }}