POST//
Create an ACH transfer that pushes funds to an external account or pulls funds into your program funding account.
Request body
Create bank transfer request model| Fields | Description |
|---|---|
| amount decimal Required | Amount to push or pull. Allowable Values: 0.01 min |
| currency_code string Optional | Currency of the push or pull. Allowable Values: Valid alpha-3 ISO 4217 currency code Default value: USD |
| funding_source_token string Required | ACH funding source token for the external account. Allowable Values: 36 char max Existing ACH funding source token. |
| memo string Optional | Additional text describing the ACH transfer. Allowable Values: 255 char max |
| standard_entry_class_code string Optional | Three-letter code identifying the type of entry. - WEB — An internet-initiated entry - PPD — Prearranged Payment and Deposit - CCD — Corporate Credit or Debit Entry Allowable Values: WEB, PPD, CCD |
| statement_descriptor string Optional | Description of the transaction, as it will appear on the receiver’s bank statement. Allowable Values: 10 char max |
| token string Optional | Unique identifier of the ACH transfer to retrieve. Allowable Values: 36 char max |
| transfer_speed string Optional | Specifies how quickly to initiate the ACH transfer. NOTE: Same-day transfers are limited to a maximum amount of $100,000. Allowable Values: STANDARD, SAME_DAY |
| type string Optional | Specifies whether the ACH transfer is a push (credit) or pull (debit). Allowable Values: PUSH, PULL |
Sample request body
JSON
{
"funding_source_token": "d331b4b2-cef5-49a3-9c41-75d8f4e15cfz",
"type": "PUSH",
"amount": 10.49,
"transfer_speed": "STANDARD",
"statement_descriptor": "ACHTRNSFR",
"standard_entry_class_code": "WEB",
"currency_code": "USD",
"memo": "Bank transfer"
}
Response body
| Fields | Description |
|---|---|
| amount decimal Returned | Amount to push or pull. Allowable Values: 0.01 min |
| batch_number string Conditionally returned | Field required in older versions of the API, but no longer used. Allowable Values: Any integer |
| created_time datetime Conditionally returned | Date and time when the ACH transfer was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| currency_code string Conditionally returned | Valid alpha-3 ISO 4217 currency code Allowable Values: Valid alpha-3 ISO 4217 currency code |
| funding_source_token string Returned | ACH funding source token for the external account. Allowable Values: 36 char max |
| last_modified_time datetime Conditionally returned | Date and time when the ACH transfer was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| memo string Conditionally returned | Additional text describing the ACH transfer. Allowable Values: 99 char max |
| return_code string Conditionally returned | Standardized ACH return code for a returned transaction, generally sent by the RDFI. Transactions can be returned for any of the reasons listed in the NACHA ACH return codes table of the ACH Origination Guide. Allowable Values: R01, R02, R03, R04, R05, R06, R07, R08, R09, R10, R11, R12, R13, R14, R15, R16, R17, R18, R19, R20, R21, R22, R23, R24, R25, R26, R27, R28, R29, R30, R31, R32, R33, R34, R35, R37, R38, R39, R40, R41, R42, R43, R44, R45, R46, R47, R50, R51, R52, R53, R61, R67, R68, R69, R70, R71, R72, R73, R74, R75, R76, R80, R81, R82, R83, R84, R85 |
| return_reason string Conditionally returned | Human-readable description correlating to the return_code, such as Insufficient funds, if a return code is present in the response.Allowable Values: 255 char max |
| standard_entry_class_code string Conditionally returned | Three-letter code identifying the type of entry. - WEB — An internet-initiated entry - PPD — Prearranged Payment and Deposit - CCD — Corporate Credit or Debit Entry Allowable Values: WEB, PPD, CCD |
| statement_descriptor string Conditionally returned | Description of the transaction, as it will appear on the receiver’s bank statement. Allowable Values: 10 char max |
| status string Conditionally returned | New state of the ACH transfer. Allowable Values: INITIATED, PENDING, PROCESSING, SUBMITTED, RETURNED, COMPLETED, ERROR, CANCELLED |
| token string Conditionally returned | Unique identifier of the ACH transfer to retrieve. Allowable Values: 36 char max |
| transfer_speed string Conditionally returned | Specifies how quickly to initiate the ACH transfer. NOTE: Same-day transfers are limited to a maximum amount of $100,000. Allowable Values: STANDARD, SAME_DAY |
| transitions array of objects Conditionally returned | Array of ACH transfer transition objects. Allowable Values: Valid array of one or more transitions objects |
| transitions[].bank_transfer_token string Returned | Unique identifier of the ACH transfer being transitioned. Allowable Values: 36 char max |
| transitions[].batch_number string Conditionally returned | Field required in older versions of the API, but no longer used. Allowable Values: Any integer |
| transitions[].channel string Returned | Mechanism by which the transaction was initiated. Allowable Values: API, SYSTEM |
| transitions[].created_time datetime Conditionally returned | Date and time when the ACH transfer was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| transitions[].last_modified_time datetime Conditionally returned | Date and time when the ACH transfer was last modified. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| transitions[].program_reserve_token string Conditionally returned | Not currently used. Allowable Values: 36 char max |
| transitions[].reason string Conditionally returned | Explanation of why the transition is being made, for example “Created by POST call on API”. Returned if this information was supplied when the transition was originally created. Allowable Values: 255 char max |
| transitions[].return_code string Conditionally returned | Standardized ACH return code for a returned transaction, generally sent by the RDFI. Transactions can be returned for any of the reasons listed in the NACHA ACH return codes table of the ACH Origination Guide. Allowable Values: R01, R02, R03, R04, R05, R06, R07, R08, R09, R10, R11, R12, R13, R14, R15, R16, R17, R18, R19, R20, R21, R22, R23, R24, R25, R26, R27, R28, R29, R30, R31, R32, R33, R34, R35, R37, R38, R39, R40, R41, R42, R43, R44, R45, R46, R47, R50, R51, R52, R53, R61, R67, R68, R69, R70, R71, R72, R73, R74, R75, R76, R80, R81, R82, R83, R84, R85 |
| transitions[].return_reason string Conditionally returned | Human-readable description correlating to the return_code, such as Insufficient funds, if a return code is present in the response.Allowable Values: 255 char max |
| transitions[].status string Returned | New state of the ACH transfer. Allowable Values: PENDING, PROCESSING, SUBMITTED, RETURNED, COMPLETED, CANCELLED |
| transitions[].token string Conditionally returned | Unique identifier of the bank transfer transition. Allowable Values: 36 char max |
| transitions[].transaction_jit_token string Conditionally returned | Transaction token for JIT-related ledger entries for the ACH transfer. Allowable Values: Existing JIT Funding transaction token |
| transitions[].transaction_token string Conditionally returned | Transaction token for non-JIT-related ledger entries for the ACH transfer. Allowable Values: Existing transaction token |
| type string Conditionally returned | Specifies whether the ACH transfer is a push (credit) or pull (debit). Allowable Values: PUSH, PULL |
Sample response body
JSON
{
"token": "cf3b49d8-bd68-4fb1-8da5-c170cff3d788",
"amount": 10.49,
"memo": "Bank transfer",
"funding_source_token": "d331b4b2-cef5-49a3-9c41-75d8f4e15cfz",
"type": "PUSH",
"currency_code": "USD",
"transfer_speed": "STANDARD",
"statement_descriptor": "ACHTRNSFR",
"standard_entry_class_code": "WEB",
"status": "PENDING",
"transitions": [
{
"token": "0565329e-405d-45ca-9ab4-ca0cd07eca4c",
"bank_transfer_token": "cf3b49d8-bd68-4fb1-8da5-c170cff3d788",
"status": "PENDING",
"reason": "Created by `POST` call on API",
"channel": "API",
"created_time": "2024-03-20T18:32:32Z",
"last_modified_time": "2024-03-20T18:32:32Z"
}
],
"created_time": "2024-03-20T18:32:32Z",
"last_modified_time": "2024-03-20T18:32:32Z"
}