Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-07-244223105.2 KB
Payment account

Create payout

Create a payout request

post/v3/payment/payment-account/payouts

Request body

beneficiary_idstring required

The id of the payout beneficiary to which you wish to transfer money

amountnumber required

The amount you wish to transfer, positive and up to 2 decimals

labelstring required

This label that will be displayed on your bank account (140 characters max.)

client_referencestring

An optional reference to link this payout request to your system (100 characters max.)

Example request

{
  "beneficiary_id": "fe7ea5fc-81e8-46b0-bce7-5d0cecbdbad1",
  "amount": 20,
  "label": "A label",
  "client_reference": "client-ref-1234"
}

Response

Payout creation response

idstring
status'unknown' | 'created' | 'processing' | 'execution_skipped' | 'in_transit' | 'paid' | 'recalled' | 'canceled' | 'rejected' | 'failed'
client_referencestring

Your internal reference for reconciliation

labelstring

Label of the payout

amountnumber
currencystring
type'manual' | 'scheduled'
created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "6eeee884-810d-403c-8564-07b0eb7d5ed7",
  "beneficiary": {
    "id": "90da9c34-9baf-401d-8191-250841667fe6",
    "company_name": "YourCompany",
    "bank_name": "DemoBank",
    "iban": "FR66XXXXXXXXXXXXXXXXXXXXC26",
    "bic": "SMOEFRP3"
  },
  "status": "paid",
  "client_reference": "client-ref-1234",
  "label": "Payout Bridge",
  "amount": 100,
  "currency": "EUR",
  "type": "manual",
  "created_at": "2023-02-06T17:08:10.507Z",
  "updated_at": "2023-02-07T09:34:44.551Z"
}