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

Response

200 - application/json
Returns a Customer Payout

The response is of type object.