PIX-IN

Receber um pagamento

 Importante

A requisição a seguir tem como objetivo gerar um QrCode juntamente com Pix copia e cola.

Split: envie o campo split (opcional) para dividir o valor do depósito entre recebedores. Cada item deve conter receiver_clientId e percent. A soma dos percentuais não pode ultrapassar 100%.

Requisição

* Campos obrigatórios e split opcional

Sem split

{
    "token": "TOKEN",
    "secret": "SECRET",
    "amount": 10,
    "debtor_name": "Fulano de tal",
    "email": "fulano@gmail.com",
    "debtor_document_number": "12345678911",
    "phone": "11900000000",
    "method_pay": "pix",
    "postback": "https:\/\/seudominio.com\/callback\/deposit"
}

Com split

{
    "token": "TOKEN",
    "secret": "SECRET",
    "amount": 10,
    "debtor_name": "Fulano de tal",
    "email": "fulano@gmail.com",
    "debtor_document_number": "12345678911",
    "phone": "11900000000",
    "method_pay": "pix",
    "postback": "https:\/\/seudominio.com\/callback\/deposit",
    "split": [
        {
            "receiver_clientId": "CLIENT_ID_RECEBEDOR_1",
            "percent": 10
        },
        {
            "receiver_clientId": "CLIENT_ID_RECEBEDOR_2",
            "percent": 5.5
        }
    ]
}

Resposta

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo. 
{
    "idTransaction": "ID DA TRANSAÇÃO",
    "qrcode": "00020126330014br.gov.bcb.pix01111335366962052040000530398654040.805802BR5919NOME6014CIDADE62580520LKH2021102118215467250300017br.gov.bcb.brcode01051.0.063044D24",
    "qr_code_image_url": "base64data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAApgAAAKYB3X3..."
}
{
    "error": "Token ou Secret ausentes",
    "message": "Você precisa fornecer tanto o token quanto o secret."
}
{
    "required": "Este campo é obrigatório",
    "string": "Este campo deve ser uma string",
    "email": "O campo deve ser um e-mail válido"
}