Pause a Payout Agent
Pause a payout agent. The agent's new payouts are rejected with `payout-agent-paused` immediately. Payouts it already queued that have not reached a provider are canceled and their funds return to the agent's available balance. Payouts already submitted to a provider are canceled on a best-effort basis; follow each payout's `cancellation` object for the outcome. Pausing an already paused agent requests cancellation of its in-flight payouts again.
Pause a payout agent. The agent's new payouts are rejected with payout-agent-paused immediately. Payouts it already queued that have not reached a provider are canceled and their funds return to the agent's available balance. Payouts already submitted to a provider are canceled on a best-effort basis; follow each payout's cancellation object for the outcome. Pausing an already paused agent requests cancellation of its in-flight payouts again.
Authorization
api_key In: header
Path Parameters
ID of the payout agent.
uuidResponse Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v2/payout-agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/pause"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "payout_agent", "api_app_id": "ad6a2ad4-d593-4e3e-bfd5-50592ed119ca", "name": "string", "status": "active", "paused_at": "2019-08-24T14:15:22Z", "created": "2019-08-24T14:15:22Z", "currency": "usd", "available_balance": 0, "committed_balance": 0, "rules": { "max_payout_amount": 0, "recipient_restriction_enabled": true, "spending_caps": [ { "amount": 0, "window_seconds": 0, "used": 0, "remaining": 0 } ] }}{ "success": false, "message": "string", "error_code": "string", "errors": [ null ]}{ "success": false, "message": "string", "error_code": "string", "errors": [ null ]}{ "success": false, "message": "string", "error_code": "string", "errors": [ null ]}Update a Payout Agent
Update a payout agent's name or rules. Only the fields you send change. Payouts the agent already sent are unaffected: spending cap usage is always computed from the payouts themselves, so lowering or replacing caps never resets usage.
Resume a Payout Agent
Resume a paused payout agent so it can send new payouts. Payouts canceled while it was paused are not resent.