Reference
Create a partner hosted-checkout session
Authorization
partnerKey AuthorizationBearer <token>
Partner Key for one approved Partner Integration. Keys are lifecycle- and scope-checked, and cross-integration resources are hidden.
In: header
Path Parameters
id*string
Format
uuidHeader Parameters
Idempotency-Key?string
Makes retried partner write requests safe.
Length
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/partner/residency_applications/497f6eca-6276-4993-bfeb-53cbbbba6f08/checkout_session" \ -H "Content-Type: application/json" \ -d '{ "redirectUrl": "http://example.com" }'{ "data": { "property1": null, "property2": null }, "invoiceId": "4f163819-178d-470c-a246-d6768476a6ec"}{ "error": "string", "error_description": "string", "details": [ null ]}{ "error": "string", "error_description": "string", "details": [ null ]}{ "error": "string", "error_description": "string", "details": [ null ]}{ "error": "string", "error_description": "string", "details": [ null ]}{ "error": "string", "error_description": "string", "details": [ null ]}{ "error": "string", "error_description": "string", "details": [ null ]}{ "error": "string", "error_description": "string", "details": [ null ]}