Originate an ACH payment

accountNumber

string

Required  

Account number for payment originator

originator

object

Conditional 

Details about the entity sending the payment. If the account originating the payment is enabled to provide this information according to the supplied account number, all the values should be null. If these values are supplied in the request they override the originator profile defined for the account.

child attributes

name string Conditional  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.

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

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

receiver

object

Required  

In the case of Pull payments, this is the account the funds are being pulled from.

child attributes

routingNumber string Required   Federal routing number for the receiver bank

accountNumber string Required   Account number for the receiver. Must be 7 digits. For account numbers with 5 or 6 digits, add 0s to the beginning of the account number.

accountType string Required   Deposit account type: Checking, Savings, GeneralLedger, Loan

name string Required   Receiver name. Maximum 22 characters.

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

secCode

string

Required  

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

description

string

Required  

Description of the payment. Maximum 10 characters.

transactionType

string

Required  

Sending or requesting funds:

• Push (originator is sending funds—debit)

• Pull (originator is receiving funds—credit)

amount

integer

Required  

Dollar amount of payment in positive integral cents. For example, write $1.00 as 100.

serviceType

string

Required  

When the payment completes:

• Standard (Payment effective the following business day. International payments must use this service type.)

• SameDay (Payment effective same day, subject to certain constraints. See ACH overview.)

extendedDetails

object

Conditional 

ACH-specific details. If the transactionType is pull and secCode is WEB you must include a paymentType value in this object.

child attributes

authCode string

cardAccountNumber string

cardExpDate "string

cardTransactionType string

checkSerialNumber string

docReferenceNumber string

itemType string

networkIdentification string

paymentType string Conditional  Payment types are a single character, and are based on the authorization of the account holder to debit their account: S for single R for recurring

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

Conditional 

Required if the secCode is IAT. See here for more information about IAT.

Do not enter values for these attributes for any other secCode.

child attributes

originator object Conditional  Payment sender details child attributes address string Required   Street or post office box address. 35 characters maximum. city string Required   City full name. 33 characters maximum. state string Optional  State name. 33 characters maximum. postalCode string Optional  Postal code. Regular expression. 30 characters maximum. countryCode string Required   2-letter ISO country code

receiver object Required   Payment receiver details child attributes address string Required   Street or post office box address. 35 characters maximum. city string Required   City full name. 33 characters maximum. state string Optional  State name. 33 characters maximum. postalCode string Optional  Postal code. Regular expression. 30 characters maximum. countryCode string Required   2-letter ISO country code

originatingBank object Optional  Details of financial institution originating the IAT child attributes name string Required   Name of financial institution. 35 characters maximum. identification string Required   DFI Identification number, which is the first 8 digits of that financial institution's routing number idQualifier string Required   Originating DFI Identification Number Qualifier: 01 (National Clearing System Number. For example, US Routing transit number) 02 BIC Code 03 IBAN countryCode string Required   2-letter ISO country code

receivingBank object Required   Details of financial institution receiving the IAT child attributes name string Required   Name of financial institution. 35 characters maximum. identification string Required   DFI Identification number, which is the first 8 digits of that financial institution's routing number idQualifier string Required   Originating DFI Identification Number Qualifier: 01 (National Clearing System Number. For example, US Routing transit number) 02 BIC Code 03 IBAN countryCode string Required   2-letter ISO country code

remittanceInfo1 string Optional  Additional IAT information. 80 characters. A second field is available as remittanceInfo2.

