Skip to main content
GET
Read a destination

Authorizations

Authorization
string
header
required

Bearer authentication header on the format Bearer <API_KEY>.

Path Parameters

id
string<uuid>
required

Destination's unique identifier.

Response

200 - application/json

Destination successfully retrieved.

Destination's rail is PIX.

id
string<uuid>

Destination's unique identifier.

Example:

"e80d3137-eddd-4791-b9b8-6e36b289f284"

customerId
string<uuid>

Customer's unique identifier.

Example:

"3c90c3cc-0d44-4b50-8888-8dd25736052a"

name
string

Destination's display name.

Example:

"Lumx Destination 1"

type
enum<string>

Destination's type.

Available options:
EXTERNAL
rail
enum<string>

Destination's payment rail.

Available options:
PIX
currency
enum<string>

Destination's currency.

Available options:
BRL
identifier
object

Destination's identifier.

holder
object

Destination's holder.

createdAt
string<date-time>

Creation date and time (UTC).

updatedAt
string<date-time>

Last update date and time (UTC).