ACH

You are here

The ACH API is used to process credit and debit from Bank Accounts. This sandbox provides interactive samples for all available ACH processing methods.

API Health

Method
Description

GET

get_ping

https://api-cert.sagepayments.com/ach/v1/ping

Used to retrieve basic server/environment information about the front-end API.

GET

get_status

https://api-cert.sagepayments.com/ach/v1/status

Used to retrieve basic server/environment information about the front- and back-end APIs.

Charges

Method
Description

GET

get_charges

https://api-cert.sagepayments.com/ach/v1/charges

Used to query charges by various criteria including amount, date, order number, type, etc. Results include both summarized information and itemized detail.

POST

post_charges

https://api-cert.sagepayments.com/ach/v1/charges

Used to process a charge / Sale transactions in a single request.

GET

get_charges_detail

https://api-cert.sagepayments.com/ach/v1/charges/{reference}

Used to retrieve detailed information about a specific charge.

DELETE

delete_charges

https://api-cert.sagepayments.com/ach/v1/charges/{reference}

Used to "void", or cancel, a charge. Only unsettled transactions can be voided; settled transactions should be credited instead.

Credits

Method
Description

GET

get_credits

https://api-cert.sagepayments.com/ach/v1/credits

Used to query credits by various criteria including amount, date, order number, type, etc. Results include both summarized information and itemized detail.

POST

post_credits

https://api-cert.sagepayments.com/ach/v1/credits

Used to process a credit. Credit transactions refund an amount to a card.

GET

get_credits_detail

https://api-cert.sagepayments.com/ach/v1/credits/{reference}

Used to retrieve detailed information about a specific credit.

POST

post_credits_reference

https://api-cert.sagepayments.com/ach/v1/credits/{reference}

Used to process a credit. Referencing a previous transaction allows you to issue a refund without knowing the card number and expiration date.

DELETE

delete_credits

https://api-cert.sagepayments.com/ach/v1/credits/{reference}

Used to "void", or cancel, a credit. Only unsettled transactions can be voided.

Reporting on Transactions

Method
Description

GET

get_transactions

https://api-cert.sagepayments.com/ach/v1/transactions

Used to query transactions by various criteria including amount, date, order number, type, etc. Results include both summarized information and itemized detail.

GET

get_transactions_detail

https://api-cert.sagepayments.com/ach/v1/transactions/{reference}

Used to retrieve detailed information about a specific transaction.

Settlements and Batches

Method
Description

GET

get_batches

https://api-cert.sagepayments.com/ach/v1/batches

Used to query settled batches by date. Results include itemized details, such as settlement date and reference number.

GET

get_batches_current

https://api-cert.sagepayments.com/ach/v1/batches/current

Used to retrieve itemized detail about the transactions in the current batch.

GET

get_batches_current_summary

https://api-cert.sagepayments.com/ach/v1/batches/current/summary

Used to retrieve summarized information, such as count and volume, about the transactions in the current batch.

GET

get_batches_totals

https://api-cert.sagepayments.com/ach/v1/batches/totals

Used to retrieve the total count and amount of all batches settled within a given timeframe.

GET

get_batches_reference

https://api-cert.sagepayments.com/ach/v1/batches/{reference}

Used to retrieve itemized detail about the transactions in a specific batch.

Settlements, Summary and Batches

Method
Description

GET

get_batches_reference_summary

https://api-cert.sagepayments.com/ach/v1/batches/{reference}/summary

Used to retrieve summarized information, such as count and volume, about the transactions in the current batch.

Tokens

Method
Description

POST

post-tokens

https://api-cert.sagepayments.com/ach/v1/tokens

Used to store a card and retrieve a vault token. A vault token allows you to process a charge or credit without knowing the Routing number and Account number.

PUT

put-token

https://api-cert.sagepayments.com/ach/v1/tokens/{reference}

Used to update the card data associated with a vault token.

DELETE

delete-token

https://api-cert.sagepayments.com/ach/v1/tokens/{reference}

Used to delete a vault token.