Criar Cobrança PIX Troco (CASH-IN)

Sumário

Descrição

Descrição #

Este passo tem por finalidade criar uma cobrança PIX troco.

Endpoints #

Produção: https://api2.bancosemear.com.br/paas-cashin-api/api/v1/public/billing-changes
Homologação: https://hmlapi2.bancosemear.com.br/paas-cashin-api/api/v1/public/billing-changes

Requisição (POST) #

Segue exemplo de requisição:

curl "https://hmlapi2.bancosemear.com.br/paas-cashin-api/api/v1/public/billing-changes" \
    --request POST \
    --header "Content-Type: application/json" \
    --header "client-cert: <CLIENT_CERT>" \
    --header "Authorization: Bearer <BEARER_TOKEN>" \
    --header "client_id: <CLIENT_ID>" \
    --header "access_token: <ACCESS_TOKEN>" \
    --data '
{
    "calendario":{
        "expiracao":3600
    },
    "devedor":{
        "nome":"Cidadão Silva de Oliveira",
        "cpf":"21356500056"
    },
    "valor": {
     "original": "20.00",
     "retirada": {
      "troco": {
        "valor": "10.00",
        "modalidadeAlteracao": 1,
        "modalidadeAgente": "AGTEC",
        "prestadorDoServicoDeSaque": "00795423"
      }
    }
   },
    "chave":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "infoAdicionais":[
        {
            "nome":"Infoadicional",
            "valor":"222"
        }
    ]
}'

Parâmetros de Requisição #

Cabeçalho #

Content-Type: Informa ao servidor de que o corpo da requisição possui o formato JSON
client-cert: Certificado usado para autenticar o usuário junto à aplicação
Authorization: Bearer token usado para autenticação de usuário (Recebido no passo “oAuth Aplicação“)
client_id: ID de cliente usado para encaminhar a requisição ao gateway de APIs
access_token: Token recebido após executar o método oAuth (Access Token)

Corpo (JSON) #

Propriedade	Descrição	Tipo	Obrigatoriedade
calendario.expiracao	Tempo de validade da requisição em Segundos. Valor padrão 86400 quando não passado.	Int32	Obrigatório
devedor.nome	Nome do devedor	String	Obrigatório
devedor.cpf ou devedor.cnpj	CPF do devedor ou CNPJ do devedor	String	Obrigatório
valor.original	Valor do pix para o parceiro (Deve ser maior que o valor do troco)	String	Obrigatório
valor.retirada.troco.valor	Valor para troco do CASH-IN(Deve ser menor que o valor original)	String	Obrigatório
valor.retirada.troco.modalidadeAlteracao	Valor 0 não permite alterar o valor de pagamento do PIX, valor 1 permite alterar o valor do pagamento. Valor padrão 0 quando não passado.	Int32	Obrigatório
valor.retirada.troco.modalidadeAgente	Agente de saque(A depender do tipo de contrato) (AGTEC, AGTOT, AGFSS)*	String	Obrigatório
valor.retirada.troco.prestadorDoServicoDeSaque	Facilitador de Serviço de Saque registrado.	String	Obrigatório
chave	Chave PIX de recebimento pertencente a conta do usuário recebedor	String	Obrigatório
infoAdicionais	Array de objetos para informações adicionais	Array	Opcional
infoAdicionais.nome	Usado para informações específicas (caso declare o objeto dentro do array, a propriedade se torna obrigatória)	String	Opcional
infoAdicionais.valor	Usado para informações específicas (caso declare o objeto dentro do array, a propriedade se torna obrigatória)	String	Opcional

Legenda
AGTEC: Agente de saque que seja estabelecimento comercial
AGTOT: Agente de saque que seja outra espécie de pessoa jurídica que tenha como atividade principal ou secundaria a prestação de serviços auxiliares a serviços financeiros ou afins ou correspondentes no pais.
AGFSS: Participante do PIX que facilita o serviço de saque diretamente

Resposta #

Segue exemplo de resposta:

