API Reference
GuidesSuporteAPI Reference

Objeto-resposta Balance operation

Com este objeto você pode acompanhar todas as movimentações financeiras ocorridas em sua conta Pagar.me. Os possíveis objetos contidos em uma operação de saldo (Payable, Refund, Transfer, Anticipation, Fee collection e Settlement) são descritos nas seções subsequentes.

❗️

Atenção: Essa versão de API será descontinuada

Essa versão da API Pagar.me já não é mais atualizada e, em breve, deixará de funcionar. Para que sua loja possa vender sem problemas, você precisa realizar sua integração usando a versão mais recente da nossa API, a V5.

No canto superior esquerdo da tela é indicado qual versão da documentação você está vendo. Clique na seta onde indica a versão e altere para a V5 para acessar a documentação.

Se você já é cliente, precisa realizar obrigatoriamente a migração para a versão V5.

Em caso de dúvidas, basta entrar em contato com o nosso time de atendimento através do e-mail, enviando a sua dúvida para [email protected] e por telefone, ligando para 4004-1330. Se você já é cliente pode também entrar em contato através do chat dentro da sua Dashboard.

📘

Novo tipo de Operação de Saldo

Com a Conta Digital Pagar.me teremos um novo tipo de operação de saldo referente aos arranjos financeiros(external_settlement).

Os arranjos possuem um movement_object próprio com nome settlement.

PropriedadeDescrição
Object
Object		Nome do tipo do objeto criado/modificado.
Valor retornado: balance_operation
id
Number		Identificador da operação
status
String		Estado do saldo da conta.
Valores possíveis: waiting_funds, available e transferred
balance_amount
Number		Saldo atual da conta
type
String		O que gerou a movimentação.
Valores possíveis: payable, refund, anticipation, transfer , fee_collection ou external_settlement
amount
Number		Valor transacionado para a conta
fee
Number		Taxa cobrada pela transação
date_created
String		Data da movimentação
movement_object
Object		Objeto da origem da movimentação
{
    "object": "balance_operation",
    "id": 2499868,
    "status": "available",
    "type": "payable",
    "amount": 30000,
    "fee": 115,
    "date_created": "2017-08-03T18:20:54.464Z",
    "movement_object": {
        "object": "payable",
        "id": 1966185,
        "status": "paid",
        "amount": 30000,
        "fee": 115,
        "anticipation_fee": 0,
        "installment": 3,
        "transaction_id": 1785141,
        "split_rule_id": null,
        "bulk_anticipation_id": null,
        "recipient_id": "re_cj5idth9i00lc8c6elbeiayhs",
        "payment_date": "2017-03-03T03:00:00.000Z",
        "original_payment_date": null,
        "type": "credit",
        "payment_method": "credit_card",
        "accrual_date": null,
        "date_created": "2017-04-03T18:20:54.457Z"
    }
}