Originate ACH client batches

 /ach/v1/client-batches

Submits 2 or more payments as a batch. Note that each batch payment must be originated from the same CR account number. If originating from multiple CR accounts, the payments from each account must be submitted as separate batches.

Request attributes

accountNumber

string

Account number for payment originator

Required  

originator

object

name

string

Name of the originator of the transaction. Nacha refers to this as Company Name . 35 character maximum unless the secCode is IAT. In that case the maximum is only 16 characters.

Required  

identification

string

Originator Identification. Nacha refers to this as the Company Identification . 10 character maximum.

Required  

data

string

Originator Data. Nacha refers to this as Company Discretionary Data. 20 character maximum.

Optional 

receiver

object

Required  

routingNumber

string

Federal routing number for the receiver bank

Required  

accountNumber

string

Account number for the receiver

Required  

accountType

string

Deposit account type: Checking, Savings, GeneralLedger, Loan

Required  

name

string

Receiver name. Maximum 22 characters.

Optional 

identification

string

Receiver Identification. Nacha refers to this as the Individual Identification Number. 22 character maximum.

Optional 

secCode

string

Standard Entry Class (SEC) codes required by Nacha for every ACH transaction. See values here.

Required  

description

string

Description of the payment.

10 character limit

Required  

transactionType

string

One of:

  • Push

  • Pull

Required  

amount

integer

Dollar amount of payment in positive integral cents.

For example, $1.00 would be 100.

Required  

serviceType

string

One of:

  • Standard

  • SameDay

Required  

extendedDetails

Optional 

authCode

string

cardAccountNumber

string

cardExpDate

string

cardTransactionType

string

checkSerialNumber

string

docReferenceNumber

string

itemType

string

networkIdentification

string

paymentType

string

processControl

string

reference1

string

reference2

string

researchNumber

string

terminalIdentification

string

terminalLocation

string

terminalCity

string

terminalState

string

transactionDate

string

transactionDesc

string

transactionSerial

string

transactionTime

string

iatDetails

object

Required for IAT. See here.

originator

object

address

string

Street or post office box address. 35 characters maximum.

city

string

City full name

state

string

State name

postalCode

string

Postal code

countryCode

string

2-letter country code

receiver

object

address

string

Street or post office box address. 35 characters maximum.

city

string

City full name

state

string

State name

postalCode

string

Postal code

countryCode

string

2-letter country code

originatingBank

object

name

string

Name of financial institution originating the IAT

identification

string

Originating DFI Identification number

idQualifier

string

Originating DFI Identification Number Qualifier:

  • 01 (National Clearing System Number. For example, US Routing transit number)

  • 02 BIC Code

  • 03 IBAN

countryCode

string

Country code - 2 digit code

receivingBank

object

Required  

name

string

Name of financial institution receiving the IAT

identification

string

Receiving DFI Identification number

idQualifier

string

Originating DFI Identification Number Qualifier:

  • 01 (National Clearing System Number. For example, US Routing transit number)

  • 02 BIC Code

  • 03 IBAN

countryCode

string

2-letter country code

remittanceInfo1

string

Additional IAT information. 80 characters.

Optional 

remittanceInfo2

string

Additional IAT information. 80 characters.

Optional 

correspondentBank1

object

Optional 

name

string

Name of financial institution

identification

string

DFI Identification number

idQualifier

string

DFI Identification Number Qualifier:

  • 01 National Clearing System Number

  • 02 BIC Code

  • 03 IBAN

countryCode

string

Country code - 2 digit code

correspondentBank2

object

Optional 

name

string

Name of financial institution

identification

string

DFI Identification number

idQualifier

string

DFI Identification Number Qualifier:

  • 01 National Clearing System Number

  • 02 BIC Code

  • 03 IBAN

countryCode

string

Country code - 2 digit code

correspondentBank3

object

Optional 

name

string

Name of financial institution

identification

string

DFI Identification number

idQualifier

string

DFI Identification Number Qualifier:

  • 01 National Clearing System Number

  • 02 BIC Code

  • 03 IBAN

countryCode

string

Country code - 2 digit code

correspondentBank4

object

