Skip to content

Cancel an ACH payment intent before it is sent to the Fed.

POST
/payments/ach/{id}/cancel

Only a created draft or a pending (submitted, not yet sent) transfer can be canceled; once processed, use reversal instead.

id
required
string
Example
ach_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV

ACH payment intent ID

Intent canceled

object
amount
required

A monetary amount in the currency’s minor units (e.g. cents for USD).

integer format: int64
Example
1000
created
required
integer format: int64
currency
required

Currently supported currencies by Paygasus Pay

string
Allowed values: USD
Example
USD
description
string | null
id
required
string
Example
ach_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV
livemode
required
boolean
metadata
required
object
key
additional properties
string
payment_method
required
object
account_holder_name
required
string
Example
Jane Buyer
account_holder_type
required
string
Allowed values: personal business
account_last4
required
string
Example
6789
account_type
required
string
Allowed values: checking savings
routing_number
required
string
Example
021000021
statement_descriptor
string | null
status
required
One of:

Draft, not yet submitted to FNBO.

object
status
required
string
Allowed values: created
updated
required
integer format: int64

No such payment intent

object
error
required
object
code
required
string
message
required
string
param
string | null
type
required
string

Intent is not cancelable (already sent/settled), or is already being processed

object
error
required
object
code
required
string
message
required
string
param
string | null
type
required
string

Processor transport failure; the operation is retryable

object
error
required
object
code
required
string
message
required
string
param
string | null
type
required
string