PApagar

Retornando pagamentos

Changed on

Retorna um Array contendo objetos de pagamentos (settlements) de um recebedor ordenados a partir da data de criação colocando os mais recentes no topo.

get/settlements

Request

  • Base URL
    https://api.pagar.me/core/v5
  • URL
    https://api.pagar.me/core/v5/settlements
  • Auth
    HTTP basic

Query parameters

payment_date_startstring required

Início da data de pagamento. Data no formato YYYY-MM-DD

payment_date_endstring required

Fim da data de pagamento. Data no formato YYYY-MM-DD

liquidation_arrangement_idstring

ID da LiquidationArrangement

pageinteger

Número da página

limitinteger

Limite de itens por página. Valor máximo = 2000

get_ispbboolean

Se retorna ou não os dados de ISPB das Settlements

liquidation_arrangement_idstring

ID da LiquidationArrangement para filtrar

settlement_idstring

ID da Settlement para usar como base. O ID da LiquidationArrangement desta Settlement será utilizado como filtro. Sobrescreve o parâmetro liquidation_arrangement_id

external_engine_payment_idstring

ID do motor de liquidação utilizado internamente

orderstring

Ordernar pela criação da Settlement crescente ou decrescente. String asc ou desc

Response

200

object required

Changes

  • ef323290c0ffRevision changes
    • warning

      deleted the query request parameter liquidation_arrangement_id

    • info

      added the new optional query request parameter liquidation_arrangement_id