Skip to content

Create a payout entity

POST
/v1/admin/payouts/payout-entities/

Creates a payout entity with its schedule, price plan and, optionally, bank account in one request. Leave project_id out or null for a merchant-scoped entity. A merchant has either one merchant-scoped entity or project-scoped entities, never both: mixing them returns 409.

Authorization

apiKey
headerAuthorizationBasic <token>

HTTP Basic authentication with an admin API key as the username and an empty password.

Request Body

application/json
  1. body

A payout entity with its schedule, price plan and bank account.

merchant_id*string
Formatuuid
project_id?|

The project, for a project-scoped entity. Leave out or null for a merchant-scoped entity.

Formatuuid
payout_settings*

The payout schedule.

price_plan*

The fees of a payout entity. Amounts are in the smallest currency unit; percentages are strings with two or three decimals. Each combination of transaction type and outcome uses either ic_plus_plus or blended_fee, not both. See Price plans.

account_details?|

The bank account. Leave out or null to add it later; payouts are transferred once it's added.

Response Body

The API key is missing or not valid.

application/json
  1. response
error?
curl -X POST 'https://api.example.com/v1/admin/payouts/payout-entities/' \  --user "$API_KEY:" \  -H 'Content-Type: application/json' \  -d '{  "merchant_id": "b8a1c2d4-1234-4c5d-9e8f-0123456789ab",  "project_id": null,  "payout_settings": {    "frequency": "weekly",    "day": 1,    "delay_days": 2,    "cutoff_time": "23:59",    "cutoff_timezone": "Europe/Amsterdam"  },  "price_plan": {    "fees": [      {        "type": "blended_fee",        "name": "Card payments",        "currency": "EUR",        "transaction_types": [          "sale",          "capture"        ],        "outcomes": [          "accepted"        ],        "rate_percentage": "1.50",        "flat_amount": 10      },      {        "type": "recurring_fee",        "name": "Monthly fee",        "currency": "EUR",        "interval": "monthly",        "amount": 995      },      {        "type": "chargeback_tier_fee",        "name": "Visa chargebacks",        "currency": "EUR",        "card_scheme": "visa",        "interval": "monthly",        "bands": [          {            "from_percentage": "0.00",            "to_percentage": "1.00",            "amount": 0          },          {            "from_percentage": "1.00",            "to_percentage": null,            "amount": 5000          }        ]      },      {        "type": "rolling_reserve",        "name": "Rolling reserve",        "currency": "EUR",        "rate_percentage": "5.00",        "hold_days": 90      }    ]  },  "account_details": {    "account_holder": "Acme Coffee B.V.",    "iban": "NL00BANK1234567890",    "bic": "BANKNL2A",    "description": "Acme Coffee payout"  }}'
{  "error": {    "status": 0,    "type": "string",    "value": "string",    "property_path": "string",    "property_description": "string"  }}