{
    "calendario": {
        "expiracao": 3600,
        "criacao": "2024-05-15T11:20:24.0843525-03:00"
    },
    "valor": {
        "original": "20.00",
        "modalidadeAlteracao": 0,
        "retirada": {
            "troco": {
                "valor": "10.00",
                "modalidadeAlteracao": 1,
                "modalidadeAgente": "AGTEC",
                "prestadorDoServicoDeSaque": "00795423"
            }
        }
    },
    "correlationId": "d4c9e080-db19-4eff-b8fe-d34d9c2aa74a",
    "txid": "43sfav5ta9j3yrrbn4qgojifrh6guwrrzn4",
    "endToEnd": "",
    "status": "Pendente",
    "devedor": {
        "nome": "Cidadão Silva de Oliveira",
        "documento": "21356500056"
    },
    "chave": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "pixCopiaECola": "00020101021226920014BR.GOV.BCB.PIX2570spi-h.bancosemear.com.br/qrcode/gi/v2/493640e818a94920869fc9be37cbd7765204000053039865802BR5923XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX***6304180F",
    "qrCode": "iVBORw0KGgoAAAANSUhEUgAAAYEAAAGBAQAAAACoIjCJAAAF+ElEQVR4nO2bTY7qWgyEjRhkyBKyE9gYUiKxMdhJlpAhA8R5rq9OaLhXetIdtgUD1IRTDNz+KZd9ov3ja44v4ov4In4fYo2I3Tq1+/HQluF6eIz5cb/k03O0Z0xLu+W54ZoPhmKIqeWzPHfUt884j3FqlyW/2LeIwzze86OOtFYNcY4hPy7DbZ0WfbvEKf8a8ovxLqvJTGO7rTFWRTQf3i861wKneYY+pq2GqogMknsc0g/kJekqioVV/qLAyUgZSyIUH2mhds34CNlFkSJbpel2eS5/6jH+FVEVEORErPF/b39l0d+P6PUta4CT/j7rQtpKXhKqEC1d5SwH+aNyFkDMaQV9sXNSmPRX+NldhxM2jxk40+YlVRDKfyeFvQp9Bgk1QMX/8IgsDvqp9ggyZjFEvinrhQvBMf/Kj5O4DykjoEJNxotWDZHOn8/EAET9MhPmW1OZkG/kOTImVaMY4iEG8MNye5CklxAfSXvyL/3KT2YogxjtG+J6OiyyQyo4w4Gb8qRI0ZutaiDk/Kr7HCb1OR3uVPJvKgknccInnlMKkbbi/99jPx1keEJ15RsnM4A9xD/KIRQfM+WOxJgEN+2SLd4M4RMRVpl4t1UNhNJhM6Gnr83XMQkQydIdrg5nZsCmpRA0rZkJA7dwtRfXy6jIw02Jwo704gxFENYt0kwmvWZBtDdnF4J7b/Bjs1UZRA+DJsmCusCzNNOjJ4pX8iiGWN29h0U7JcFutWZEF3Vo9WshXALP+EbPhCeyhb6gBcjMsGDOoRhCrzV6pDxVEnZr72uVIkf6HmxVDEE6zEJAaOAbIIISSLjQ9iX3WYohHPYXcZ9JIlbXLNXY4RbKERSHHy+pgsjqZ4oTk62RhG9WIVALQDXg2VtmKIOwQgXrQ6BrNyu4dDZdvbTViiFmyTau+w2PQLGm0cFpMCcGK4aQmfRRIlZ4GCEBB70O9VJY6uCrr62DID6cHo6wIPkLrb66Hc3pgh9otRBS7mhfcZCjepwTh1Ucjkg52y9XQ1ysWmnwipnEfYDJOND9QLN0x1cJofrGmE1vIju0ueRJ9CuPYP/QLEsgLh45b7yudforltvaVgKZQbZaCGywGYJydz/ZVpOWLproIHLHuRoC7uNncD0tHKgukCh2vVaMH/FRBKG5C93sTQgyA6O3ZrnS2rV0zMerx6mC2BP7ZjwiOw2+i2hHmaDjMweuhnAhGPAXMQBEOzKhZzFaM/DCQS2E14n2MNrXElGXMO99y0KLJ1uKrISg5qmZ106RisNVtCek3fBREqb7nmIIKbMavd2sZP3MYbVPwzzqpecUQ8zucYgPMbwu1kit5acw4vBuqzoIkr7nLk/r1A8vCzKkoTgg3bdiiAvFf/GaARMYJcEIdukOjg8EjdcuThGE9cmZhQOJWAj2Ed62EdU19zm69a2EkHbD2Ikk6MygSHHzk6ZTikSsLoeg3GkqoyUiPWOJCL5LouhYzytKIeaA1zVPIzWFUgt/l6DB0oX2LZZN2SmFuLA2KAHnPPYhq9j/kSmUwmXbsnjLiTUQLE1Nr23w2VqGZ1RX79IxjpujGIJutpEZ5vAlEK2Qge1LlCoYn91dCURzU+NxK1SX9Sk0y543euDUQ0iZDQYUin2xepivRxXeRBhNeoshvCW13X3oSybkA/aq3OwNnzmxBEISzc0R0BkAYxhuvrBWxssXYYohGEHMFufd1968Fz5bpw4W6nZvm+RlEOrfvC7mjfjBF2EOiBwRJv7cfyuGoOZtk8cTWwfeC99brFZbP2LJcgj1b8132KRg+NoXS8HcfLH7xMaG6yB4rT9X+LgKMXHr4y1chrZ+3nYqgOj3vFT3H9x26tdZmVdcvV9ysabViiEmZjGNMKB7p88b2Cg7BpOLT6ZfBsEWTb8GcO9JIcwEWamSlPMxd66F8ODVayR9dZKGlw7XCu5LuSuGYI9Md3gxCRqepByqgQLnfR5VBTH5Di8sF92CIHG4cOOr70mfyyGUExujGZV8kzsJODrXLwk8RoY0xRD/9voivogv4tch/gMCWZ8IcZznPwAAAABJRU5ErkJggg==",
    "linkPagamento": "https://hml-semearpay.bancosemear.com.br/pay/pix/43sfav5ta9j3yrrbn4qgojifrh6guwrrzn4",
    "informacoesAdicionais": [
        {
            "nome": "Infoadicional",
            "valor": "222"
        }
    ],
    "revisao": 0
}

