Get Payout Target

Authorizations

Authorization

string

headerrequired

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

Path Parameters

payoutTargetId

string

required

Unique identifier 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

customerDetails.reference

string

An optional reference provided by the merchant to identify the customer.

customerDetails.name

string

First and last name for a natural person, and company name for a juridical person.

customerDetails.documentType

enum<string>

Colombian ID type for customer.

Available options:

cc,

ce,

nit

customerDetails.documentNumber

string

Colombian ID number for customer.

customerDetails.email

string

Customer’s email.

customerDetails.phoneNumber

string

Customer’s phone number.

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.