Sign in
Payouts

Submit Payout Documents

Submit compliance documents for SWIFT payouts requiring review. Includes optional payment description.

post/v1/instances/{instance_id}/payouts/{id}/documents

Path parameters

instance_idstring required
Example:in_000000000000
idstring required
Example:pa_000000000000

Headers

Idempotency-Keystring

Optional key to safely retry this request without performing the action twice. Retrying with the same key and an identical body replays the original response; reusing a key with a different body returns an error. Keys are kept for 24 hours.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Request body

transaction_document_type'invoice' | 'purchase_order' | 'delivery_slip' | 'contract' | 'customs_declaration' | 'bill_of_lading' | 'others' required

Document type

transaction_document_idstring required

Document identifier (invoice number, contract ID, etc.)

transaction_document_filestring uri required

URL to the uploaded document

descriptionstring

Optional payment description/memo (max 128 chars)

Example request

{
  "transaction_document_type": "invoice",
  "transaction_document_id": "INV-12345",
  "transaction_document_file": "https://example.com/document.pdf",
  "description": "Payment for services - Invoice #12345"
}

Response

Documents submitted successfully

successboolean required

Example response

{
  "success": true
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.