Create immediate charge (idempotent txid)
curl --request PUT \
--url https://spi.sandbox.lerian.net/api/v1/brcode/cob/{txid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Idempotency: <x-idempotency>' \
--data '
{
"calendario": {
"expiracao": 3600
},
"chave": "pix@lerian.studio",
"valor": {
"original": "250.00",
"modalidadeAlteracao": 0,
"retirada": {}
},
"devedor": {
"cpf": "12345678901",
"nome": "Fulano de Tal",
"cep": "<string>",
"cidade": "<string>",
"cnpj": "12ABC34501DE35",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"infoAdicionais": [
{
"nome": "<string>",
"valor": "<string>"
}
],
"loc": {
"id": 2
},
"solicitacaoPagador": "<string>"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://spi.sandbox.lerian.net/api/v1/brcode/cob/{txid}"
payload := strings.NewReader("{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"chave\": \"pix@lerian.studio\",\n \"valor\": {\n \"original\": \"250.00\",\n \"modalidadeAlteracao\": 0,\n \"retirada\": {}\n },\n \"devedor\": {\n \"cpf\": \"12345678901\",\n \"nome\": \"Fulano de Tal\",\n \"cep\": \"<string>\",\n \"cidade\": \"<string>\",\n \"cnpj\": \"12ABC34501DE35\",\n \"email\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"uf\": \"<string>\"\n },\n \"infoAdicionais\": [\n {\n \"nome\": \"<string>\",\n \"valor\": \"<string>\"\n }\n ],\n \"loc\": {\n \"id\": 2\n },\n \"solicitacaoPagador\": \"<string>\"\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({
calendario: {expiracao: 3600},
chave: 'pix@lerian.studio',
valor: {original: '250.00', modalidadeAlteracao: 0, retirada: {}},
devedor: {
cpf: '12345678901',
nome: 'Fulano de Tal',
cep: '<string>',
cidade: '<string>',
cnpj: '12ABC34501DE35',
email: '<string>',
logradouro: '<string>',
uf: '<string>'
},
infoAdicionais: [{nome: '<string>', valor: '<string>'}],
loc: {id: 2},
solicitacaoPagador: '<string>'
})
};
fetch('https://spi.sandbox.lerian.net/api/v1/brcode/cob/{txid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://spi.sandbox.lerian.net/api/v1/brcode/cob/{txid}"
payload = {
"calendario": { "expiracao": 3600 },
"chave": "pix@lerian.studio",
"valor": {
"original": "250.00",
"modalidadeAlteracao": 0,
"retirada": {}
},
"devedor": {
"cpf": "12345678901",
"nome": "Fulano de Tal",
"cep": "<string>",
"cidade": "<string>",
"cnpj": "12ABC34501DE35",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"infoAdicionais": [
{
"nome": "<string>",
"valor": "<string>"
}
],
"loc": { "id": 2 },
"solicitacaoPagador": "<string>"
}
headers = {
"X-Idempotency": "<x-idempotency>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"calendario": {
"criacao": "<string>",
"expiracao": 123
},
"chave": "<string>",
"revisao": 123,
"status": "ATIVA",
"txid": "<string>",
"valor": {
"original": "250.00",
"modalidadeAlteracao": 0,
"retirada": {
"saque": {
"modalidadeAgente": "AGPSS",
"prestadorDoServicoDeSaque": "12345678",
"valor": "5.00",
"modalidadeAlteracao": 0
},
"troco": {
"modalidadeAgente": "AGPSS",
"prestadorDoServicoDeSaque": "12345678",
"valor": "5.00",
"modalidadeAlteracao": 0
}
}
},
"devedor": {
"cpf": "12345678901",
"nome": "Fulano de Tal",
"cep": "<string>",
"cidade": "<string>",
"cnpj": "12ABC34501DE35",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"infoAdicionais": [
{
"nome": "<string>",
"valor": "<string>"
}
],
"loc": {
"criacao": "<string>",
"id": 123,
"tipoCob": "cob",
"location": "<string>"
},
"location": "<string>",
"pixCopiaECola": "<string>",
"solicitacaoPagador": "<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"
}
}{
"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"
}
}Create immediate charge (idempotent txid)
Creates an immediate charge (Cob) identified by the path txid (idempotent). Pix API v2.9 PUT /cob/.
PUT
/
api
/
v1
/
brcode
/
cob
/
{txid}
Create immediate charge (idempotent txid)
curl --request PUT \
--url https://spi.sandbox.lerian.net/api/v1/brcode/cob/{txid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Idempotency: <x-idempotency>' \
--data '
{
"calendario": {
"expiracao": 3600
},
"chave": "pix@lerian.studio",
"valor": {
"original": "250.00",
"modalidadeAlteracao": 0,
"retirada": {}
},
"devedor": {
"cpf": "12345678901",
"nome": "Fulano de Tal",
"cep": "<string>",
"cidade": "<string>",
"cnpj": "12ABC34501DE35",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"infoAdicionais": [
{
"nome": "<string>",
"valor": "<string>"
}
],
"loc": {
"id": 2
},
"solicitacaoPagador": "<string>"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://spi.sandbox.lerian.net/api/v1/brcode/cob/{txid}"
payload := strings.NewReader("{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"chave\": \"pix@lerian.studio\",\n \"valor\": {\n \"original\": \"250.00\",\n \"modalidadeAlteracao\": 0,\n \"retirada\": {}\n },\n \"devedor\": {\n \"cpf\": \"12345678901\",\n \"nome\": \"Fulano de Tal\",\n \"cep\": \"<string>\",\n \"cidade\": \"<string>\",\n \"cnpj\": \"12ABC34501DE35\",\n \"email\": \"<string>\",\n \"logradouro\": \"<string>\",\n \"uf\": \"<string>\"\n },\n \"infoAdicionais\": [\n {\n \"nome\": \"<string>\",\n \"valor\": \"<string>\"\n }\n ],\n \"loc\": {\n \"id\": 2\n },\n \"solicitacaoPagador\": \"<string>\"\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({
calendario: {expiracao: 3600},
chave: 'pix@lerian.studio',
valor: {original: '250.00', modalidadeAlteracao: 0, retirada: {}},
devedor: {
cpf: '12345678901',
nome: 'Fulano de Tal',
cep: '<string>',
cidade: '<string>',
cnpj: '12ABC34501DE35',
email: '<string>',
logradouro: '<string>',
uf: '<string>'
},
infoAdicionais: [{nome: '<string>', valor: '<string>'}],
loc: {id: 2},
solicitacaoPagador: '<string>'
})
};
fetch('https://spi.sandbox.lerian.net/api/v1/brcode/cob/{txid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://spi.sandbox.lerian.net/api/v1/brcode/cob/{txid}"
payload = {
"calendario": { "expiracao": 3600 },
"chave": "pix@lerian.studio",
"valor": {
"original": "250.00",
"modalidadeAlteracao": 0,
"retirada": {}
},
"devedor": {
"cpf": "12345678901",
"nome": "Fulano de Tal",
"cep": "<string>",
"cidade": "<string>",
"cnpj": "12ABC34501DE35",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"infoAdicionais": [
{
"nome": "<string>",
"valor": "<string>"
}
],
"loc": { "id": 2 },
"solicitacaoPagador": "<string>"
}
headers = {
"X-Idempotency": "<x-idempotency>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"calendario": {
"criacao": "<string>",
"expiracao": 123
},
"chave": "<string>",
"revisao": 123,
"status": "ATIVA",
"txid": "<string>",
"valor": {
"original": "250.00",
"modalidadeAlteracao": 0,
"retirada": {
"saque": {
"modalidadeAgente": "AGPSS",
"prestadorDoServicoDeSaque": "12345678",
"valor": "5.00",
"modalidadeAlteracao": 0
},
"troco": {
"modalidadeAgente": "AGPSS",
"prestadorDoServicoDeSaque": "12345678",
"valor": "5.00",
"modalidadeAlteracao": 0
}
}
},
"devedor": {
"cpf": "12345678901",
"nome": "Fulano de Tal",
"cep": "<string>",
"cidade": "<string>",
"cnpj": "12ABC34501DE35",
"email": "<string>",
"logradouro": "<string>",
"uf": "<string>"
},
"infoAdicionais": [
{
"nome": "<string>",
"valor": "<string>"
}
],
"loc": {
"criacao": "<string>",
"id": 123,
"tipoCob": "cob",
"location": "<string>"
},
"location": "<string>",
"pixCopiaECola": "<string>",
"solicitacaoPagador": "<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"
}
}{
"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"
}
}Autorizaciones
JWT bearer token issued by the identity provider.
Encabezados
Idempotency key, max 255 characters.
Parámetros de ruta
Identificador da transação [a-zA-Z0-9]{26,35}.
Cuerpo
application/json
Controle de tempo da cobrança.
Show child attributes
Show child attributes
Chave DICT do recebedor.
Maximum string length:
77Ejemplo:
"pix@lerian.studio"
Valores monetários da cobrança.
Show child attributes
Show child attributes
Devedor da cobrança (PF/PJ, opcional).
- Pessoa Física
- Pessoa Jurídica
Show child attributes
Show child attributes
Informações adicionais (máx 50).
Maximum array length:
50Show child attributes
Show child attributes
Referência de location.
Show child attributes
Show child attributes
Texto livre apresentado ao pagador.
Maximum string length:
140Respuesta
Created
Show child attributes
Show child attributes
Chave DICT do recebedor.
Maximum string length:
77Revisão da cobrança (inicia em 0).
Status do registro da cobrança.
Opciones disponibles:
ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP Identificador da transação.
Pattern:
[a-zA-Z0-9]{26,35}Show child attributes
Show child attributes
- Pessoa Física
- Pessoa Jurídica
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Localização do payload.
Maximum string length:
77Pix Copia e Cola (BR Code) correspondente à cobrança.
Maximum string length:
512Maximum string length:
140¿Esta página le ayudó?