PApayarc

Get ACH Charges (COPY)

Changed on

This endpoint retrieves a list of ACH charge records. You can apply pagination and also retrieve additional data, such as return details , by using query parameters.

get/v1/achcharges (COPY)

Request

  • Base URL
    https://testapi.payarc.net
  • URL
    https://testapi.payarc.net/v1/achcharges (COPY)
  • Auth
    API key in header Authorization

Query parameters

limitinteger
pageinteger
includestring

customer, transaction_metadata, returns

Response

200

Example response

{
  "data": {
    "object": "ACHCharge",
    "id": "D5e7gdG8enrGE08a",
    "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": "j4ELnrkDaElK3JdD",
        "first_name": "Test",
        "last_name": "Test",
        "account_type": "Personal Checking",
        "sec_code": "CCD",
        "routing_number": "021000021",
        "account_number": "***********1234",
        "is_default": 1
      }
    },
    "customer": {
      "data": {
        "object": "customer",
        "customer_id": "DPLMjN4nMTVVnAR",
        "name": "Joanna Roscoe",
        "email": "customer@payarc.com",
        "description": "Created by Payarc",
        "country": "US",
        "created_at": 1731716713,
        "updated_at": 1731716713,
        "readable_created_at": "2 months ago",
        "readable_updated_at": "2 months ago",
        "invoice_prefix": "ZB3G",
        "bank_account": {
          "data": [
            {
              "object": "BankAccount",
              "id": "D11da4nrrntkLjle",
              "first_name": "Joanna",
              "last_name": "Roscoe",
              "account_type": "Personal Checking",
              "sec_code": "WEB",
              "routing_number": "224101021",
              "account_number": "**5511",
              "is_default": 1
            }
          ]
        }
      }
    },
    "returns": {
      "data": [
        {
          "object": "ACHReturn",
          "id": "or5yplgbnjg03rnr",
          "return_code": "R02",
          "description": "Account Closed"
        }
      ]
    }
  },
  "meta": {
    "include": [
      "customer"
    ]
  }
}

Changes