O saldo da conta Pagar.me é determinado pelos recebíveis, que são representados pela entidade de Payables e refletem o compromisso de pagamento do Pagar.me com seus clientes. Dessa forma, cada recebível contribui para aumentar ou diminuir o saldo total da conta Pagar.me.
Existem 5 tipos de recebíveis no Pagar.me, são eles:
| Tipo do payable | Descrição | Impacto no saldo do recebedor |
|---|---|---|
| credit | O recebível que irá adicionar saldo à conta do recebedor. | + |
| refund | Recebível referente a uma cobrança estornada. | - |
| refund_reversal | Referente de um estorno revertido. Só existe para transações de boleto. | + |
| chargeback | Recebível referente a um chargeback. | - |
| chargeback_refund | Referente a um chargeback com reapresentação ganha. | + |
Objeto payable:
| Atributos | Tipo | Descrição |
|---|---|---|
| id | Long | Identificador do recebível. |
| status | String | Estado atual do recebível. Valores possíveis: waiting_funds, prepaid, paid. |
| amount | Int | Valor em centavos do recebível. |
| fee | Int | Valor em centavos que foi cobrado (taxa). |
| anticipation_fee | Int | Valor em centavos que foi cobrado pela respectiva antecipação (caso criada). |
| fraud_coverage_fee | Int | Taxa de cobertura do Antifraude |
| installment | Int | Número da parcela. |
| gateway_id | Numeric | Identificador da cobrança no gateway de pagamento. Contém o identificador da transação da API v4. |
| charge_id | String | Identificador da cobrança que gerou o recebível. |
| split_id | String | Identificador da regra de split do recebível. |
| bulk_anticipation_id | String | Identificador da antecipação deste recebível, caso tenha sido criada. |
| anticipation_id | String | Identificador da antecipação. |
| recipient_id | String | Identificador do recebedor a qual este recebível pertence. |
| originator_model | String | Para recebíveis gerados por operações diferentes de transações, como estornos, será preenchido com o tipo de operação que originou esse recebível. Valores possíveis: refund e chargeback. |
| originator_model_id | String | Caso o campo originator_model esteja preenchido, o id respectivo daquele model estará presente nesse campo. |
| payment_date | Datetime | Dia e hora do pagamento. |
| original_payment_date | Datetime | Dia de hora de pagamento originais do recebível. |
| type | String | Tipo do recebível. Valores possíveis: credit, refund, refund_reversal, chargeback, chargeback_refund. |
| payment_method | String | Tipo de pagamento da transação. |
| accrual_at | Datetime | Data em que o banco emissor reconheceu o pagamento da transação a que este recebível pertence. |
| created_at | Datetime | Data da criação do objeto recebível. |
| liquidation_arrangement_id | String | Identificador da liquidação do recebível. |
Observação sobre o identificador da cobrança
O campo charge_id somente será indicado em cobranças geradas a partir do dia 01 de Julho de 2023.
Recebíveis referentes a cobranças geradas antes deste dia não terão o campo de charge_id no contrato de resposta.