Submitting the payment request

To submit the payment request:

1

Use the POST method with the /rest/v2/ach/transactions endpoint and the following sample request:

{ 
  "check-field": "invoice", 
  "client-ip": "111.22.22.333", 
  "dob-year": "dob-year", 
  "email-receipt": "true", 
  "software-type-version": "1.0", 
  "type": "Debit", 
  "validate-account": "true", 
  "amount": "string", 
  "routing-number": "string", 
  "account-number": "string", 
  "account-type": "Checking", 
  "standard-entry-class-code": "PPD", 
  "check-number": "string", 
  "create-token": "false", 
  "create-description": "false", 
  "individual-name": "string", 
}

The following table describes the request body parameters:

Name
Data type
Required?
Description

check-field

String

Optional

Specifies the field for check identification. For example, invoice.

client-ip

Integer

Optional

The IP address of the client initiating the request. For example, 111.22.22.333

dob-year

Integer

Optional

The customer's year of birth.

email-receipt

Boolean

Optional

Indicates whether to send an email receipt.

software-type-version

Integer

Optional

The version of the specification used to initiate the transaction.

type

String

Optional

The type of ACH transaction.

validate-account

Boolean

Optional

Indicates whether to validate the bank account.

amount

String

Optional

The transaction amount.

routing-number

String

Optional

The bank routing number.

account-number

String

Optional

The bank account number.

account-type

String

Optional

The type of bank account.

standard-entry-class-code

String

Optional

The ACH standard entry class code.

check-number

String

Optional

The check number associated with the transaction.

create-token

Boolean

Optional

Indicates whether to create a reusable token.

create-description

Boolean

Optional

Indicates whether to create a transaction description.

individual-name

String

Optional

The name of the individual associated with the transaction.

The ach-transaction returns the following status and error codes:

Code
Description

401

If the authentication token has expired or the signature does not match the token.

500

If the request is invalid—for example, if the routing number contains letters.

Last updated

Was this helpful?