POST
/
api
/
service
/
payout
/
create
curl --request POST \
  --url https://api.sand.getivy.de/api/service/payout/create \
  --header 'Content-Type: application/json' \
  --header 'X-Ivy-Api-Key: <api-key>' \
  --data '{
  "amount": 123,
  "currency": "EUR",
  "metadata": {},
  "destination": {
    "orderId": "<string>",
    "financialAddress": {
      "type": "<string>",
      "iban": {
        "iban": "<string>",
        "bic": "<string>",
        "accountHolderName": "<string>"
      },
      "sortCode": {
        "sortCode": "<string>",
        "accountNumber": "<string>",
        "accountHolderName": "<string>"
      },
      "bankCode": {
        "code": "<string>",
        "accountNumber": "<string>",
        "accountHolderName": "<string>"
      },
      "bban": {
        "bban": "<string>",
        "accountHolderName": "<string>",
        "bic": "<string>"
      }
    }
  },
  "paymentReference": "<string>"
}'
{
  "id": "<string>",
  "destination": {
    "type": "<string>",
    "iban": {
      "iban": "<string>",
      "bic": "<string>",
      "accountHolderName": "<string>"
    },
    "sortCode": {
      "sortCode": "<string>",
      "accountNumber": "<string>",
      "accountHolderName": "<string>"
    },
    "bankCode": {
      "code": "<string>",
      "accountNumber": "<string>",
      "accountHolderName": "<string>"
    },
    "bban": {
      "bban": "<string>",
      "accountHolderName": "<string>",
      "bic": "<string>"
    }
  },
  "status": "paid",
  "amount": 123,
  "currency": "EUR",
  "metadata": {},
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-Ivy-Api-Key
string
header
required

Body

application/json
​
amount
number
required

The amount of the customer payout

​
currency
enum<string>
required

The currency of the customer payout

Available options:
EUR,
GBP,
PLN
​
destination
object
required

The destination of the customer payout.

​
metadata
object

The metadata of the customer payout

​
paymentReference
string

The payment reference of the customer payout. The customer will see this reference in their bank statement.

Response

200 - application/json
Returns a Customer Payout
​
id
string
required
​
destination
object
required

The validation logic is based on the "type" field. For example, if "type" is set to "iban", the "iban" object must be filled out.

​
status
enum<string>
required
Available options:
paid,
pending,
failed
​
amount
number
required
​
currency
enum<string>
required
Available options:
EUR,
GBP,
PLN
​
metadata
object

Any key-value pairs, which will be stored to the object. See here for more info.

​
updatedAt
string
​
createdAt
string