DotsDocs
Payout agents

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.

PATCH
/v2/payout-agents/{payout_agent_id}

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.

Authorization

api_key
AuthorizationBasic <token>

In: header

Path Parameters

payout_agent_id*string

ID of the payout agent.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Properties1 <= properties

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v2/payout-agents/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "max_payout_amount": 10000,    "spending_caps": [      {        "amount": 20000,        "window_seconds": 3600      },      {        "amount": 100000,        "window_seconds": 86400      }    ]  }'
{  "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      }    ]  }}

Retrieve a Payout Agent

Get a payout agent, including its current balances, rules, and spending cap usage.

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.