Process ACH Payments

Now that you have completed the Collect Bank Accounts guide, let's process an ACH payment with the newly captured bank account.

Getting Started

To get started, you will need a PublicSquare Account.

Sign Up

Sign In

Get your Secret Key

Next you will need your Secret Key. Go to your Developers section and click Reveal for your Secret Key and copy the value.

Save the Secret Key as it will be used in the next steps of this guide.

Process the Payment

We will need to use the information from the previously collected bank account to create a new payment.

For example, given you have a previously collected bank account:

{
  "id": "ba_7Ay5mcUXAxwrN6wQEQUVEHBCJ",
  "account_id": "acc_B518niGwGYKzig6vtrRVZGGGV",
  "environment": "test",
  "customer_id": "cus_7Ay5mcUXAxwrN6wQEQUVEHBCJ",
  "billing_details": {
    "address_line_1": "111 Colorado Ave.",
    "address_line_2": "Apt 403",
    "city": "Des Moines",
    "state": "IA",
    "postal_code": "51111",
    "country": "US"
  },
  "created_at": "2024-06-30T01:02:29.212Z",
  "modified_at": "2024-06-30T01:02:29.212Z",
  "account_holder_name": "John Doe",
  "account_holder_type": "individual",
  "account_type": "checking",
  "routing_number": "110000000",
  "account_number_last4": "1011"
}

We need to make a call to Create Payment endpoint:

Create a Payment

curl 'https://api.publicsquare.com/payments' \
-X 'POST' \
-H 'X-API-KEY: <API_KEY_SECRET>' \
-H 'IDEMPONTENCY-KEY: '09ec2c87-7fb8-44ca-bb18-5c71a76974da' \
-H 'Content-Type: application/json' \
-d '{
  "amount": 1000,
  "currency": "USD",
  "paymentMethod": {
    "bank_account": "ba_7Ay5mcUXAxwrN6wQEQUVEHBCJ"
  },
  "customer": {
    "first_name": "John",
    "last_name": "Smith",
    "email": "john.smith@email.com"
  },
  "billing_details": {
    "address_line_1": "111 Test St.",
    "city": "Des Moines",
    "state": "IA",
    "postal_code": "51111",
    "country": "US"
  }
}'

The amount is provided in cents. 1000 is the equivalent of $10.00

The IDEMPONTENCY-KEY header can be passed to protect against duplicate payments being processed.

If you created a customer, then you can pass the customer_id when processing the payment:

Create a Payment with Customer

curl 'https://api.publicsquare.com/payments' \
-X 'POST' \
-H 'X-API-KEY: <API_KEY_SECRET>' \
-H 'IDEMPONTENCY-KEY: '09ec2c87-7fb8-44ca-bb18-5c71a76974da' \
-H 'Content-Type: application/json' \
-d '{
  "amount": 1000,
  "currency": "USD",
  "paymentMethod": {
    "bank_account": "ba_7Ay5mcUXAxwrN6wQEQUVEHBCJ"
  },
  "customer": {
    "customer_id": "cus_7Ay5mcUXAxwrN6wQEQUVEHBCJ"
  },
  "billing_details": {
    "address_line_1": "111 Test St.",
    "city": "Des Moines",
    "state": "IA",
    "postal_code": "51111",
    "country": "US"
  }
}'

If you attached the bank account to a customer, then you can omit the customer section when processing the payment:

Create a Payment with Customer

curl 'https://api.publicsquare.com/payments' \
-X 'POST' \
-H 'X-API-KEY: <API_KEY_SECRET>' \
-H 'IDEMPONTENCY-KEY: '09ec2c87-7fb8-44ca-bb18-5c71a76974da' \
-H 'Content-Type: application/json' \
-d '{
  "amount": 1000,
  "currency": "USD",
  "paymentMethod": {
    "bank_account": "ba_7Ay5mcUXAxwrN6wQEQUVEHBCJ"
  },
  "billing_details": {
    "address_line_1": "111 Test St.",
    "city": "Des Moines",
    "state": "IA",
    "postal_code": "51111",
    "country": "US"
  }
}'

If you supplied the billing_details or updated the bank account, then you can omit the billing_details section when processing the payment:

Create a Payment with Customer

curl 'https://api.publicsquare.com/payments' \
-X 'POST' \
-H 'X-API-KEY: <API_KEY_SECRET>' \
-H 'IDEMPONTENCY-KEY: '09ec2c87-7fb8-44ca-bb18-5c71a76974da' \
-H 'Content-Type: application/json' \
-d '{
  "amount": 1000,
  "currency": "USD",
  "paymentMethod": {
    "bank_account": "ba_7Ay5mcUXAxwrN6wQEQUVEHBCJ"
  }
}'

Given the above examples, you should see a payment result similar to:

{
  "id": "pmt_2YKewBonG4tgk12MheY3PiHDy",
  "account_id": "acc_B518niGwGYKzig6vtrRVZGGGV",
  "environment": "test",
  "status": "pending",
  "transaction_id": "trx_95rvMJvAVeG68W4NtLdfkN3LG",
  "amount": "1000",
  "amount_charged": "1000",
  "amount_refunded": "0",
  "refunded": "false",
  "currency": "USD",
  "payment_method": {
    "bank_account": {
      "id": "ba_7Ay5mcUXAxwrN6wQEQUVEHBCJ",
      "account_holder_name": "John Doe",
      "account_holder_type": "individual",
      "account_type": "individual",
      "routing_number": "123456789",
      "account_number_last4": "1011"
    }
  },
  "customer": {
    "id": "cus_7Ay5mcUXAxwrN6wQEQUVEHBCJ",
    "first_name": "John",
    "last_name": "Smith",
    "email": "john.smith@email.com",
  },
  "billing_details": {
    "address_line_1": "111 Test St.",
    "city": "Des Moines",
    "state": "IA",
    "postal_code": "51111",
    "country": "US"
  },
  "shipping_address": {
    "address_line_1": "111 Colorado Ave.",
    "address_line_2": "Apt 403",
    "city": "Des Moines",
    "state": "IA",
    "postal_code": "51111",
    "country": "US"
  },
  "fraud_decision": {
    "decision": "accept"
  },
  "created_at": "2024-06-30T01:02:29.212Z",
  "modified_at": "2024-06-30T01:02:29.212Z"
}

Conclusion

Now that we have seen how to process payments with a collected bank account, we may need to manage the payment or view information about the payment. Follow these guides to learn more:

• Issue a Refund
• View Transactions