Introduction
Transactions
Checkout Sessions
Payment links
Payment options
Refunds
Instruments
Vault
Other
using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;
var sdk = new Gr4vySDK(
id: "mattilda",
server: SDKConfig.Server.Sandbox,
bearerAuthSource: Auth.WithToken(privateKey),
merchantAccountId: "default"
);
ListPaymentLinksResponse? res = await sdk.PaymentLinks.ListAsync(limit: 20);
while(res != null)
{
// handle items
res = await res.Next!();
}{
"items": [
{
"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": "[email protected]",
"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": "[email protected]",
"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"
}
}
],
"limit": 20,
"next_cursor": "ZXhhbXBsZTE",
"previous_cursor": "Xkjss7asS"
}List all payment links
List all created payment links.
using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;
var sdk = new Gr4vySDK(
id: "mattilda",
server: SDKConfig.Server.Sandbox,
bearerAuthSource: Auth.WithToken(privateKey),
merchantAccountId: "default"
);
ListPaymentLinksResponse? res = await sdk.PaymentLinks.ListAsync(limit: 20);
while(res != null)
{
// handle items
res = await res.Next!();
}{
"items": [
{
"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": "[email protected]",
"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": "[email protected]",
"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"
}
}
],
"limit": 20,
"next_cursor": "ZXhhbXBsZTE",
"previous_cursor": "Xkjss7asS"
}payment-links.read scope.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The ID of the merchant account to use for this request.
"default"
Query Parameters
A pointer to the page of results to return.
"ZXhhbXBsZTE"
The maximum number of items that are returned.
1 <= x <= 100Response
Successful Response
A list of items returned for this request.
Show child attributes
Show child attributes
The unique identifier for the payment link.
The URL for the payment link.
The amount for the payment link.
0 <= x <= 99999999The country code for the payment link.
The currency code for the payment link.
The transaction intent for the payment link. It's recommended to set for capture.
authorize, capture The cart items for the payment link.
Show child attributes
Show child attributes
The name of the cart item. The value you set for this property may be truncated if the maximum length accepted by a payment service provider is less than 255 characters.
1 - 255The quantity of this item in the cart. This value cannot be negative or zero.
x <= 99999999The amount for an individual item represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 MXN cents represents $12.99. The amount sent through to the payment processor as unitary amount will be calculated to include the discount and tax values sent as part of this cart item.
0 <= x <= 99999999The amount discounted for this item represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 MXN cents represents $12.99.
0 <= x <= 999999990
The tax amount for this item represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 MXN cents represents $12.99.
0 <= x <= 999999990
An external identifier for the cart item. This can be set to any value and is not sent to the payment service.
1 - 200"goprohd"
The SKU for the item.
1 - 200"GPHD1078"
The product URL for the item.
"https://example.com/catalog/go-pro-hd"
The URL for the image of the item.
"https://example.com/images/go-pro-hd.jpg"
A list of strings containing product categories for the item.
1 - 50["camera", "travel", "gear"]The product type of the cart item.
physical, discount, shipping_fee, sales_tax, digital, gift_card, store_credit, surcharge "physical"
The seller country of the cart item.
"US"
[
{
"amount": { "currency": "MXN", "value": 500 },
"name": "Widget",
"quantity": 2
}
]The payment source for the payment link.
ecommerce, moto, recurring, installment, card_on_file The date and time the payment link was created.
The date and time the payment link was last updated.
The status of the payment link.
active, completed, expired, processing Always payment-link.
"payment-link"The expiration date and time for the payment link.
"2024-06-01T00:00:00.000Z"
The merchant reference for the payment link.
1 - 200"external-12345"
The locale for the payment link.
"en"
The merchant's display name.
1 - 100"ACME Inc."
The merchant's website URL.
"https://merchant.example.com"
The merchant's banner image URL.
"https://merchant.example.com/banner.png"
The merchant's brand color.
1 - 100"#FF5733"
A message from the merchant.
1 - 255"Thank you for your purchase!"
URL to the merchant's terms and conditions.
"https://merchant.example.com/terms"
URL to the merchant's favicon.
"https://merchant.example.com/favicon.ico"
The return URL after payment completion.
"https://merchant.example.com/return"
Arbitrary metadata for the payment link.
{ "order_id": "ORD-12345" }The buyer associated with the payment link.
Show child attributes
Show child attributes
Always buyer.
"buyer"The ID for the buyer.
"fe26475d-ec3e-4884-9553-f7356683f7f9"
The display name for the buyer.
1 - 200"John Doe"
The merchant identifier for this buyer.
1 - 200"buyer-12345"
The billing name, address, email, and other fields for this buyer.
Show child attributes
Show child attributes
The first name(s) or given name for the buyer.
1 - 255"John"
The last name, or family name, of the buyer.
1 - 255"Doe"
The phone number for the buyer which should be formatted according to the E164 number standard.
"+1234567890"
The billing address for the buyer.
Show child attributes
Show child attributes
The city for the address.
1 - 100"San Jose"
The country for the address in ISO 3166 format.
"US"
The postal code or zip code for the address.
1 - 50"94560"
The state, county, or province for the address.
1 - 255"California"
The code of state, county, or province for the address in ISO 3166-2 format.
"US-CA"
The house number or name for the address. Not all payment services use this field but some do.
1 - 255"10"
The first line of the address.
1 - 255"Stafford Appartments"
The second line of the address.
1 - 255"29th Street"
The optional name of the company or organisation to add to the address.
1 - 255"Gr4vy"
The tax ID information associated with the billing details.
The buyer account number.
1 - 200The shipping details for the payment link.
Show child attributes
Show child attributes
The first name(s) or given name for the buyer.
1 - 255"John"
The last name, or family name, of the buyer.
1 - 255"Doe"
The phone number for the buyer which should be formatted according to the E164 number standard.
"+1234567890"
The billing address for the buyer.
Show child attributes
Show child attributes
The city for the address.
1 - 100"San Jose"
The country for the address in ISO 3166 format.
"US"
The postal code or zip code for the address.
1 - 50"94560"
The state, county, or province for the address.
1 - 255"California"
The code of state, county, or province for the address in ISO 3166-2 format.
"US-CA"
The house number or name for the address. Not all payment services use this field but some do.
1 - 255"10"
The first line of the address.
1 - 255"Stafford Appartments"
The second line of the address.
1 - 255"29th Street"
The optional name of the company or organisation to add to the address.
1 - 255"Gr4vy"
The ID for the shipping details.
"bf8c36ad-02d9-4904-b0f9-a230b149e341"
The ID for the buyer.
"fe26475d-ec3e-4884-9553-f7356683f7f9"
Always shipping-details.
"shipping-details"The number of items for this page.
1 <= x <= 100The cursor pointing at the next page of items.
1 - 1000"ZXhhbXBsZTE"
The cursor pointing at the previous page of items.
1 - 1000"Xkjss7asS"
Was this page helpful?