Ask an unlinked payer to authorize ACH debits

Requires a payee-owned bank account with microdeposits Pending and attempts remaining, or an already Verified bank. A replacement never inherits a previous request's payer proof; acceptance without this request's confirmationToken requires staff review. The engagement defaults to the payer default engagement. The token is returned rather than a URL; build your own page URL. Email delivery is attempted by default. Creation returns the request and token even if delivery fails; use resend to retry delivery. Identical creates recover the pending request without sending another email. A different request for the same engagement and bank is refused while one is pending. Cancel a mistaken request before creating a corrected one. Set shouldSendEmail=false to deliver the link yourself. Acceptance creates a Recurring mandate with a Maximum cap, but does not install a funding pair. Wait for Mandate.Activated and install the pair on this engagement using the existing engagement update.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 128
string
length between 1 and 128

Payer engagement to authorize. Defaults to the payer default engagement.

string
required
length between 1 and 128
string
required
amountRule
object
required
boolean
Defaults to true
Headers
string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json