Skip to main content
POST
/
v1
/
pix
/
keys
Create a new PIX key
curl --request POST \
  --url https://api-sandbox.rinne.com.br/core/v1/pix/keys \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "provider": "CELCOIN",
  "key_type": "EVP",
  "primary": false
}
'
{
  "id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
  "affiliation_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2794",
  "company_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
  "key_type": "EVP",
  "key": "<string>",
  "primary": true,
  "status": "ACTIVE"
}

Authorizations

​
x-api-key
string
header
required

Company API key for authentication

Body

application/json
​
provider
enum<string>
required

The provider name (accepts lowercase and uppercase, returns uppercase)

Available options:
CELCOIN,
RINNE
Minimum string length: 1
Example:

"CELCOIN"

​
key_type
enum<string> | null
required

The Pix key type:

  • EVP: Random key generated by provider (key field should not be provided)
Available options:
EVP
​
primary
boolean
default:false

Whether the Pix key should be set as the primary pix key for the company

Example:

false

Response

Pix key created successfully

​
id
string
required

Pix key unique identifier

Example:

"a3dbd0c2-9f79-4f86-8caa-47779b3f2793"

​
affiliation_id
string
required

Affiliation ID associated with this PIX key

Example:

"a3dbd0c2-9f79-4f86-8caa-47779b3f2794"

​
company_id
string
required

Company ID that owns this PIX key

Example:

"a3dbd0c2-9f79-4f86-8caa-47779b3f2793"

​
key_type
enum<string>
required

The Pix key type

Available options:
EVP
Example:

"EVP"

​
key
string | null
required

The Pix key value (null for EVP keys before activation)

​
primary
boolean
required

Whether this is the primary PIX key for the company

Example:

true

​
status
enum<string>
required

The current status of the PIX key:

  • ACTIVE: Key is active and can be used
  • INACTIVE: Key is inactive
  • PENDING_DELETION: Key is marked for deletion
  • DELETED: Key has been deleted
Available options:
ACTIVE,
INACTIVE,
PENDING_DELETION,
DELETED
Example:

"ACTIVE"