This endpoint requires the payment-links.read scope.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The ID for the payment link to get the information for.
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.
buyer.billing_details. address
The billing address of the buyer.
buyer.billing_details.address. city
The city for the address.
Required string length: 1 - 100
buyer.billing_details.address. country
The country for the address in ISO 3166 format.
Required string length: 2
buyer.billing_details.address. house_number_or_name
The house number or name for the address. Not all payment
services use this field but some do.
Required string length: 1 - 255
buyer.billing_details.address. line1
The first line of the address.
Required string length: 1 - 255
buyer.billing_details.address. line2
The second line of the address.
Required string length: 1 - 255
buyer.billing_details.address. organization
The optional name of the company or organisation to add
to the address.
Required string length: 1 - 255
buyer.billing_details.address. postal_code
The postal code or zip code for the address.
Required string length: 1 - 50
buyer.billing_details.address. state
The state, county, or province for the address.
Required string length: 1 - 255
buyer.billing_details.address. state_code
The code of state, county, or province for the address in
ISO 3166-2 format.
Required string length: 4 - 6
buyer.billing_details. email_address
The email address of the buyer.
Required string length: 1 - 320
buyer.billing_details. first_name
The first name(s) or given name of the buyer.
Required string length: 1 - 255
buyer.billing_details. last_name
The last name, or family name, of the buyer.
Required string length: 1 - 255
buyer.billing_details. phone_number
Required string length: 1 - 50
buyer.billing_details. tax_id
The tax information associated with the billing details.
buyer.billing_details.tax_id. kind
Available options:
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
buyer.billing_details.tax_id. value
The tax ID for the buyer.
Required string length: 1 - 50
buyer.billing_details. type
The type of this resource. Is always billing-details.
Available options:
billing-details
A unique name for this buyer which is used in the Gr4vy admin panel to give a buyer a human readable name.
Required string length: 1 - 200
buyer. external_identifier
An external identifier that can be used to match the buyer against your own records.
Required string length: 1 - 200
The unique Gr4vy ID for this buyer.
The type of this resource. Is always 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.
Maximum length: 255
The quantity of this item in the cart. This value cannot be negative
or zero.
Required range: 1 < x < 99999999
The 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.
Required range: 0 < x < 99999999
A list of strings containing product categories for the item.
Max length per item: 50.
cart_items. discount_amount
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.
Required range: 0 < x < 99999999
cart_items. external_identifier
An external identifier for the cart item. This can be set to any value and is not sent to the payment service.
Maximum length: 200
The URL for the image of the item.
Maximum length: 2083
The product type of the cart item.
Available options:
physical,
discount,
shipping_fee,
sales_tax,
digital,
gift_card,
store_credit,
surcharge
The product URL for the item.
Maximum length: 2083
The 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.
Required range: 0 < x < 99999999
The 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.
Required string length: 1 - 200
The ID of a payment link.
The intent of the payment link.
Available options:
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.
Maximum length: 255
The name of the merchant to display on the payment link.
Maximum length: 100
The 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.
Available options:
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.
shipping_details.address. city
The city for the address.
Required string length: 1 - 100
shipping_details.address. country
The country for the address in ISO 3166 format.
Required string length: 2
shipping_details.address. house_number_or_name
The house number or name for the address. Not all payment
services use this field but some do.
Required string length: 1 - 255
shipping_details.address. line1
The first line of the address.
Required string length: 1 - 255
shipping_details.address. line2
The second line of the address.
Required string length: 1 - 255
shipping_details.address. organization
The optional name of the company or organisation to add
to the address.
Required string length: 1 - 255
shipping_details.address. postal_code
The postal code or zip code for the address.
Required string length: 1 - 50
shipping_details.address. state
The state, county, or province for the address.
Required string length: 1 - 255
shipping_details.address. state_code
The code of state, county, or province for the address in
ISO 3166-2 format.
Required string length: 4 - 6
shipping_details. buyer_id
The unique ID for a buyer.
shipping_details. email_address
The email address of the buyer.
Required string length: 1 - 320
shipping_details. first_name
The first name(s) or given name of the buyer.
Required string length: 1 - 255
The unique ID for a buyer's shipping detail.
shipping_details. last_name
The last name, or family name, of the buyer.
Required string length: 1 - 255
shipping_details. phone_number
Required string length: 1 - 50
The type of this resource. Is always shipping-details.
Available options:
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.
statement_descriptor. city
The merchant's city to be displayed in a statement
descriptor.
Required string length: 1 - 13
statement_descriptor. country
The 2-letter ISO country code of the merchant to be displayed in a statement
descriptor.
statement_descriptor. description
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: . , _ - ? + /.
Required string length: 5 - 22
statement_descriptor. name
Reflects 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: . , _ - ? + /.
Required string length: 5 - 22
statement_descriptor. phone_number
The value in the phone number field of a customer's statement which
should be formatted according to the
E164 number standard .
Required string length: 5 - 20
The merchant's URL to be displayed in a statement
descriptor.
Required string length: 1 - 13
Available options:
active,
expired
The type of this resource. Is always payment_link.
Available options:
payment_link
The date and time when this payment link was created.
