Criar cobrança PIX

POST

api

pix

Criar cobrança PIX

curl --request POST \
  --url https://sandboxapi.mycredit.com.br/api/pix \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "formaPagamento": {
    "tpTransacao": 11,
    "idFaturaPag": "9b041599-eacc-4a0f-9a16-e0191c9a66AA",
    "modPagamento": 18,
    "qtdParcelas": 1,
    "valorPagamento": 1.29
  },
  "cliente": {
    "xNome": "Nome do pagador",
    "documento": "99999999999"
  }
}
'

{
  "sucesso": true,
  "data": {
    "retTexto": "Inserido com sucesso.",
    "retUrl": "00020101021226990014br.gov.bcb.pix2577pix.bpp.com.br/23114447/qrs2/v2/02bQN4pZi9ZfA841zm0obUq0xDJ4kK5kebEiF8e2iGr1G52040000530398654041.005802BR5924SATURNIA TECNOLOGIA LTDA6009SAO PAUL062070503***63044F29",
    "transacaoId": "9f8b4c46-82cd-4388-52b4-08dddfd74ba1",
    "expira": "2025-08-20T11:29:24.4187003Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Dados da cobrança PIX imediata

formaPagamento

object

required

Configurações da forma de pagamento

Show child attributes

formaPagamento.tpTransacao

integer

Tipo de transação (11 para PIX)

Example:

11

formaPagamento.idFaturaPag

string

Identificador da fatura de pagamento (UUID) gerado por sua aplicação para identificar a cobrança PIX em nossa plataforma. Este é o identificador que você utilizará na consulta do status da cobrança.

Example:

"9b041599-eacc-4a0f-9a16-e0191c9a66AA"

formaPagamento.modPagamento

integer

Modalidade de pagamento (18 para PIX)

Example:

18

formaPagamento.qtdParcelas

integer

Quantidade de parcelas (1 para PIX)

Example:

1

formaPagamento.valorPagamento

number

Valor do pagamento em reais

Required range: x >= 0.01

Example:

1.29

cliente

object

Dados do cliente

Show child attributes

cliente.xNome

string

required

Nome completo do cliente

Example:

"Nome do pagador"

cliente.documento

string

required

CPF/CNPJ do cliente

Example:

"99999999999"

Response

Cobrança PIX criada com sucesso

sucesso

boolean

Indica se a operação foi executada com sucesso

Example:

true

data

object

Dados da cobrança PIX criada

Show child attributes

data.retTexto

string

Mensagem de retorno da operação

Example:

"Inserido com sucesso."

data.retUrl

string

Payload BR Code para pagamento PIX (código PIX Copia e Cola)

Example:

"00020101021226990014br.gov.bcb.pix2577pix.bpp.com.br/23114447/qrs2/v2/02bQN4pZi9ZfA841zm0obUq0xDJ4kK5kebEiF8e2iGr1G52040000530398654041.005802BR5924SATURNIA TECNOLOGIA LTDA6009SAO PAUL062070503***63044F29"

data.transacaoId

string

Identificador único da transação PIX

Example:

"9f8b4c46-82cd-4388-52b4-08dddfd74ba1"

data.expira

string<date-time>

Data e hora de expiração do QR Code PIX

Example:

"2025-08-20T11:29:24.4187003Z"

Consultar cobrança PIXConsulta o status de uma cobrança PIX específica usando o ID da fatura de pagamento. Retorna sucesso=true para PIXs pagados e sucesso=false com status 410 para PIXs pendentes.

⌘I

Criar cobrança PIX

curl --request POST \
  --url https://sandboxapi.mycredit.com.br/api/pix \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "formaPagamento": {
    "tpTransacao": 11,
    "idFaturaPag": "9b041599-eacc-4a0f-9a16-e0191c9a66AA",
    "modPagamento": 18,
    "qtdParcelas": 1,
    "valorPagamento": 1.29
  },
  "cliente": {
    "xNome": "Nome do pagador",
    "documento": "99999999999"
  }
}
'

{
  "sucesso": true,
  "data": {
    "retTexto": "Inserido com sucesso.",
    "retUrl": "00020101021226990014br.gov.bcb.pix2577pix.bpp.com.br/23114447/qrs2/v2/02bQN4pZi9ZfA841zm0obUq0xDJ4kK5kebEiF8e2iGr1G52040000530398654041.005802BR5924SATURNIA TECNOLOGIA LTDA6009SAO PAUL062070503***63044F29",
    "transacaoId": "9f8b4c46-82cd-4388-52b4-08dddfd74ba1",
    "expira": "2025-08-20T11:29:24.4187003Z"
  }
}

Para desenvolvedores

PIX

Crédito de clientes

Webhooks

Criar cobrança PIX

Authorizations

Body

Response