Skip to main content
GET
/
payment-links
/
{payment_link_id}
C#
using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    id: "mattilda",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

var res = await sdk.PaymentLinks.GetAsync(paymentLinkId: "a1b2c3d4-5678-90ab-cdef-1234567890ab");

// handle response
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "amount": 49999999,
  "country": "<string>",
  "currency": "<string>",
  "intent": "authorize",
  "cart_items": [
    {
      "amount": {
        "currency": "MXN",
        "value": 500
      },
      "name": "Widget",
      "quantity": 2
    }
  ],
  "payment_source": "ecommerce",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "status": "active",
  "type": "payment-link",
  "expires_at": "2024-06-01T00:00:00.000Z",
  "external_identifier": "external-12345",
  "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",
  "return_url": "https://merchant.example.com/return",
  "metadata": {
    "order_id": "ORD-12345"
  },
  "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": "<string>",
        "kind": "co.itin"
      }
    },
    "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"
  }
}
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.

Headers

​
x-gr4vy-merchant-account-id
string | null

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

Example:

"default"

Path Parameters

​
payment_link_id
string<uuid>
required

The unique identifier for the payment link.

Example:

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

Response

Successful Response

​
id
string<uuid>
required

The unique identifier for the payment link.

Example:

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

​
url
string
required

The URL for the payment link.

Example:

"https://example.com/link/a1b2c3d4-5678-90ab-cdef-1234567890ab"

​
amount
integer
required

The amount for the payment link.

Required range: 0 <= x <= 99999999
Example:

1299

​
country
string
required

The country code for the payment link.

Pattern: ^[A-Z]{2}$
Examples:

"DE"

"GB"

"US"

​
currency
string
required

The currency code for the payment link.

Pattern: ^[A-Z]{3}$
Examples:

"EUR"

"GBP"

"MXN"

​
intent
enum<string>
required

The transaction intent for the payment link. It's recommended to set for capture.

Available options:
authorize,
capture
Examples:

"authorize"

"capture"

​
cart_items
CartItem · object[] | null
required

The cart items for the payment link.

Example:
[
  {
    "amount": { "currency": "MXN", "value": 500 },
    "name": "Widget",
    "quantity": 2
  }
]
​
payment_source
enum<string>
required

The payment source for the payment link.

Available options:
ecommerce,
moto,
recurring,
installment,
card_on_file
Example:

"ecommerce"

​
created_at
string<date-time>
required

The date and time the payment link was created.

Example:

"2024-05-30T12:34:56.000Z"

​
updated_at
string<date-time>
required

The date and time the payment link was last updated.

Example:

"2024-05-30T13:00:00.000Z"

​
status
enum<string>
required

The status of the payment link.

Available options:
active,
completed,
expired,
processing
Examples:

"active"

"expired"

"completed"

​
type
string
default:payment-link

Always payment-link.

Allowed value: "payment-link"
Example:

"payment-link"

​
expires_at
string<date-time> | null

The expiration date and time for the payment link.

Example:

"2024-06-01T00:00:00.000Z"

​
external_identifier
string | null

The merchant reference for the payment link.

Required string length: 1 - 200
Example:

"external-12345"

​
locale
string | null

The locale for the payment link.

Example:

"en"

​
merchant_name
string | null

The merchant's display name.

Required string length: 1 - 100
Example:

"ACME Inc."

​
merchant_url
string | null

The merchant's website URL.

Example:

"https://merchant.example.com"

​
merchant_banner_url
string | null

The merchant's banner image URL.

Example:

"https://merchant.example.com/banner.png"

​
merchant_color
string | null

The merchant's brand color.

Required string length: 1 - 100
Example:

"#FF5733"

​
merchant_message
string | null

A message from the merchant.

Required string length: 1 - 255
Example:

"Thank you for your purchase!"

​
merchant_terms_and_conditions_url
string | null

URL to the merchant's terms and conditions.

Example:

"https://merchant.example.com/terms"

​
merchant_favicon_url
string | null

URL to the merchant's favicon.

Example:

"https://merchant.example.com/favicon.ico"

​
return_url
string | null

The return URL after payment completion.

Example:

"https://merchant.example.com/return"

​
metadata
Metadata · object

Arbitrary metadata for the payment link.

Example:
{ "order_id": "ORD-12345" }
​
buyer
TransactionBuyer · object

The buyer associated with the payment link.

​
shipping_details
ShippingDetails · object

The shipping details for the payment link.