Create Payout Target

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

customerId

string

required

The ID of the customer for whom the Payout Target is created.

redirectUrl

string

required

URL to which the customer will be redirected after the authorization process.

type

enum<string>

required

Available options:

bankAccount

bankAccount

object

required

Show child attributes

reference

string

An optional reference provided by the merchant to identify the Payout Target.

description

string

An optional description of the Payout Target.

Response

200 - application/json

id

string

Unique identifier for this Payout Target.

reference

string

Reference sent in by merchant to identify Payout Target.

description

string

An extra metadata field that can be included for visibility.

customerId

string

Reference to customer who owns this Payout Target.

customerDetails

object

Details about the customer who owns this Payout Target.

Show child attributes

status

enum<string>

Status of the Payout Target.

Available options:

active,

cancelled

statusMessage

enum<string>

Additional detail on the status. Only present when status is "cancelled".

Available options:

AUTHENTICATION_FAILED,

CUSTOMER_CANCELLATION,

DECLINED_BY_BANK,

EXPIRED,

INVALID_ACCOUNT,

NOT_ENOUGH_FUNDS,

ERROR

authUrl

string

URL where the customer should be redirected to complete the Payout Target verification.

redirectUrl

string

URL where the customer will be redirected after completing the Payout Target verification.

type

enum<string>

Type of Payout Target created.

Available options:

bankAccount

createdAt

string

ISO string indicating when the Payout Target was created.

updatedAt

string

ISO string indicating when the Payout Target was last updated.