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.

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`.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

consumer_idstringRequiredformat: "uuid"

The consumer's external ID.

Request

This endpoint expects an object.

domainstringOptional

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_urlstringformat: "uri"

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

Errors

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST /v2/consumers/consumer_id/payment-cards/external/ \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"domain": "https://app.example.com"
>	}'