EPeprospera
Partner residency applications

Create a partner hosted-checkout session

Changed on

Creates a hosted checkout for the application invoice. Send exactly one of paymentProvider or paymentMethod. redirectUrl must use an approved redirect origin; Stripe returns the payer to redirectUrl?success=true on success and to redirectUrl on cancel. The response is { data: { url }, invoiceId }. Payment is confirmed asynchronously: poll the application until nextSteps.paymentRequired is false. Requires Idempotency-Key.

post/api/v1/partner/residency_applications/{id}/checkout_session

Request

Path parameters

idstring uuid required
Example:4e368230-84e3-4cb8-9225-a6d972e425fc

Headers

Idempotency-Keystring required

8-128 URL-safe characters. Retained for 24 hours per integration and route. An identical retry replays the stored response with Idempotency-Replayed: true; a different body under the same key returns 409.

Request body

paymentProvider'stripe' | 'stripe-crypto' | 'blink' | 'blink-onchain' | 'solana-pay-ptc'
paymentMethodobject
emailstring email nullable
redirectUrlstring uri required

Response

Checkout session.

dataobject nullable required
invoiceIdstring uuid required

Changes

  • d2c5a5cda002Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 197106eab8bcRevision changes
    • breaking

      the header request parameter Idempotency-Key became required

    • breaking

      for the header request parameter Idempotency-Key, the minLength was increased from 1 to 8

    • breaking

      added the pattern ^[A-Za-z0-9_.~-]+$ to the header request parameter Idempotency-Key

    • warning

      for the header request parameter Idempotency-Key, the maxLength was set to 128

    • info

      added the non-success response with the status