GET
/
payment-links
curl --request GET \
  --url https://api.{gr4vy_id}.gr4vy.app/payment-links \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "8d3fe99b-1422-42e6-bbb3-932d95ae5f79",
      "type": "payment_link",
      "amount": 1299,
      "currency": "USD",
      "created_at": "2022-01-01T12:00:00+00:00",
      "updated_at": "2022-01-01T12:00:00+00:00",
      "expires_at": "2022-01-01T12:00:00+00:00",
      "status": "active",
      "external_identifier": "payment-link-123",
      "statement_descriptor": {
        "name": "GR4VY",
        "description": "Card payment",
        "city": "London",
        "country": "US",
        "phone_number": "+1234567890",
        "url": "www.gr4vy.com"
      },
      "locale": "en",
      "merchant_name": "Gr4vy",
      "merchant_url": "https://gr4vy.com",
      "merchant_banner_url": "https://gr4vy.com/banner.png",
      "merchant_color": "#FF0000",
      "merchant_message": "Thank you for shopping with us!",
      "merchant_terms_and_conditions_url": "https://gr4vy.com/terms",
      "merchant_favicon_url": "https://gr4vy.com/favicon.png",
      "country": "US",
      "intent": "authorize",
      "return_url": "https://gr4vy.com/return",
      "cart_items": [
        {
          "name": "GoPro HERO9 Camcorder",
          "quantity": 1,
          "unit_amount": 37999,
          "discount_amount": 0,
          "tax_amount": 0,
          "external_identifier": "item-789123",
          "sku": "sku-789123",
          "product_url": "https://example.com/items/gopro",
          "image_url": "https://example.com/images/items/gopro.png",
          "categories": [
            "<string>"
          ],
          "product_type": "physical"
        }
      ],
      "metadata": {
        "key": "value"
      },
      "payment_source": "recurring",
      "buyer": {
        "type": "buyer",
        "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
        "billing_details": {
          "type": "billing-details",
          "first_name": "John",
          "last_name": "Lunn",
          "email_address": "john@example.com",
          "phone_number": "+1234567890",
          "address": {
            "city": "London",
            "country": "GB",
            "postal_code": "789123",
            "state": "Greater London",
            "state_code": "GB-LND",
            "house_number_or_name": "10",
            "line1": "10 Oxford Street",
            "line2": "New Oxford Court",
            "organization": "Gr4vy"
          },
          "tax_id": {
            "value": "12345678931",
            "kind": "gb.vat"
          }
        },
        "display_name": "John L.",
        "external_identifier": "user-789123",
        "account_number": "1234567"
      },
      "shipping_details": {
        "type": "shipping-details",
        "id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",
        "buyer_id": "8724fd24-5489-4a5d-90fd-0604df7d3b83",
        "first_name": "John",
        "last_name": "Lunn",
        "email_address": "john@example.com",
        "phone_number": "+1234567890",
        "address": {
          "city": "London",
          "country": "GB",
          "postal_code": "789123",
          "state": "Greater London",
          "state_code": "GB-LND",
          "house_number_or_name": "10",
          "line1": "10 Oxford Street",
          "line2": "New Oxford Court",
          "organization": "Gr4vy"
        }
      }
    }
  ],
  "limit": 1,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": null
}

This endpoint requires the payment-links.read scope.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200
application/json
Returns a paginated list of payment links for an account.

A list of payment links.

​
items
object[]

A list of payment links.

​
limit
integer
default:
20

The limit applied to request. This represents the number of items that are at maximum returned by this request.

Required range: 1 < x < 100
​
next_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

Required string length: 1 - 1000
​
previous_cursor
string | null

The cursor that represents the next page of results. Use the cursor query parameter to fetch this page of items.

Required string length: 1 - 1000

Was this page helpful?

Suggest edits
Update fields for checkout sessionCreate payment link