Register recebedor profile

curl --request PUT \
  --url https://api.example.com/api/v1/brcode/recebedores/{chave} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "cep": "01310100",
  "cidade": "São Paulo",
  "ispbParticipante": "12345678",
  "logradouro": "Av. Paulista, 1000",
  "nome": "Lerian Studio LTDA",
  "uf": "SP",
  "cnpj": "12ABC34501DE35",
  "cpf": "12345678901",
  "nomeFantasia": "Lerian"
}
'

package main

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

func main() {

	url := "https://api.example.com/api/v1/brcode/recebedores/{chave}"

	payload := strings.NewReader("{\n  \"cep\": \"01310100\",\n  \"cidade\": \"São Paulo\",\n  \"ispbParticipante\": \"12345678\",\n  \"logradouro\": \"Av. Paulista, 1000\",\n  \"nome\": \"Lerian Studio LTDA\",\n  \"uf\": \"SP\",\n  \"cnpj\": \"12ABC34501DE35\",\n  \"cpf\": \"12345678901\",\n  \"nomeFantasia\": \"Lerian\"\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	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))

}

const options = {
  method: 'PUT',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    cep: '01310100',
    cidade: 'São Paulo',
    ispbParticipante: '12345678',
    logradouro: 'Av. Paulista, 1000',
    nome: 'Lerian Studio LTDA',
    uf: 'SP',
    cnpj: '12ABC34501DE35',
    cpf: '12345678901',
    nomeFantasia: 'Lerian'
  })
};

fetch('https://api.example.com/api/v1/brcode/recebedores/{chave}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/v1/brcode/recebedores/{chave}"

payload = {
    "cep": "01310100",
    "cidade": "São Paulo",
    "ispbParticipante": "12345678",
    "logradouro": "Av. Paulista, 1000",
    "nome": "Lerian Studio LTDA",
    "uf": "SP",
    "cnpj": "12ABC34501DE35",
    "cpf": "12345678901",
    "nomeFantasia": "Lerian"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "ispbParticipante": "<string>",
  "cep": "<string>",
  "cidade": "<string>",
  "cnpj": "<string>",
  "cpf": "<string>",
  "logradouro": "<string>",
  "nome": "<string>",
  "nomeFantasia": "<string>",
  "uf": "<string>"
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

PUT

api

brcode

recebedores

{chave}

curl --request PUT \
  --url https://api.example.com/api/v1/brcode/recebedores/{chave} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "cep": "01310100",
  "cidade": "São Paulo",
  "ispbParticipante": "12345678",
  "logradouro": "Av. Paulista, 1000",
  "nome": "Lerian Studio LTDA",
  "uf": "SP",
  "cnpj": "12ABC34501DE35",
  "cpf": "12345678901",
  "nomeFantasia": "Lerian"
}
'

package main

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

func main() {

	url := "https://api.example.com/api/v1/brcode/recebedores/{chave}"

	payload := strings.NewReader("{\n  \"cep\": \"01310100\",\n  \"cidade\": \"São Paulo\",\n  \"ispbParticipante\": \"12345678\",\n  \"logradouro\": \"Av. Paulista, 1000\",\n  \"nome\": \"Lerian Studio LTDA\",\n  \"uf\": \"SP\",\n  \"cnpj\": \"12ABC34501DE35\",\n  \"cpf\": \"12345678901\",\n  \"nomeFantasia\": \"Lerian\"\n}")

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

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	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))

}

const options = {
  method: 'PUT',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    cep: '01310100',
    cidade: 'São Paulo',
    ispbParticipante: '12345678',
    logradouro: 'Av. Paulista, 1000',
    nome: 'Lerian Studio LTDA',
    uf: 'SP',
    cnpj: '12ABC34501DE35',
    cpf: '12345678901',
    nomeFantasia: 'Lerian'
  })
};

fetch('https://api.example.com/api/v1/brcode/recebedores/{chave}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/v1/brcode/recebedores/{chave}"

payload = {
    "cep": "01310100",
    "cidade": "São Paulo",
    "ispbParticipante": "12345678",
    "logradouro": "Av. Paulista, 1000",
    "nome": "Lerian Studio LTDA",
    "uf": "SP",
    "cnpj": "12ABC34501DE35",
    "cpf": "12345678901",
    "nomeFantasia": "Lerian"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "ispbParticipante": "<string>",
  "cep": "<string>",
  "cidade": "<string>",
  "cnpj": "<string>",
  "cpf": "<string>",
  "logradouro": "<string>",
  "nome": "<string>",
  "nomeFantasia": "<string>",
  "uf": "<string>"
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency

string

obrigatório

Idempotency key, max 255 characters

Parâmetros de caminho

chave

string

obrigatório

Chave Pix (DICT) do recebedor, percent-encoded; até 77 caracteres após a decodificação.

Maximum string length: 231

Corpo

application/json

cep

string

obrigatório

CEP do recebedor (8 dígitos).

Maximum string length: 8

Exemplo:

"01310100"

cidade

string

obrigatório

Cidade do recebedor.

Maximum string length: 200

Exemplo:

"São Paulo"

ispbParticipante

string

obrigatório

ISPB (8 dígitos ou letras maiúsculas) de um participante liquidado por este rail que atende este recebedor.

Exemplo:

"12345678"

logradouro

string

obrigatório

Logradouro do recebedor.

Maximum string length: 200

Exemplo:

"Av. Paulista, 1000"

nome

string

obrigatório

Nome/razão social do recebedor.

Maximum string length: 200

Exemplo:

"Lerian Studio LTDA"

string

obrigatório

UF do recebedor (2 caracteres).

Maximum string length: 2

Exemplo:

"SP"

cnpj

string

CNPJ do recebedor (PJ). Mutuamente exclusivo com cpf.

Exemplo:

"12ABC34501DE35"

cpf

string

CPF do recebedor (PF). Mutuamente exclusivo com cnpj.

Exemplo:

"12345678901"

nomeFantasia

string

Nome fantasia do recebedor (PJ).

Maximum string length: 200

Exemplo:

"Lerian"

Resposta

ispbParticipante

string

obrigatório

ISPB (8 dígitos ou letras maiúsculas) do participante que atende este recebedor.

cep

string

CEP do recebedor.

Maximum string length: 8

cidade

string

Cidade do recebedor.

Maximum string length: 200

cnpj

string

CNPJ do recebedor (PJ).

cpf

string

CPF do recebedor (PF).

logradouro

string

Logradouro do recebedor.

Maximum string length: 200

nome

string

Nome/razão social do recebedor.

Maximum string length: 200

nomeFantasia

string

Nome fantasia do recebedor.

Maximum string length: 200

string

UF do recebedor.

Maximum string length: 2