Envio de aviso de pagamento
De RBX ISP - Manual do Usuário
O objetivo deste serviço é possibilitar a comunicação de pagamentos de títulos em aberto. Abaixo, segue exemplo do json de envio:
{
"send_payment_notification":
{
"document_id": 254875,
"payment_date": "2018-11-20",
"customer_id": 625,
"file":{
"name": "comprovante.pdf",
"data": "TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlz
IHNpbmd1bGFyIHBhc3Npb24gZnJvbSBvdGhlciBhbmltYWxzLCB3aGljaCBpcyBhIGx1c3Qgb2Yg
dGhlIG1pbmQsIHRoYXQgYnkgYSBwZXJzZXZlcmFuY2Ugb2YgZGVsaWdodCBpbiB0aGUgY29udGlu
dWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZGdlLCBleGNlZWRzIHRo
ZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4="
}
}
}
Detalhamento dos campos
ID | Campo | Obrigatório | Pai | Tipo | Observações |
A01 | Dados do boleto | Sim | Raiz | - | |
A02 | document_id | Sim | A01 | Número |
Id interno do boleto bancário |
A03 | payment_date | Não | A01 | Data |
Data de pagamento do boleto |
A04 | customer_id | Sim | A01 | Número |
Código do cliente |
B01 | file | Não | A01 | - |
Grupo de contém as informações do anexo |
B02 | name | Sim | B01 | Texto |
Nome do anexo com a extensão (por exemplo, meu_comprovante.pdf) |
B03 | data | Sim | B01 | Texto | Conteúdo do arquivo codificado em base64. |
Mensagem de retorno
Em caso de sucesso, será retornado um json conforme o exemplo abaixo:
{
"status": 1,
"error_code": 0,
"error_description": "",
"result": "Payment notification sent succesfuly!"
}
Em caso de falha, será retornado um json conforme o exemplo abaixo:
{
"status": 0,
"error_code": 19,
"error_description": "Attention: you cannot inform a future payment date!",
"result": ""
}