API Reference

Update a payment link

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

Updates a payment link

Path Params
string
required
Body Params
string
enum
required

Payment link type

Allowed:
int64

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

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
string
enum

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

string
required

Payment link title

string

Payment link description

string

Payment link product image

tags
array of strings
required

Payment link tags

tags*
boolean
required

If true then take name from user

boolean
required

If true then take email from user

boolean
required

If true then take phone number from user

boolean
required

If true then take shipping address from user

boolean
required

If true then take billing address from user

customFields
object
string
enum
required

Payment link submit type

Allowed:
string
enum
required

After completion action to perform on checkout page

Allowed:
string

After completion redirect url to redirect user to after payment

string

After completion confirmation message to show to user after payment

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
string

Product id to take payment for

boolean

Enables user redeemable promotion codes.

allowedChains
array of objects

Allowed chains to take payment from

allowedChains
Responses

Updated over 2 years ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 2 years ago