Skip to main content
PUT
Update ACH Authorization Revocation
Updates the revocation status for one exact bank-account payment method owned by an already-shared customer. customerId is your external customer reference; paymentMethodId is the payment-method UUID returned by this API. Both are checked against the company identified by the API key.
true revokes the current ACH authorization and removes the payment method’s default status. Repeating true is idempotent. Omitted or null makes no change. false cannot restore consent. It is an idempotent no-op while the method still has an active authorization, but returns 422 after revocation. Capture a new customer authorization through the normal authorization workflow to clear the revoked-authorization status. A payment method with no active or historical ACH authorization returns 409 for true. This endpoint accepts bank-account payment methods only. It never applies the revocation to a different payment method or to every method on the customer.

Authorizations

X-API-Key
string
header
required

Path Parameters

customerId
string
required

External customer reference ID

paymentMethodId
string<uuid>
required

Payment-method UUID returned by this API

Body

application/json

Partial revocation update for an exact ACH payment method.

revokeAuthorization
boolean | null

true revokes the active authorization. false is a no-op only while authorization remains active; it cannot restore revoked consent. Omitted or null makes no change.

Response

Authorization revocation status

customerId
string
required
paymentMethodId
string<uuid>
required
revokeAuthorization
boolean
required