Create a payment link

post

https://api.copperx.dev/api/v1/payment-links

Create a payment link to accept payments from customers. You can accept payments in a fixed or variable amount from your customers. Whether you are doing a freelancing, running a crowdfunding campaign, accept donations, or just looking for a simple way to build patrons via crypto, these payment links are the perfect solution.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

type

string

enum

required

Payment link type

Allowed:

amount

int64

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

currency

string

enum

deprecated

Amount's . This field is deprecated and will be removed in future versions. Use currencies and preferredCurrency instead.

currencies

array of objects

Currencies in which amount is to be taken

currencies

preferredCurrency

string

enum

Preferred currency. If provided then it will be selected by default on checkout page

title

string

required

Payment link title

description

string

Payment link description

image

string

Payment link product image

tags

array of strings

required

Payment link tags

tags*

nameCollection

boolean

required

If true then take name from user

emailCollection

boolean

required

If true then take email from user

phoneNumberCollection

boolean

required

If true then take phone number from user

shippingAddressCollection

boolean

required

If true then take shipping address from user

billingAddressCollection

boolean

required

If true then take billing address from user

customFields

object

submitType

string

enum

required

Payment link submit type

Allowed:

afterCompletion

string

enum

required

After completion action to perform on checkout page

Allowed:

afterCompletionRedirectUrl

string

After completion redirect url to redirect user to after payment

afterCompletionConfirmMsg

string

After completion confirmation message to show to user after payment

suggestedCurrency

string

enum

Suggested currency to take payment in

suggestedAmounts

array of strings

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

suggestedAmounts

productId

string

Product id to take payment for

allowPromotionCodes

boolean

Enables user redeemable promotion codes.

allowedChains

array of objects

Allowed chains to take payment from

allowedChains

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

500