Create PIX key
POST /order/v1/banking/accounts/{accountId}/keys
POST
/order/v1/banking/accounts/{accountId}/keys
Create a PIX key for the given account.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” accountId
required
string format: uuid
Identifier of the account
Header Parameters
Section titled “Header Parameters ” idempotency-key
required
string format: uuid
A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
Request Body required
Section titled “Request Body required ”object
type
required
Type of PIX key to be created
string
key
required
PIX key value (required unless type is RANDOM)
string
Responses
Section titled “ Responses ”The resource was returned successfully
object
id
required
Identifier of the PIX key
string
type
required
Type of the PIX key
string
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