Recuperar Detalhamento do Pagamento

Retorna a distribuição de um pagamento por tipo de evento (pagamentos, reembolsos, disputas, taxas, etc.) na moeda do pagamento.

GET /payouts/{payout_id}/breakup

JavaScript

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const breakups = await client.payouts.breakup.retrieve('payout_id');

console.log(breakups);

200

[
  {
    "event_type": "<string>",
    "total": 123
  }
]

Autorizações

Authorization · string · header · obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

payout_id · string · obrigatório

Id of the Payout to get breakup for

Resposta

200

application/json

Payout breakup by event type in payout currency

event_type · string · obrigatório

The type of balance ledger event (e.g., "payment", "refund", "dispute", "payment_fees").

total · integer<int64> · obrigatório

Total amount for this event type in the payout's currency (in smallest currency unit, e.g., cents).