v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Create ACH Charge

Creates ACH debit/credit movement.

post/v1/achcharges

Headers

Acceptstring required

Indicates which content types, expressed as MIME types, the client is able to understand.

Content-Typestring required

Indicates the media type of the resource sent in the HTTP message body. Possible Values: application/json application/x-www-form-urlencoded

Idempotency-Keystring

Ensures that a request is processed only once, even if it is retried due to network timeouts or errors. When provided, the server uses the key to identify and return the result of a previous request with the same key, preventing duplicate operations (e.g., duplicate payments or record creation).

Request body

amountinteger required

A positive integer in cents representing how much to charge.

sec_code'CCD' | 'PPD' | 'TEL' | 'WEB' required

Sec. code' Must be one of the following: 'CCD','PPD','TEL','WEB'

type'debit' | 'credit' required

Type of flow. Must be one of the following: 'debit','credit'. 'debit' charges the customer and deposits funds in into your (the merchant). 'credit' charges you (the merchant) and deposits funds into your customers account

account_numberstring

Account Number.

routing_numberstring

Routing Number

first_namestring

First name of account holder

last_namestring

Last name of account holder

account_type'Personal Checking' | 'Personal Savings' | 'Business Checking' | 'Business Savings'

Account type. Must be one of the following: 'Personal Checking','Personal Savings','Business Checking','Business Savings'

currencystring

Three-letter ISO currency code, in lowercase.

receipt_emailstring

Recepient Email

receipt_phonestring

The cardholder's phone number.

address_line1string

The customer's address for line 1.

zipstring

The customer's ZIP code.

customer_idstring

An ID against which a new subscription will be created.

bank_account_idstring

Bank account ID of the ACH charge.

company_namestring

company_name is required when sending account type as Business Checking or Business Savings

Response

201

Example response

{
  "data": {
    "object": "ACHCharge",
    "id": "D9e7gdG8eedGE08a",
    "amount": 99,
    "created_by": "serviceuser0567051053675152@payarc.com",
    "status": "validated",
    "type": "debit",
    "authorization_id": 280023158,
    "validation_code": 1,
    "successful": true,
    "response_message": "Validated",
    "created_at": "2024-09-16T13:18:04.000000Z",
    "updated_at": "2024-09-16T13:18:05.000000Z",
    "sec_code": "TEL",
    "bank_account": {
      "data": {
        "object": "BankAccount",
        "id": "j4ELaekDaElK3JdD",
        "first_name": "Test",
        "last_name": "Test",
        "account_type": "Personal Checking",
        "sec_code": "CCD",
        "routing_number": "021000021",
        "account_number": "***********2345",
        "is_default": 1
      }
    }
  },
  "meta": {
    "include": [
      "customer"
    ]
  }
}