Recuperar transações via API.

GET 
/paymentlink/:payment_link_id/transactions

Recuperar transações via API.

Request

Path Parameters

payment_link_id stringrequired
ID link de pagamento
Example: 66a2dc04-6fcc-3a66-b570-ea367d7df281

Query Parameters

page integer
Página para consulta.
Example: 1
perPage integer
Quantidade de itens por página para consulta.
Example: 10
startDate string
Data inicial para consulta.
Example: 2025-04-13
endDate string
Data final para consulta.
Example: 2025-04-14
status string
Possible values: [DENIED, PAYED, AUTHORIZED, PENDING, CANCELLED, PARTREFUNDED, REFUNDED]
Status da transação.
Example: PAYED

Header Parameters

Authorization stringrequired
Token de autenticação.
Example: Bearer <token>

Responses

200

Sucesso ao recuperar transações.

application/json

Schema

Schema

originId string

Identificador da cobrança

transactions array

Transações associadas a cobrança

perPage integer

Quantidade de itens por página

currentPage integer

Página atual

nextPage stringnullable

Endereço para a próxima página

previousPage stringnullable

Endereço para a página anterior

Example (from schema)

{
  "originId": "66a2dc04-6fcc-3a66-b570-ea367d7df281",
  "transactions": [
    {
      "transactionId": "afd2901c-db02-3fda-bba4-30023baeb2a2",
      "status": "REFUNDED",
      "amount": 1000,
      "createdAt": "2025-04-15 09:47:19",
      "updatedAt": "2025-04-15 09:47:19"
    },
    {
      "transactionId": "b00389d2-e532-3f0e-8935-f24bb855983f",
      "status": "PAYED",
      "amount": 1000,
      "createdAt": "2025-04-15 09:44:10",
      "updatedAt": "2025-04-15 09:44:10"
    }
  ],
  "perPage": 10,
  "currentPage": 1,
  "nextPage": "http://api.picpay.com/v1/paymentlink/66a2dc04-6fcc-3a66-b570-ea367d7df281/transactions?page=2",
  "previousPage": "http://api.picpay.com/v1/paymentlink/66a2dc04-6fcc-3a66-b570-ea367d7df281/transactions?page=1"
}

Example

{
  "originId": "66a2dc04-6fcc-3a66-b570-ea367d7df281",
  "transactions": [
    {
      "id": "afd2901c-db02-3fda-bba4-30023baeb2a2",
      "status": "PAYED",
      "amount": 400,
      "createdAt": "2025-04-13 13:12:55",
      "updatedAt": "2025-04-15 13:12:55"
    }
  ],
  "perPage": 10,
  "currentPage": 1,
  "nextPage": null
}

404

Cobrança não encontrada.

application/json

Schema

Schema

any

Example (from schema)

{}

Example

{}

500

Erro ao buscar as transações.

application/json

Schema

Schema

error

message string

Mensagem de erro

Example (from schema)

{
  "error": {
    "message": "Erro ao buscar transações."
  }
}

Example

{
  "error": {
    "message": "Erro ao buscar transações."
  }
}

Loading...