e-Próspera
Reference

Pay a partner application with a voucher

View as Markdown
POST
/api/v1/partner/residency_applications/{id}/pay/voucher

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
Formatuuid

Header Parameters

Idempotency-Key?string

Makes retried partner write requests safe.

Length1 <= length

Request 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/pay/voucher" \  -H "Content-Type: application/json" \  -d '{    "voucherCode": "string"  }'
{  "data": {    "property1": null,    "property2": null  },  "success": true,  "message": "string",  "property1": null,  "property2": null}

Create a partner hosted-checkout session POST

Previous Page

Create a secure agreement and KYC embed session POST

Requires `partner:person.embed_session.create`. The application must be partner-owned, complete except for agreement/KYC, and paid. The one-time URL is bound to the parent-held PKCE verifier and may only be framed by the selected allow-listed origin. Issuance is not idempotent: retrying this operation creates a replacement link and revokes any previously active embed session for the application.