Sign in
Payout
Beneficiary Payout

Payout available balances

Payout all available balances of your account to the preconfigured beneficiary bank account or wallet. If you want to handle payouts in a more dynamic and granular way, please use the POST /payout/create endpoint.

post/api/service/beneficiary-payout/create

Headers

Idempotency-Keystring

Idempotency key for safe retries. Reusing the same key always returns the cached response.

Response

Succeeded Beneficiary Payouts of available balances

idstring required

The unique identifier of the beneficiary payout

type'merchant' | 'customer' required

The type of payout

referenceIdstring required

The reference identifier for the payout

merchantstring required

The merchant identifier

amountnumber required

The beneficiary payout amount

descriptionstring required

Description of the payout

statementDescriptorstring required

The descriptor that appears on bank statements

status'paid' | 'pending' | 'in_transit' | 'failed' | 'canceled' required

The current status of the payout

currency'EUR' | 'USD' | 'GBP' | 'PLN' | 'SEK' | 'DKK' required

The currency of the balance which was settled to the beneficiary bank account or wallet.

{"stackTrail":"components:schemas:PerformPayoutResponseDto:items:properties:createdAt","oasType":"schema","type":"unknown","description":"The creation timestamp of the payout"}

Changes

Changed in 2 of the 48 revisions of this API.11

  • 84194dfc43b41See the full diff
    • ●

      added the new USD enum value to the items/currency response property for the response status 200

      response-property-enum-value-added

  • d617edaf95c01See the full diff
    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter