PayoutRequest | ePay documentation

pointOfSaleIdstring

Required

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

Format:

uuid

Example:

"0192473a-e381-705c-b61c-fc2ac9624afc"

amountinteger

Required

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

Range:

1 <= value

Example:

1000

currencystring

Required

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

Match:

^[A-Z]{3}$

Example:

"DKK"

paymentMethodIdstring

Required

UUID of a stored payment method eligible for payouts.

Format:

uuid

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).

Length:

1 <= length <= 39

Example:

"Prize money"

descriptorstring

Nullable

Optional descriptor for the payout. It overrides the Point of Sale descriptor unless the acquirer agreement has its own descriptor.

Descriptor override must be enabled for your account before you send this field. Contact ePay to enable it.

Length:

1 <= length <= 22

Example:

"Store Refunds"

DEPRECATED: This parameter will soon be removed and will no longer have any effect. The functionality has been replaced by routing rules in the ePay back office.

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

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

firstNamestring

Required

Recipient name; used for compliance and risk.

Example:

"Morten"

lastNamestring

Required

Recipient name; used for compliance and risk.

Example:

"Thomassen"

ipstring

Required

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

Example:

"118.249.219.99"

birthdatestring

Nullable

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

Match:

^\d{4}-\d{2}-\d{2}$

Example:

"1970-01-01"

notificationUrlstring

Required

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

Format:

uri

PayoutRequest

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