Start the payouts for a batch
Creates a payout for every recipient in the batch in one call and records the run as a session. The payouts settle asynchronously, so a webhook callback URL must be configured. Requires the TRANSACTION.WITHDRAW.CREATE key permission.
Each call is a new run and pays every recipient again. To retry only the payouts that failed, pass the run's sessionId. A call made while a run of the same batch is still in progress is refused with 409. A batch with no recipients is refused with 400.
Request
- Base URLhttps://sandbox.api.afriex.com
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Id of an earlier run of this batch (from the sessions list). Only the recipients that failed in that run are paid. An unknown id, or one from another batch, is refused with 400.
Response
Per-recipient outcomes, keyed by recipientId.
Changes
No recorded changes to this operation across all 1 revision of this API.