Skip to main content

PayoutRequest

pointOfSaleIduuidrequired

UUID of the Point of Sale to debit from; must belong to your account.

Example: 0192473a-e381-705c-b61c-fc2ac9624afc
amountintegerrequired

Amount in minor units (e.g., 1095 = 10.95 DKK). Must be >= 1.

Possible values: >= 1

Example: 1000
currencystringrequired

ISO 4217 alpha-3 currency, e.g., “DKK”.

Possible values: Value must match regular expression ^[A-Z]{3}$

Example: DKK
paymentMethodIduuidrequired

UUID of a stored payment method eligible for payouts.

Example: 01924756-d1f6-738d-8040-90d76cedf01f
referencestring

Merchant reference for reconciliation; should be unique per payout when possible. Defaults to the ePay transaction id.

Example: payout-1
textOnStatementstring

Descriptor shown on recipient’s statement; acquirer limits may apply (e.g., 22 chars).

Possible values: non-empty and <= 39 characters

Example: Prize money
processorProcessor (string)[]

List of permitted processors; order is priority fallback. Values: shift4, clearhaus, nets.

Possible values: [shift4, clearhaus, nets, worldline]

Example: ["shift4","clearhaus"]
attributes object

Pass-through key-value pairs returned in webhooks; recommend max combined size (e.g., 1 KB) and ASCII/UTF-8 guidance.

property name*string
customer object
firstNamestringrequired

Recipient name; used for compliance and risk.

Example: Morten
lastNamestringrequired

Recipient name; used for compliance and risk.

Example: Thomassen
ipstringrequired

IPv4/IPv6 address of the client initiating the payout request; used for fraud/risk.

Example: 118.249.219.99
birthdatestringnullable

The birthdate of the recipient. YYYY-MM-DD; required by some payout methods;

Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}$

Example: 1970-01-01
notificationUrlurirequired

Webhook target for payout result. This endpoint will be called once the transaction is fully processed.

PayoutRequest
{
  "pointOfSaleId": "0192473a-e381-705c-b61c-fc2ac9624afc",
  "amount": 1000,
  "currency": "DKK",
  "paymentMethodId": "01924756-d1f6-738d-8040-90d76cedf01f",
  "reference": "payout-1",
  "textOnStatement": "Prize money",
  "processor": [
    "shift4",
    "clearhaus"
  ],
  "attributes": {
    "key1": "value1",
    "key2": "value2"
  },
  "customer": {
    "firstName": "Morten",
    "lastName": "Thomassen",
    "ip": "118.249.219.99",
    "birthdate": "1970-01-01"
  },
  "notificationUrl": "string"
}