Skip to main content

Create a payout

Required scopes:

  • partner.payout.create
Request Body REQUIRED
paymentMethodId uuid REQUIRED

Id of the payment method to use for the payout. Payment method defines the currency of the payout.

originatorId uuid

Id of the payout originator. Payout originator is the actual source of funds. Can be omitted if Strike account owner is also the sender.

amount string REQUIRED

Amount to pay out. Currency is defined by the payment method.

reference string

Possible values: 1 ≤ length

Reference to pass to the receiver. Maximum length depends on the payment method transfer type (ACH - 10, US_DOMESTIC_WIRE - 15, SEPA - 128, FPS - 5).

Responses
201

Created

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.