The POST /payouts/{id} call allows your platform to update and add custom data to a payout. Payouts allow your merchants to receive their funds from your platform.
object or null Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data. | |
Array of objects or null Any rbit data your platform chooses to attach to this resource. The rbit data must be key-value pairs and can be an array of rbit objects. |
INVALID_PARAMS
NOT_AUTHORIZED
UNEXPECTED_ERROR
{- "custom_data": null
}
{- "amount": 941,
- "complete_time": 1510128604,
- "create_time": 1510128004,
- "currency": "USD",
- "custom_data": {
- "customer_id": "a65dbc451",
- "reference_number": 436
}, - "failure_reason": null,
- "id": "00000000-0000-0000-0000-00000a51d642",
- "owner": {
- "id": "be2b42e5-b808-40ae-9bbe-3291ab493f57",
- "path": "/accounts/be2b42e5-b808-40ae-9bbe-3291ab493f57",
- "resource": "accounts"
}, - "path": "/payouts/00000000-0000-0000-0000-00000a51d642",
- "payout_method": {
- "id": "00000000-6261-5553-0000-000000000bf2",
- "path": "/payout_methods/00000000-6261-5553-0000-000000000bf2",
- "resource": "payout_methods"
}, - "pending_reasons": null,
- "resource": "payouts",
- "status": "completed",
- "txnr_failure": null,
- "txnr_payout": {
- "id": "00000000-0000-0000-0000-000000013003",
- "path": "/transaction_records/00000000-0000-0000-0000-000000013003",
- "resource": "transaction_records"
}, - "api_version": "3.0"
}