Partner residency applications

Pay a partner application with a voucher

Changed on Sep 22, 2026

Applies a voucher that must cover the full invoice. Returns the updated application with nextSteps.paymentRequired false. Voucher errors carry a machine-readable code: voucher_not_found, voucher_expired, voucher_already_redeemed, voucher_not_applicable, voucher_not_full_coverage, invoice_not_found. Requires Idempotency-Key.

post/api/v1/partner/residency_applications/{id}/pay/voucher

Request

Base URL
https://portal.eprospera.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/eprospera/apis/e-pro-spera-api/docs/api/v1/partner/residency_applications/:id/pay/voucher/post.ts
A function with typed inputs. Its response is checked against the schema.

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

voucherCodestring required

Response

Voucher applied; the application is returned.

Changes

Sep 22, 2026d2c5a5cda002 Revision 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
Sep 15, 2026197106eab8bc Revision 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
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  the response property became required for the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status

Operation history