Payments
- Transactions
- Buyers
- Checkout Sessions
- Payment links
- Payment options
- Payouts
- Refunds
- Sessions
- Settlement records
Instruments
- Card schemes
- Digital wallets
- Gift cards
- Payment methods
- Payment method definitions
Vault
- Account updater
- Network tokens
- Payment service tokens
- Vault Forward
- Vault Forward endpoints
- Vault Forward authentication
Connections
- All services
- Payment services
- Digital wallets
- Anti-fraud services
- Gift-card services
Dashboard
- Flow
- Merchant accounts
- Reports
- Report executions
List payment links
This endpoint requires the payment-links.read scope.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
A list of payment links.
A list of payment links.
The monetary amount for this payment link, in the smallest
currency unit for the given currency, for example 1299 cents to create
an authorization for $12.99.
The buyer used for this transaction.
The billing details associated with the buyer, which include the address and tax ID.
The billing address of the buyer.
The city for the address.
1 - 100The country for the address in ISO 3166 format.
2The house number or name for the address. Not all payment services use this field but some do.
1 - 255The first line of the address.
1 - 255The second line of the address.
1 - 255The optional name of the company or organisation to add to the address.
1 - 255The postal code or zip code for the address.
1 - 50The state, county, or province for the address.
1 - 255The code of state, county, or province for the address in ISO 3166-2 format.
4 - 6The email address of the buyer.
1 - 320The first name(s) or given name of the buyer.
1 - 255The last name, or family name, of the buyer.
1 - 255The phone number of the buyer. This number is formatted according to the E164 number standard.
1 - 50The tax information associated with the billing details.
The kind of tax ID.
ae.trn, au.abn, ar.dni, ar.cuil, ar.cuit, br.cnpj, br.cpf, ca.bn, ca.gst_hst, ca.pst_bc, ca.pst_mb, ca.pst_sk, ca.qst, ch.vat, cl.tin, es.cif, eu.vat, gb.vat, hk.br, id.nik, id.npwp, in.gst, jp.cn, jp.rn, kr.brn, li.uid, mx.curp, my.frp, my.itn, my.nric, my.sst, no.vat, nz.gst, ph.tin, ru.inn, ru.kpp, sa.vat, sg.gst, sg.uen, th.id, th.vat, tw.vat, us.ein, za.vat The tax ID for the buyer.
1 - 50The type of this resource. Is always billing-details.
billing-details A unique name for this buyer which is used in the Gr4vy admin panel to give a buyer a human readable name.
1 - 200An external identifier that can be used to match the buyer against your own records.
1 - 200The unique Gr4vy ID for this buyer.
The type of this resource. Is always buyer.
buyer An array of cart items that represents the line items of a payment link.
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.
255The quantity of this item in the cart. This value cannot be negative or zero.
1 < x < 99999999The amount for an individual item represented as a monetary amount
in the smallest currency unit for the given currency, for example
1299 USD 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 < 99999999A list of strings containing product categories for the item. Max length per item: 50.
The amount discounted for this item represented as a monetary amount
in the smallest currency unit for the given currency, for example 1299
USD cents represents $12.99.
Please note that this amount is for the total of the cart item and not for an individual item. For example, if the quantity is 5, this value should be the total discount amount for 5 of the cart item.
You might see unexpected failed transactions if the discount_amount can
not be equally divided by the quantity value. This is due to the fact
that some payment services require this amount to be specified per unit.
In this situation we recommend splitting this item into separate items, each with their own specific discount.
0 < x < 99999999An external identifier for the cart item. This can be set to any value and is not sent to the payment service.
200The URL for the image of the item.
2083The product type of the cart item.
physical, discount, shipping_fee, sales_tax, digital, gift_card, store_credit, surcharge The product URL for the item.
2083The SKU for the item.
200The tax amount for this item represented as a monetary amount
in the smallest currency unit for the given currency, for example 1299
USD cents represents $12.99.
Please not that this amount is for the total of the cart item and not for an individual item. For example, if the quantity is 5, this value should be the total tax amount for 5 of the cart item.
You might see unexpected failed transactions if the tax_amount can
not be equally divided by the quantity value. This is due to the fact
that some payment services require this amount to be specified per unit.
In this situation we recommend splitting this item into separate items, each with their own specific tax amount.
0 < x < 99999999The 2-letter ISO code of the country of the transaction. This is used to filter the payment services that is used to process the transaction.
The date and time when this payment link was created.
A supported ISO-4217 currency code.
The date and time when this payment link expires.
A value that can be used to match the payment link against your own records.
1 - 200The ID of a payment link.
The intent of the payment link.
authorize, capture The URL of the merchant banner to display on the payment link.
The color code of the merchant to display on the payment link.
The message to display on the payment link.
255The name of the merchant to display on the payment link.
100The URL of the merchant terms and conditions to display on the payment link.
The URL of the merchant to display on the payment link.
Any additional information about the payment link that you would like to store as key-value pairs. This data is passed to payment service providers that support it.
The source of the payment link. Defaults to ecommerce.
ecommerce, moto, recurring, installment, card_on_file The URL to redirect the buyer to after payment.
Shipping details for the payment link.
The physical shipping address associated to this buyer.
The city for the address.
1 - 100The country for the address in ISO 3166 format.
2The house number or name for the address. Not all payment services use this field but some do.
1 - 255The first line of the address.
1 - 255The second line of the address.
1 - 255The optional name of the company or organisation to add to the address.
1 - 255The postal code or zip code for the address.
1 - 50The state, county, or province for the address.
1 - 255The code of state, county, or province for the address in ISO 3166-2 format.
4 - 6The unique ID for a buyer.
The email address of the buyer.
1 - 320The first name(s) or given name of the buyer.
1 - 255The unique ID for a buyer's shipping detail.
The last name, or family name, of the buyer.
1 - 255The phone number of the buyer. This number is formatted according to the E164 number standard.
1 - 50The type of this resource. Is always shipping-details.
shipping-details The statement descriptor is the text to be shown on the buyer's statements.
The specific usage of these fields will depend on the capabilities of the underlying PSP and bank. As a typical example, 'name' and 'description' could be concatenated using '* ' as a separator, and then the resulting descriptor would be truncated to 22 characters by the issuing bank.
The merchant's city to be displayed in a statement descriptor.
1 - 13The 2-letter ISO country code of the merchant to be displayed in a statement descriptor.
A short description about the purchase.
Other validations:
- Contains only Latin characters.
- Contain at least one letter
- Does not contain any of the special characters
< > \ ' " * - Supports:
- Lower case:
a-z - Upper case:
A-Z - Numbers:
0-9 - Spaces:
- Special characters:
. , _ - ? + /.
5 - 22Reflects your doing business as (DBA) name.
Other validations:
- Contains only Latin characters.
- Contain at least one letter
- Does not contain any of the special characters
< > \ ' " * - Supports:
- Lower case:
a-z - Upper case:
A-Z - Numbers:
0-9 - Spaces:
- Special characters:
. , _ - ? + /.
5 - 22The value in the phone number field of a customer's statement which should be formatted according to the E164 number standard.
5 - 20The merchant's URL to be displayed in a statement descriptor.
1 - 13active, expired The type of this resource. Is always payment_link.
payment_link The date and time when this payment link was created.
The limit applied to request. This represents the number of items that are at maximum returned by this request.
1 < x < 100The cursor that represents the next page of results. Use the cursor query
parameter to fetch this page of items.
1 - 1000The cursor that represents the next page of results. Use the cursor query
parameter to fetch this page of items.
1 - 1000Was this page helpful?