Skip to content
Gowd Platform Production

List PIX keys

GET
/order/v1/banking/accounts/{accountId}/keys

Retrieve all PIX keys for the given account.

accountId
required
string format: uuid

Identifier of the account

The resource was returned successfully

object
data
required

List of PIX keys linked to the account

Array<object>
object
id
required

Identifier of the PIX key

string
type
required

Type of the PIX key

string
Allowed values: CPF CNPJ EMAIL PHONE RANDOM
key
required

PIX key value

string
createdAt
required

Creation date of the PIX key

string
possedAt
required

Date when the key was associated to the account

string
object
error
string
message
string
details
Array<object>
object
field
string
issue
string
description
string

Unauthorized Request

object
error
string
message
string
details
Array<object>
object
field
string
issue
string
description
string
object
error
string
message
string
details
Array<object>
object
field
string
issue
string
description
string