Sign in

v1

latestOpenAPI 3.0.02026-07-1498163181.9 KB
Payment Links

Get a payment link

Returns a payment link

get/api/v1/payment-links/{linkId}

Path parameters

linkIdstring required

Response

idstring required
createdAtstring date-time
updatedAtstring date-time
organizationIdstring required

Organization's id

type'one_time' | 'multiple' required
amountinteger

Amount to take from user in 8 decimal places. If not provided then user can enter any amount

currency'usdc' | 'usdt' | 'pyusd' | 'eurc' | 'brett' | 'dai' | 'btc' | 'eth' | 'matic' | 'bnb' | 'sol' | 'busd' | 'trx' | 'food' | 'bonk' | 'wif' | 'goat' | 'spx' | 'truf' | 'pengu'
currenciesCryptoCurrency[]

Currencies in which amount is to be taken

preferredCurrency'usdc' | 'usdt' | 'pyusd' | 'eurc' | 'brett' | 'dai' | 'btc' | 'eth' | 'matic' | 'bnb' | 'sol' | 'busd' | 'trx' | 'food' | 'bonk' | 'wif' | 'goat' | 'spx' | 'truf' | 'pengu'
titlestring required

Payment link title

descriptionstring

Payment link description

imagestring

Payment link product image

publicImagestring

Payment link product image with absolute public url

tagsstring[] required

Payment link tags

isActiveboolean

Whether the payment link is currently active

nameCollectionboolean required

If true then take name from user

emailCollectionboolean required

If true then take email from user

phoneNumberCollectionboolean required

If true then take phone number from user

shippingAddressCollectionboolean required

If true then take shipping address from user

billingAddressCollectionboolean required

If true then take billing address from user

submitType'pay' | 'book' | 'donate' required
afterCompletion'redirect' | 'hosted_confirmation' required
afterCompletionRedirectUrlstring

After completion redirect url to redirect user to after payment

afterCompletionConfirmMsgstring

After completion confirmation message to show to user after payment

suggestedCurrency'usdc' | 'usdt' | 'pyusd' | 'eurc' | 'brett' | 'dai' | 'btc' | 'eth' | 'matic' | 'bnb' | 'sol' | 'busd' | 'trx' | 'food' | 'bonk' | 'wif' | 'goat' | 'spx' | 'truf' | 'pengu'
suggestedAmountsstring[]

Suggested amounts to show on checkout page if amount is not provided

productIdstring

Product id to take payment for

interval'day' | 'week' | 'month' | 'year'
intervalCountnumber

It is used to determine the frequency at which the subscription is billed. Only required for subscriptions

priceType'one_time' | 'recurring' | 'streaming' required
allowPromotionCodesboolean

Enables user redeemable promotion codes.

Example response

{
  "allowedChains": [
    {
      "chainId": 1
    }
  ],
  "intervalCount": 1
}