GET
/
payment-links
/
{payment_link_id}
curl --request GET \
  --url https://api.{id}.gr4vy.app/payment-links/{payment_link_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "type": "payment-link",
  "url": "https://example.com/link/a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "expires_at": "2024-06-01T00:00:00.000Z",
  "external_identifier": "external-12345",
  "statement_descriptor": {
    "name": "ACME",
    "description": "ACME San Jose Electronics",
    "city": "San Jose",
    "country": "US",
    "phone_number": "+1234567890",
    "url": "www.example.com"
  },
  "locale": "en",
  "merchant_name": "ACME Inc.",
  "merchant_url": "https://merchant.example.com",
  "merchant_banner_url": "https://merchant.example.com/banner.png",
  "merchant_color": "#FF5733",
  "merchant_message": "Thank you for your purchase!",
  "merchant_terms_and_conditions_url": "https://merchant.example.com/terms",
  "merchant_favicon_url": "https://merchant.example.com/favicon.ico",
  "amount": 1299,
  "country": "DE",
  "currency": "EUR",
  "intent": "authorize",
  "return_url": "https://merchant.example.com/return",
  "cart_items": [
    {
      "amount": {
        "currency": "USD",
        "value": 500
      },
      "name": "Widget",
      "quantity": 2
    }
  ],
  "metadata": {
    "order_id": "ORD-12345"
  },
  "payment_source": "ecommerce",
  "created_at": "2024-05-30T12:34:56.000Z",
  "updated_at": "2024-05-30T13:00:00.000Z",
  "status": "active",
  "buyer": {
    "type": "buyer",
    "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
    "display_name": "John Doe",
    "external_identifier": "buyer-12345",
    "billing_details": {
      "first_name": "John",
      "last_name": "Doe",
      "email_address": "john@example.com",
      "phone_number": "+1234567890",
      "address": {
        "city": "San Jose",
        "country": "US",
        "postal_code": "94560",
        "state": "California",
        "state_code": "US-CA",
        "house_number_or_name": "10",
        "line1": "Stafford Appartments",
        "line2": "29th Street",
        "organization": "Gr4vy"
      },
      "tax_id": {
        "value": "12345678931",
        "kind": "us.ein"
      }
    },
    "account_number": "<string>"
  },
  "shipping_details": {
    "first_name": "John",
    "last_name": "Doe",
    "email_address": "john@example.com",
    "phone_number": "+1234567890",
    "address": {
      "city": "San Jose",
      "country": "US",
      "postal_code": "94560",
      "state": "California",
      "state_code": "US-CA",
      "house_number_or_name": "10",
      "line1": "Stafford Appartments",
      "line2": "29th Street",
      "organization": "Gr4vy"
    },
    "id": "bf8c36ad-02d9-4904-b0f9-a230b149e341",
    "buyer_id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
    "type": "shipping-details"
  }
}

Authorizations

Authorization
string
header
required

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

Headers

x-gr4vy-merchant-account-id
string

The ID of the merchant account to use for this request.

Examples:

"default"

Path Parameters

The unique identifier for the payment link.

Examples:

"a1b2c3d4-5678-90ab-cdef-1234567890ab"

Response

200
application/json

Successful Response

The response is of type object.