Payout
Create a payout
Create a payout for a merchant.
post/api/service/payout/create
Request body
amountnumber required
The payout amount in decimal format. The minimum amount is 0.01.
currency'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK' required
The payout currency
metadataobject
This can be used to store any additional information you need to associate with this payout.
paymentReferencestring
The payout payment reference. This is visible to the receiving party, if possible.
Response
Create a payout
idstring required
The payout ID
type'beneficiary' | 'customer' required
The payout type
status'paid' | 'pending' | 'in_transit' | 'failed' | 'canceled' required
The payout status
amountnumber required
The payout amount
currency'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK' required
The payout currency
metadataobject
The payout metadata
{"stackTrail":"components:schemas:CreatePayoutResponseDto:properties:createdAt","oasType":"schema","type":"unknown","description":"The payout created at"}
{"stackTrail":"components:schemas:CreatePayoutResponseDto:properties:updatedAt","oasType":"schema","type":"unknown","description":"The payout updated at"}
paymentReferencestring
The payout payment reference
transactionIdstring
The payout transaction ID