API v5 - Adição de arranjos no Balance Operation
Adição do novo tipo de Operação de Saldo
Com as mudanças referentes a Conta Digital Pagar.me e Mudanças de contrato de recebedores, iremos também adicionar um novo tipo de Operação de Saldo na resposta da rota de Obter histórico das operações. Essa adição é referente aos arranjos financeiros da conta.
Os arranjos serão indicados no tipo da operação com o campo type = external_settlement e possuem um movement_object próprio com nome settlement. Abaixo mais detalhes sobre o contrato do movement_object:
Especificação do objeto movement_object
movement_object| Campo | Tipo | Descrição |
|---|---|---|
object | string | Nome do objeto Valor retornado: settlement |
id | string | Identificador do arranjo. |
amount | int | Valor, em centavos, do arranjo. |
product | string | Tipo do pagamento realizado que gerou o arranjo. Valor retornado: credit, debit, boleto e anticipation |
card | string | Bandeira do cartão. |
payment_date | string | Dia e hora do pagamento. |
recipient_id | string | ID do recebedor referente ao arranjo. |
document_type | string | Tipo do documento. |
document | string | Número do documento do cliente. |
contract_obligation_id | string | Identificador do contrato. |
liquidation_arrangement_id | string | Identificador da liquidação do recebível. |
external_engine_payment_id | string | Identificador rastreável da liquidação |
{
"object": "balance_operation",
"id": 10009550600,
"status": "available",
"balance_amount": 0,
"balance_old_amount": null,
"type": "external_settlement",
"amount": 10000,
"fee": 0,
"created_at": "2023-08-14T18:27:30.512Z",
"movement_object": {
"object": "external_settlement",
"id": "sett_clll91wim1r8x0hlhrr0wgl00",
"amount": 10000,
"product": "credit",
"brand": "visa",
"payment_date": "2023-10-27T21:20:07Z",
"recipient_id": "re_cjb5gq2ux0gvrgn601uf1a00",
"document_type": "cnpj",
"document": "02357737000011",
"contract_obligation_id": null,
"liquidation_arrangement_id": "la_clfpt3ok7d5zb0iljz5rnns00",
"external_engine_payment_id": "202307190000796055619"
}
}
{
"object": "balance_operation",
"id": 10009550600,
"status": "available",
"balance_amount": 0,
"balance_old_amount": null,
"type": "external_settlement",
"amount": 10000,
"fee": 0,
"date_created": "2023-08-14T18:27:30.512Z",
"movement_object": {
"object": "external_settlement",
"id": "sett_clll91wim1r8x0hlhrr0wgl00",
"amount": 10000,
"product": "debit",
"brand": "visa",
"payment_date": "2023-08-21",
"recipient_id": "re_cjb5gq2ux0gvrgn601uf1a00",
"document_type": "cnpj",
"document": "02357737000011",
"contract_obligation_id": null,
"liquidation_arrangement_id": "la_clfpt3ok7d5zb0iljz5rnns00",
"external_engine_payment_id": "202307190000796055619"
}
}
{
"object": "balance_operation",
"id": 12070717057,
"status": "available",
"balance_amount": 0,
"balance_old_amount": null,
"type": "external_settlement",
"amount": 14500,
"fee": 0,
"date_created": "2024-01-29T03:01:08.121Z",
"movement_object": {
"object": "external_settlement",
"id": "sett_clrvbxr74zl090hmztbwmi5pv",
"product": "boleto",
"payment_date": "2024-01-29",
"document": "13648664000103",
"document_type": "cnpj",
"recipient_id": "re_clcuksz9j7dfe019tfn3whbfv",
"contract_obligation_id": null,
"liquidation_arrangement_id": "la_clrvbkygqyuag0ilo7jps0bfb",
"external_engine_payment_id": "a7144103-d5b7-4e9c-a049-15f2233195ce",
"amount": 14500,
"card": null
}
}
{
"object": "balance_operation",
"id": 12078931490,
"status": "available",
"balance_amount": 0,
"balance_old_amount": null,
"type": "external_settlement",
"amount": 156348,
"fee": 0,
"date_created": "2024-01-29T09:49:12.773Z",
"movement_object": {
"object": "external_settlement",
"id": "sett_clrxu5aj65sjw0imobth8oop",
"amount": 156348,
"liquidation_arrangement_id": "la_clrxtlznk4f320ilc2f8x9876",
"external_engine_payment_id": "202401290000264903000",
"product": "anticipation",
"brand": "mastercard",
"recipient_id": "re_cl5mxs5pq14lr0u9tmm75u000",
"document": "44104063000168",
"payment_date": "2024-01-29",
"document_type": "cnpj",
"contract_obligation_id": null
}
}