checkout

Create ACH Authorization

Changed on

Creates an ACH authorization record before the payment it will back. Callable either as the authenticated customer (SDK/iframe flow — the customer is resolved from the session, customerId in the body is ignored) or as merchant-admin/admin (direct-API integrators — the body's customerId is required and reconciled server-side). Pass the returned record's _id as achAuthorizationId on the ACH checkout call this authorization backs.

post/checkout/ach-authorization

Request

  • Base URL
    https://api-sandbox.coinflow.cash/api
  • URL
    https://api-sandbox.coinflow.cash/api/checkout/ach-authorization
  • Auth
    API key in header x-coinflow-auth-session-key

Request body

renderedAuthorizationTextstring required

Exact disclosure text shown to the end user at consent time.

consentTimestampstring date-time required
sessionAuthRefstring required

Reference/ID for the customer's authenticated session at consent time.

idempotencyKeystring required

A key unique to this intended checkout (a UUID you generate is fine). Passing the same key on a retried call returns the original authorization instead of creating a duplicate.

customerIdstring

Required when authenticating as merchant-admin/admin (no customer session to resolve one from); ignored for customer session-key calls, where the customer is resolved from the session instead.

tokenstring required

Purse token for the bank account being authorized.

Response

Ok

createdAtstring date-time required
revokedAtstring date-time
revokedboolean required

Once true, no further payments may use this authorization.

status'archived' | 'reopened' | 'deadline_passed_no_shipment' | 'fully_filled'
accountLastFourstring required
routingNumberstring required
renderedAuthorizationTextstring required
consentTimestampstring date-time required
sessionAuthRefstring required
merchantstring required
customerIdstring required
idempotencyKeystring required

Guarantees at most one authorization per intended checkout even if the create call is retried.

paymentIdstring

The founding ACH payment's external paymentId, linked in once that payment is created. Unset until then — the authorization itself must exist before its founding payment does. achAuthorizationId on checkout/subsequent-debit calls always refers to this record's own _id, not this field.

_idstring required

Changes

  • 81b590227b14Revision changes
    • warning

      deleted the header request parameter x-coinflow-auth-session-key

    • info

      the endpoint scheme security sessionKey was added to the API

  • 66b771d6d31fRevision changes
    • info

      api operation id create-ach-authorization removed and replaced with checkout_CreateAchAuthorization