Sign in

v1

latestOpenAPI 3.1.02026-07-24750514.9 KB

Listar pagamentos

get/payments

Query parameters

offsetinteger

Número da página que deseja consultar. Deve ser um valor igual ou maior que zero, representando o deslocamento da página desejada.

limitinteger

Tamanho da página desejada. Este valor determina a quantidade de resultados a serem retornados em uma única consulta.

status'APPROVED' | 'DENIED' | 'IN_ANALYSIS' | 'PENDING' | 'REFUNDED' | 'UNPAID'

Status do pagamento que deseja consultar. <br/>Valores permitidos: <small><br/>- APPROVED <br/>- DENIED <br/>- IN_ANALYSIS <br/>- PENDING <br/>- REFUNDED <br/>- UNPAID</small>

created_at_startstring date

Data de início do intervalo de busca. Exemplo: 2000-12-20

created_at_endstring date

Data final do intervalo de busca. Exemplo: 2000-12-20

payment_method_typestring

Lista das formas de pagamento da assinatura que devem ser retornadas. Não adicione espaço entre os item da lista. Opções disponíveis: <br/>- BOLETO<br/>- CREDIT_CARD<br/> Exemplo: BOLETO,CREDIT_CARD

Headers

Authorizationstring required

Token de autenticação. Deve ser enviado no formato Bearer <token>.

qstring

Campo de busca de pagamentos. Forneça apenas uma das seguintes informações: <br/>- Nome do assinante. <br/>- id do assinante. <br/>- E-mail do assinante.

Response

200

Example response

{
  "result_set": {
    "total": 1
  },
  "payments": [
    {
      "id": "PAYM_6D96F997-EDCE-4D14-8AC0-A11CE7CA539A",
      "invoice": {
        "id": "INVO_F933C729-F68A-44E3-82ED-9CE380D3C4ED",
        "amount": {
          "value": 1000,
          "currency": "BRL"
        }
      },
      "created_at": "2022-06-09T10:28:20.525781-03:00",
      "updated_at": "2022-06-09T10:28:20.525789-03:00",
      "customer": {
        "id": "CUST_2E9290E4-8149-4AEE-8A6B-F04055EFCEA1",
        "name": "Novo Nome do seu cliente",
        "email": "novo.email.do.cliente@empresa.com.br"
      },
      "payment_method": {
        "type": "CREDIT_CARD",
        "card": {
          "token": "TOKE_BEF65005-C30B-4527-B2B0-43C4A9419F41",
          "brand": "visa",
          "first_digits": "412536",
          "last_digits": "3452",
          "exp_month": "12",
          "exp_year": "2043",
          "holder": {
            "name": "Novo cartão gerando"
          }
        }
      },
      "status": "DENIED",
      "provider": {
        "name": "PAGSEGURO",
        "transaction_id": "CHARGE_SANDBOX_ID",
        "code": "A01",
        "message": "Não autorizado pelo emissor"
      },
      "links": [
        {
          "rel": "SELF",
          "href": "http://sandbox.api.assinaturas.pagseguro.com/payments/PAYM_6D96F997-EDCE-4D14-8AC0-A11CE7CA539A",
          "media": "application/json",
          "type": "GET"
        }
      ]
    }
  ]
}