v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB

Payment Links

List Payment Link Usages

Returns a paginated list of usages for a given payment link.

get/payment-links/v1/{payment_link_id}/usages

Path parameters

payment_link_idstring uuid required

Example:d290f1ee-6c54-4b01-90e6-d701748f0851

The unique identifier of the payment link.

Query parameters

pageinteger

The page you're requesting - returns page 0 of a response if not specified.

sizeinteger

The number of objects you want to return as a page size.

Response

Paginated list of payment link usages returned.

Example response

{
  "content": [
    {
      "usage_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "payment_link_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "usage_status": "PAYMENT_CREATED",
      "customer_id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
      "payment_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "payment_status": "PENDING",
      "identifiers": [
        {
          "display_label": "Email address",
          "value": "payer@example.com"
        }
      ]
    }
  ]
}