latestOpenAPI 3.1.02026-08-22124199170.4 KB

8a237f1f704f

consumers

Generate Consumer External Payment Card Iframe

Generate the PCI-compliant card-registration iframe URL for this consumer. Render the returned iframe_url to collect the consumer's debit card details — the card number never touches your systems or Upward's. The request body is optional; omit it to use the payment card configuration registered for your partner. On success the card is saved against the consumer and becomes available from GET /v2/consumers/{consumer_id}/payment-cards/external/.

Requires either api:write or api:card-management:write.

post/v2/consumers/{consumer_id}/payment-cards/external/

Path parameters

consumer_idstring uuid required

The consumer's external ID.

Headers

Authorizationstring required

Bearer authentication

Request body

domainstring

Parent domain that will host the iframe. Defaults to the Upward domain configured for your environment. Must be allow-listed before use — contact Upward to add one.

Response

iframe_urlstring uri required

Single-use URL to render in an iframe. Load it promptly — the registration session it carries is short-lived.