Payout Targets
Payout Target schema
Payout Targets
Payout Target schema
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.
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.