Endpoint: GET /sales/seller/{seller_id}/checkoutlink/{checkoutlink_pk}/payments/
Autenticação: Bearer JWT ou chave de API do vendedor (TokenAuth)
Retorna os pagamentos vinculados a um link de checkout, do mais recente para o mais antigo. Cada registro combina um comprador (cliente da transacao) com uma ou mais transacoes; o status do registro resume as transacoes associadas:
  • waiting — nenhuma transacao foi associada.
  • mixed — existem multiplos status distintos de transacao para este registro (raro).
  • caso contrario — o status unico compartilhado por todas as transacoes deste registro, ex.: succeeded, failed, pending, pre_authorized, reversed, refunded, partial_refunded, dispute, charged_back.
Paginado (tamanho padrao 10, maximo 100).

Pre-requisitos

  • O Link de checkout deve existir.
  • O chamador precisa de vinculo de acesso para seller_id.

Parametros de caminho

string
required
UUID unificado da conta.
UUID do link de checkout ao qual estes pagamentos pertencem.

Parametros de consulta

integer
Numero da pagina (1-based).
integer
Tamanho da pagina, limitado a 100.

Resposta

Envelope padrao paginado.
integer
string | null
string | null
array
Lista de resumos de pagamento.
Cada pagamento:
string
UUID do pagamento.
object
Resumo do link de checkout pai: id, name, reference, amount, expiration_date.
object
Dados do comprador: name, email, phone_number, country_code.
string
Status agregado (ver lista acima).

Acao adicional: exportar relatorio

Um endpoint GET /sales/seller/{seller_id}/checkoutlink/{checkoutlink_pk}/payments/report/ existe para baixar os mesmos dados em csv, xlsx ou txt. Selecione o formato via cabecalho Accept (text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, text/plain) ou via parametro de consulta format. A resposta e transmitida com Content-Disposition: attachment; filename="<sell-name>_<timestamp>.<format>".

Erros

Exemplos