Optional 

name

string

Name of financial institution

identification

string

DFI Identification number

idQualifier

string

DFI Identification Number Qualifier:

  • 01 National Clearing System Number

  • 02 BIC Code

  • 03 IBAN

countryCode

string

Country code - 2 digit code

correspondentBank5

object

Optional 

name

string

Name of financial institution

identification

string

DFI Identification number

idQualifier

string

DFI Identification Number Qualifier:

  • 01 National Clearing System Number

  • 02 BIC Code

  • 03 IBAN

countryCode

string

Country code - 2 digit code

transactionTypeCode

string

Part of the addenda record. An additional way to explain the purpose of the IAT. See values here.

Required  

originatingCurrency

string

An ISO three-character code to identify the originating currency

Optional 

destinationCurrency

string

An ISO three-character code to identify the receiving currency

Optional 

addenda

string

Additional transaction-related information

Optional 

purpose

string

Reason for the ACH transfer. For internal use only. The data is not included with the outgoing ACH batch file.

Optional 

clientIdentifier

string

Use this attribute to add your own unique identifying string to a payment call or COS record. This attribute is useful for idempotency purposes.

Optional 
Copy

Sample request

curl -X POST
--header 'Content-Type: application/json'
--header 'Accept: application/json'
--header 'Authorization: Bearer <token>'
-d '{ \
  "payments": [
{
      "accountNumber": "2207975570",
      "receiver": {
        "routingNumber": "021000021",
        "accountNumber": "12345678",
        "accountType": "Checking",
        "name": "John Wick"
      },
      "secCode": "PPD",
      "description": "string",
      "transactionType": "Push",
      "amount": 113,
      "serviceType": "SameDay"
    },
{
      "accountNumber": "2207975570",
      "receiver": {
        "routingNumber": "021000021",
        "accountNumber": "2342123458",
        "accountType": "Checking",
        "name": "Cleveland Brown"
      },
      "secCode": "PPD",
      "description": "string",
      "transactionType": "Pull",
      "amount": 243591,
      "serviceType": "Standard"
    }
  ]
} 'https://sandbox.crbcos.com/ACH/v1/client-batches'

Response attributes

id

string

Unique ID for the client batch request. This ID is in the GUID format.

referenceId

string

Unique CR reference ID for the payment. The reference ID always begins with the first letter of the rail. For ACH the reference ID starts with 'A'.

status

string

Status of the transaction:

  • Processing

  • Imported

  • Canceling

accountNumber

string

The account number from which the batch payments originate

paymentCount

integer

The number of unique payments in the batch (up to 5000)

debitTotal

integer

The total amount to be credited to the originator account

creditTotal

integer

The total amount to be debited from the originator account

importCount

integer

Indicates how many payments have been processed at the time of the response

productId

string

ID in GUID format of your specific product type on which the account is based. Provided by CR. In this case, the CR account involved in the batch payment. See also here.

partnerId

string

Your ID in the CR system. This ID is in GUID format.

createdAt

string

When the client batch was created after the request was received

importedAt

string

The time when the import count matches the total number of payments in the batch

lastModifiedAt

string

Internal CR value. Date and time the database entry was last modified.

paymentIdentifiers

array

Unique identifier for each payment in the batch, in GUID format.
Copy

Sample response

{
  "id": "fcb7188f-e051-4f5b-addd-afaa00eadb3a",
  "referenceId": "CB0461724AAWT",
  "status": "Processing",
  "accountNumber": "2207975570",
  "paymentCount": 5,
  "debitTotal": 258641,
  "creditTotal": 2863,
  "importCount": 0,
  "productId": "cc62e17f-5912-483e-9e42-aed30112fbb6",
  "partnerId": "1e5d3f04-ae24-4af6-9e30-aecf012b99dd",
  "createdAt": "2023-02-15T09:15:05.1486312-05:00",
  "lastModifiedAt": "2023-02-15T09:15:05.1486312-05:00",
  "paymentIdentifiers": [
    "f04793f3-13d9-4d52-b57e-afaa00eb6c74",
    "dbe36253-06d1-462a-9117-afaa00eb6c74"
    ]
}