post https://testapi.payarc.net/v1/achcharges
Creates ACH debit/credit movement.
Include metadata to provide more context for your ACH transactions.
{
"amount": 100,
"routing_number": "{{routing_number}}",
"account_number": "{{accouunt_number}}",
"first_name": "Test",
"last_name": "Test",
"account_type": "Personal Checking",
"sec_code": "WEB",
"type": "debit",
"metadata": "{\"reference_id\": \"1234567\"}"
}Click to view details about the account information parameters
1. Account Number (account_number)
account_number)- Type:
integer - Description: Account Number.
- Required: Required if
customer_idis not present - Format: Numeric
- Min Length: 3 digits
- Max Length: 17 digits
- Example:
123432876
2. Routing Number (routing_number)
routing_number)- Type:
integer - Description: Routing Number.
- Required: Required if
customer_idis not present - Format: Numeric
- Min Length: 9 digits
- Max Length: 9 digits
- Example:
123432876
3. First Name (first_name)
first_name)- Type:
string - Description: First name of the account holder.
- Required: Required if
customer_idis not present - Format: Alphanumeric
- Min Length: 2 characters
- Max Length: 50 characters
- Example:
John
4. Last Name (last_name)
last_name)- Type:
string - Description: Last name of the account holder.
- Required: Required if
customer_idis not present - Format: Alphanumeric
- Min Length: 2 characters
- Max Length: 50 characters
- Example:
Doe
5. Account Type (account_type)
account_type)- Type:
string - Description: Account type. Must be one of the following: 'Personal Checking', 'Personal Savings', 'Business Checking', 'Business Savings'.
- Required: Yes
- Format: String
- Example:
Business Checking
6. SEC Code (sec_code)
sec_code)- Type:
string - Description: SEC code. Must be one of the following: 'ARC', 'BOC', 'CCD', 'POP', 'PPD', 'RCK', 'TEL', 'WEB'.
- Required: Optional
- Format: String
- Example:
WEB
7. Type (type)
type)- Type:
string - Description: Type of flow. Must be one of the following: 'debit', 'credit'.
- Required: Yes
- Format: String
- Example:
debit
8. Amount (amount)
amount)- Type:
integer - Description: A positive integer in cents representing how much to charge.
- Required: Yes
- Format: Numeric (in cents)
- Min Length: 1 digit
- Max Length: 8 digits
- Example:
9would be$0.0999999999would be$999,999.99
- Note: The minimum amount is $0.50 USD when testing in a test environment.
9. Currency (currency)
currency)- Type:
string - Description: Three-letter ISO currency code, in lowercase.
- Required: Yes
- Format: Alphabetic
- Allowed Values:
usd
10. Receipt Email (receipt_email)
receipt_email)- Type:
string - Description: Recipient Email.
- Required: Optional
- Format: String
- Example:
[email protected]
11. Receipt Phone (receipt_phone)
receipt_phone)- Type:
string - Description: The cardholder's phone number.
- Required: Optional
- Format: Numeric
- Min Length: 2 digits
- Max Length: 11 digits
- Example:
8772036624
12. Address Line 1 (address_line1)
address_line1)- Type:
string - Description: The customer's address for line 1.
- Required: Optional
- Format: Alphanumeric
- Min Length: 5 characters
- Max Length: 50 characters
- Example:
103 Mason Street
13. ZIP (zip)
zip)- Type:
string - Description: The customer's ZIP code.
- Required: Optional
- Format: Numeric and Hyphen
- Max Length: 10 digits
- Example:
1046910469-2345
- Note: To group numbers, use a hyphen symbol. No other symbols or characters are allowed.
14. Customer ID (customer_id)
customer_id)- Type:
string - Description: An ID against which a new ACH charge will be created.
- Required: Yes
- Format: Alphanumeric
- Note: Provide the
customer_idthat was created using the Create a Customer API.
15. Bank Account ID (bank_account_id)
bank_account_id)- Type:
string - Description: An ID against which a new ACH charge will be created.
- Required: Yes
- Format: Alphanumeric
- Note: Provide the
bank_account_idthat was created using the Create Bank Account API.