Documentação - Documentação

post https://betpay.iugu.com/api/v1/receive

Cria um QRCode Pix para o recebimento de valores.

Permissão necessária: betpay:payin.create

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Request

Headers
WORKSPACE_ID Type: string ID do workspace Ex: 1D81KhKbYuVq9505Bz4Nk9

Body

Content Type: application/json

amount

Required

Number

Valor a ser cobrado.

Ex: 10.0

payer_fiscal

String

Documento do pagador.

Ex: 12345678912

payer_name

String

Nome do pagador.

Ex: John Doe

external_id

String

Identificador da operação.

merchant_id

String

Identificador do estabelecimento.

Example

1
2
3
4
5
6
7
{
  "amount": 10.0,
  "payer_fiscal": "12345678912",
  "payer_name": "John Doe",
  "external_id": "<EXTERNAL_ID>",
  "merchant_id": "<MERCHANT_ID>"
}

Response

200

QRCode criado com sucesso

String

Código de identificação criado pela iugu

Ex: 16d8Tj4tFnLN6jySecOQBE

code

String

Copia e cola do qrcode gerado para recebimento

Ex: 00020101021226840014br.gov.bcb.pix2562qr.iugu.com/public/payload/v2/245EFECEF20048AAAA6087DD868CEBC052040000530398654041.005802BR5905TESTE6009SAO PAULO62070503***6304D5B9

Example

1
2
3
4
{
  "id": "16d8Tj4tFnLN6jySecOQBE",
  "code": "00020101021226840014br.gov.bcb.pix2562qr.iugu.com/public/payload/v2/245EFECEF20048AAAA6087DD868CEBC052040000530398654041.005802BR5905TESTE6009SAO PAULO62070503***6304D5B9"
}

400

Houve um erro na validação da requisição

message

String

Lista de erros que ocorreram na requisição

Ex: Campo chave é obrigatório

Example

1
2
3
{
  "message": "Campo chave é obrigatório"
}

Back

Lista restritiva e permissiva por ISPB

Forward

Busca operação de recebimento.