Attach Payout Document
Upload and attach required documentation (such as an invoice or receipt) to an existing payout transaction.
📘
This endpoint must be called after initializing the transaction to obtain the transaction ID, but before finalizing the transaction. A payout document is required for certain types of payouts e.g India and China bank payouts.
Body Parameters
This endpoint accepts multipart/form-data to upload a document for a payout transaction.
| Parameter | type | Required | Description |
|---|---|---|---|
| file | file | ✅ | The document file to upload |
| name | string | ✅ | Name identifier for the document |
| type | string | ✅ | Type of document (e.g. "invoice") |
📘
The request must be sent with Content-Type: multipart/form-data instead of application/json since it involves file upload.
Request
Payouts/Attach Payout Document [POST]
curl --location \
--url 'https://sandboxapi.onbrails.com/api/v1/wallets/payout/file/upload/14c52854-46b5-4c98-81cc-89b92288b1c3' \
--header 'Authorization: Bearer sk.xxxxxxxxxxxx' \
--form 'file=@"/Users/files/Downloads/PROFORMAL INVOICE.pdf"' \
--form 'name="invoice"' \
--form 'type="invoice"'Responses
🟢 200 - Result example
{
"status": true,
"message": "Document uploaded successfully"
}