correspondentBank1 object Optional  Details of a correspondent (intermediary) bank, if there is one. You can have up to 5 correspondent banks: (correspondentBank1, correspondentBank2, correspondentBank3, correspondentBank4, correspondentBank5 , each with the same child attributes. child attributes name string Required   Name of financial institution. 35 characters maximum. identification string Required   DFI Identification number, which is the first 8 digits of that financial institution's routing number idQualifier string Required   Originating DFI Identification Number Qualifier: 01 (National Clearing System Number. For example, US Routing transit number) 02 BIC Code 03 IBAN countryCode string Required   2-letter ISO country code

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

originatingCurrency string Optional  An ISO three-character code to identify the originating currency

destinationCurrency string Optional  An ISO three-character code to identify the receiving currency

addenda

string

Optional 

Additional transaction-related information

purpose

string

Optional 

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

id

string

Payment ID. This ID first appears as the value for this attribute in the response to the originate a payment call. This ID is in the GUID format.

accountNumber

string

Account number. In CR, depending on the account type, the number of digits will vary. The first digit indicates the kind of account.

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'.

paymentType

string

Type of payment being sent. See values here.

direction

string

The payment direction, which includes:

• Inbound: payment received by a CR account from another bank

• Outbound: a payment sent from a CR account to another bank

status

string

The status of the payment

source

string

Source of the activity: Api, PartnerPortal, OpsPortal, File

postingType

string

Individual or Aggregate

clientBatchId

string

Unique identifier for a batch (GUID) if you originate the client batch

clientBatchSequence

integer

Sequence number of the payment in the batch, if you originate the client batch

fedBatchId

string

Unique ID for the batch sent to or received from the Fed

fedBatchSequence

integer

Sequence of the payment inside of the batch sent to or received from the Fed

coreTransactionId

string

Internal CR unique ID for the transaction

memoPostId

string

For outbound push payments, ID of the original authorization on the account for the amount of the payment request

postingCode

string

The related CR system transaction status

posting

string

Posting status:  Pending, Posted, Failed, Canceled, Authorized, Processing

rejectionReason

string

OfacUnableToDetermine, OfacConfirmed, OfacUnconfirmed, Other

blockedReason

string

Ofac, Other

originator

object

Originator bank details

child attributes

routingNumber string Financial institution federal routing number

accountNumber string Account number for payment originator

accountType string Deposit account type: Checking Savings GeneralLedger Loan

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.

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

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

receiver

object

Receiver bank details

child attributes

routingNumber string Financial institution federal routing number

accountNumber string Account number for the receiver

accountType string Deposit account type: Checking Savings GeneralLedger Loan

name string Receiver name as it appears on the receiver account. Nacha refers to this as the Individual Name.

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

data string Receiver data. Nacha refers to this as Discretionary Data.

secCode

string

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

description

string

Description of the payment. 10 character limit.

transactionType

string

Sending or requesting funds:

• Push (originator is sending funds—debit)

• Pull (originator is receiving funds—credit)

amount

integer

Dollar amount of payment in positive integral cents. For example, write $1.00 as 100.

serviceType

string

When the payment completes:

• Standard (Payment effective the following business day. International payments must use this service type.)

• SameDay (Payment effective same day, subject to certain constraints. See ACH overview.)

extendedDetails

object

ACH-specific details

child attributes

authCode string

cardAccountNumber string

cardExpDate "string

cardTransactionType string

checkSerialNumber string

docReferenceNumber string

itemType string

networkIdentification string

paymentType string Payment types are a single character, and are based on the authorization of the account holder to debit their account: S for single R for recurring

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 if the SEC code is IAT. See here for more information about IAT.

Do not enter values for these attributes for any other SEC code.

child attributes

originator object Payment sender details child attributes address string Street or post office box address. 35 characters maximum. city string City full name. 33 characters maximum. state string State name. 33 characters maximum. postalCode string Postal code. Regular expression. 30 characters maximum. countryCode string 2-letter ISO country code

receiver object Payment receiver details child attributes address string Street or post office box address. 35 characters maximum. city string City full name. 33 characters maximum. state string State name. 33 characters maximum. postalCode string Postal code. Regular expression. 30 characters maximum. countryCode string 2-letter ISO country code

originatingBank object Details of financial institution originating the IAT child attributes name string Name of financial institution. 35 characters maximum. identification string DFI Identification number, which is the first 8 digits of its routing number. idQualifier string Originating DFI Identification Number Qualifier: 01 National Clearing System Number 02 BIC Coder 03 IBAN countryCode string 2-letter ISO country code

receivingBank object Required   Details of financial institution receiving the IAT child attributes name string Name of financial institution. 35 characters maximum. identification string DFI Identification number, which is the first 8 digits of its routing number. idQualifier string Originating DFI Identification Number Qualifier: 01 National Clearing System Number 02 BIC Coder 03 IBAN countryCode string 2-letter ISO country code

remittanceInfo1 string Optional  Additional IAT information. 80 characters. A second field is available as remittanceInfo2.

correspondentBank1 object Details of a correspondent (intermediary) bank, if there is one. You can have up to 5 correspondent banks: (correspondentBank1, correspondentBank2, correspondentBank3, correspondentBank4, correspondentBank5, each with the same child attributes. child attributes name string Name of financial institution. 35 characters maximum. identification string DFI Identification number, which is the first 8 digits of its routing number. idQualifier string Originating DFI Identification Number Qualifier: 01 National Clearing System Number 02 BIC Coder 03 IBAN countryCode string 2-letter ISO country code

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

originatingCurrency string An ISO three-character code to identify the originating currency

destinationCurrency string An ISO three-character code to identify the receiving currency

addenda

string

Additional transaction-related information

effectiveDate

string

Effective entry date

reasonCode

string

Nacha return code. See values here.

reasonData

string

Data supporting the Nacha reason code

traceNumber

string

Unique ACH trace number for the transaction

settlementDate

string

Date payment will settle in the receiver's account

wasReturned

boolean

True if payment was returned, otherwise false.

wasCorrected

boolean

True if a payment is sent with bad info but the receiving FI fixes it and sends back the information (NOC), otherwise false.

holdDays

integer

For ACH pulls, allows defining a number of days to delay credit of funds to an account to mitigate fraud and NSF scenarios

previous

object

Previous payment details

child attributes

paymentId string Payment ID for an original payment if the payment is returned or the system sends a NOC

reasonCode string Reason code for an original payment if the payment is returned or the system sends a NOC

traceNumber string Trace number for an original payment if the payment is returned or the system sends a NOC

settlementDate string Settlement date for an original payment if the payment is returned or the system sends a NOC

reasonData string Supporting data for the reason code for an original payment if the payment is returned or the system sends a NOC

original

object

Original payment details when a payment was returned or a NOC was sent.

Resending a payment after failure as a completely new request. The new payment cannot be linked to the failed payment.

child attributes

paymentId string Payment ID for an original payment

reasonCode string Reason code for an original payment

traceNumber string Trace number for an original payment

settlementDate string Settlement date for an original payment

reasonData string Supporting data for the reason code for an original payment

createdAt

string

Date and time the payment was created in the system. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

canceledAt

string

Date and time the payment was canceled. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

rejectedAt

string

Date and time the payment was rejected. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

blockedAt

string

Date and time the payment was blocked by BSA/AML. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

processedAt

string

Date and time the payment was processed by CR. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

completedAt

string

Date and time the payment was systemically completed. This can only occur after the payment has successfully posted to the account.. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

postedAt

string

Date and time the payment was posted to the CR account. In this case, the date and time are in this format: yyyy-mm-ddThh:mm:ss[.mmm]

partnerId

string

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

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 payment.

lastModifiedAt

string

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

purpose

string

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