Add a payment link

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.CreateAsync(paymentLinkCreate: new PaymentLinkCreate() {
    Amount = 1299,
    Country = "DE",
    Currency = "EUR",
});

// handle response

{
  "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",
  "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": "MXN",
        "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"
  }
}

POST

payment-links

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.CreateAsync(paymentLinkCreate: new PaymentLinkCreate() {
    Amount = 1299,
    Country = "DE",
    Currency = "EUR",
});

// handle response

{
  "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",
  "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": "MXN",
        "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"
  }
}

This endpoint requires the payment-links.write 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.

Examples:

"default"

Body

application/json

The payment link to create

amount

integer

required

The amount for the payment link.

Required range: 0 <= x <= 99999999

Examples:

1299

country

string

required

The country code for the payment link.

Examples:

"DE"

"GB"

"US"

currency

string

required

The currency code for the payment link.

Examples:

"EUR"

"GBP"

"MXN"

buyer

object | null

The guest buyer for the payment link.

Show child attributes

expires_at

string<date-time> | null

The expiration date and time for the payment link.

Examples:

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

connection_options

object | null

Connection options for the payment link.

Show child attributes

external_identifier

string | null

The merchant reference for the payment link.

Required string length: 1 - 200

Examples:

"external-12345"

locale

enum<string> | null

The locale for the payment link.

Available options:

en,

en-GB,

pt,

pt-BR,

es

Examples:

"en"

"en-GB"

"pt"

"pt-BR"

"es"

merchant_name

string | null

The merchant's display name.

Required string length: 1 - 100

Examples:

"ACME Inc."

merchant_url

string | null

The merchant's website URL.

Examples:

"https://merchant.example.com"

merchant_banner_url

string | null

The merchant's banner image URL.

Examples:

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

merchant_color

string<color> | null

The merchant's brand color.

Examples:

"#FF5733"

merchant_message

string | null

A message from the merchant.

Required string length: 1 - 255

Examples:

"Thank you for your purchase!"

merchant_terms_and_conditions_url

string | null

URL to the merchant's terms and conditions.

Examples:

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

merchant_favicon_url

string | null

URL to the merchant's favicon.

Examples:

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

intent

enum<string>

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

Available options:

authorize,

capture

return_url

string | null

The return URL after payment completion.

Examples:

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

cart_items

CartItem · object[] | null

The cart items for the payment link.

Show child attributes

metadata

object | null

Arbitrary metadata for the payment link.

Examples:

{ "order_id": "ORD-12345" }

payment_source

enum<string>

The payment source for the payment link.

Available options:

ecommerce,

moto,

recurring,

installment,

card_on_file

Response

Successful Response

string<uuid>

required

The unique identifier for the payment link.

Examples:

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

url

string

required

The URL for the payment link.

Examples:

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

amount

integer

required

The amount for the payment link.

Required range: 0 <= x <= 99999999

Examples:

1299

country

string

required

The country code for the payment link.

Examples:

"DE"

"GB"

"US"

currency

string

required

The currency code for the payment link.

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

cart_items

CartItem · object[] | null

required

The cart items for the payment link.

Show child attributes

Examples:

[
  {
    "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

created_at

string<date-time>

required

The date and time the payment link was created.

Examples:

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

updated_at

string<date-time>

required

The date and time the payment link was last updated.

Examples:

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

status

enum<string>

required

The status of the payment link.

Available options:

active,

completed,

expired,

processing

type

string

default:payment-link

Always payment-link.

Allowed value: "payment-link"

Examples:

"payment-link"

expires_at

string<date-time> | null

The expiration date and time for the payment link.

Examples:

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

external_identifier

string | null

The merchant reference for the payment link.

Required string length: 1 - 200

Examples:

"external-12345"

locale

string | null

The locale for the payment link.

Examples:

"en"

"en-GB"

"pt"

"pt-BR"

"es"

merchant_name

string | null

The merchant's display name.

Required string length: 1 - 100

Examples:

"ACME Inc."

merchant_url

string | null

The merchant's website URL.

Examples:

"https://merchant.example.com"

merchant_banner_url

string | null

The merchant's banner image URL.

Examples:

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

merchant_color

string | null

The merchant's brand color.

Required string length: 1 - 100

Examples:

"#FF5733"

merchant_message

string | null

A message from the merchant.

Required string length: 1 - 255

Examples:

"Thank you for your purchase!"

merchant_terms_and_conditions_url

string | null

URL to the merchant's terms and conditions.

Examples:

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

merchant_favicon_url

string | null

URL to the merchant's favicon.

Examples:

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

return_url

string | null

The return URL after payment completion.

Examples:

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

metadata

object | null

Arbitrary metadata for the payment link.

Examples:

{ "order_id": "ORD-12345" }

buyer

object | null

The buyer associated with the payment link.

Show child attributes

shipping_details

object | null

The shipping details for the payment link.

Show child attributes

List all payment links

Get payment link

Introduction

Transactions

Buyers

Checkout Sessions

Payment links

Payment options

Refunds

Sessions

Instruments

Vault

Errors

Other

Authorizations

Headers

Body

Response