Parâmetros de Resposta #

Corpo (JSON) #

Propriedade	Descrição	Tipo
status	Status da cobrança: PENDENTE (indica que o registro se refere a uma cobrança que foi gerada mas ainda não foi paga nem removida).	String
calendario.expiracao	Tempo de validade da chave (em segundos).	int32
calendario.criacao	Data de criação da chave	DateTime
valor.original	Valor do CASH-IN(Sempre será maior que o valor do troco)	String
valor.modalidadeAlteracao	Valor 0 não permite alterar o valor de pagamento do PIX	int32
valor.retirada.troco.valor	Valor para troco do CASH-IN	String
valor.retirada.troco.modalidadeAlteracao	Valor 0 não permite alterar o valor de pagamento do PIX, valor 1 permite alterar o valor do pagamento. Valor padrão 0 quando não passado.	Int32
valor.retirada.troco.modalidadeAgente	Agente de troco(A depender do tipo de contrato) (AGTEC, AGTOT, AGFSS)*	String
valor.retirada.troco.prestadorDoServicoDeSaque	Facilitador de Serviço de Saque registrado.	String
correlationId	Identificador interno de referencia do pix	String
txid	ID da transação	String
endToEnd	EndToEnd da transação, gerado quando pix estiver com status PAGO	String
devedor.nome	Nome do devedor	String
devedor.documento	CPF do devedor ou CNPJ do devedor	String
chave	Chave PIX de recebimento	String
pixCopiaECola	Copia e cola referente ao PIX gerado	String
qrCode	Imagem PNG do código QR PIX codificado em base64	String
linkPagamento	Link de pagamento do PIX	String
informacoesAdicionais.nome	Nome opcional. Usado para informações específicas	String
informacoesAdicionais.valor	Valor opcional. Usado para informações específicas	String
revisao	Valor de vezes que pix foi revisado/alterado	Int32