v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

List Payments

This API endpoint lists the payments in a workspace.<br> Filter can be applied on invoice ID to list a payment for a specific invoice.

get/v1/payments

Query parameters

invoiceIdstring

Unique ID of invoice

limitstring

Max number of records to fetch

nextTokenstring

Next token for pagination

Response

200

Example response

{
  "data": [
    {
      "id": "d0000000-d7a5-473d-a75b-9821a8f4e180",
      "object": "payment",
      "createdAt": "2024-02-21T15:31:16.789Z",
      "invoiceId": "inv_01HN4V8K5P7RNQJ6MGXKDZ8T2W",
      "status": "succeeded",
      "amount": 107635,
      "message": "payment_successful",
      "declineCode": "success",
      "paymentMethod": "creditCard",
      "last4Digits": "4242",
      "brand": "visa",
      "feeAmount": {
        "paidByPlatform": 2500
      }
    }
  ]
}