Initiate a payout

Required scopes:

• partner.payout.initiate

Path Parameters
payoutId uuid — REQUIRED Payout id

Responses

200 OK Schema — OPTIONAL id uuid Id of the payout. state string Possible values: [NEW, INITIATED, COMPLETED, FAILED, REVERSED] Current state of the payout. created date-time Time of payout creation. paymentMethodId uuid Id of the payment method used for the payout. originatorId uuid — OPTIONAL Id of the payout originator. Payout originator is the actual source of funds. amount object Amount paid out. Does not include the fee. The total amount spent is amount + fee. amount string currency string Possible values: [USD, EUR, GBP] fee object — OPTIONAL Fee charged for the payout. amount string currency string Possible values: [USD, EUR, GBP] reference string — OPTIONAL Reference passed to the receiver. initiated date-time — OPTIONAL Time when the payout was initiated. completed date-time — OPTIONAL Time when the payout was completed. This is the time when the funds were sent to the receiver not when the receiver received the funds. It might take some additional time for the receiver's bank to process the payment.