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
}
'
import requests

url = "https://api-sandbox.rinne.com.br/core/v1/pix/keys"

payload = {
    "provider": "CELCOIN",
    "key_type": "EVP",
    "primary": False
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({provider: 'CELCOIN', key_type: 'EVP', primary: false})
};

fetch('https://api-sandbox.rinne.com.br/core/v1/pix/keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.rinne.com.br/core/v1/pix/keys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'provider' => 'CELCOIN',
    'key_type' => 'EVP',
    'primary' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.rinne.com.br/core/v1/pix/keys"

	payload := strings.NewReader("{\n  \"provider\": \"CELCOIN\",\n  \"key_type\": \"EVP\",\n  \"primary\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api-sandbox.rinne.com.br/core/v1/pix/keys")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"CELCOIN\",\n  \"key_type\": \"EVP\",\n  \"primary\": false\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.rinne.com.br/core/v1/pix/keys")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider\": \"CELCOIN\",\n  \"key_type\": \"EVP\",\n  \"primary\": false\n}"

response = http.request(request)
puts response.read_body
{
  "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"
}
{
  "error": {
    "code": "AUTHORIZATION_ERROR",
    "message": "You need 'admin' permissions to access this resource",
    "status": 403,
    "path": "/companies",
    "timestamp": "2023-12-01T10:00:00.000Z",
    "requestId": "req_123456789"
  }
}

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,
CAPPTA
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"