Activate a payment link

put https://api.copperx.dev/api/v1/payment-links/{linkId}/activate

Responses

Response body

object

string

required

createdAt

date-time

updatedAt

date-time

organizationId

string

required

Organization's id

type

string

required

Payment link type

one_time multiple

amount

int64

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

currency

string

deprecated

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

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

currencies

array of strings

Currencies in which amount is to be taken

currencies

preferredCurrency

string

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

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

title

string

required

Payment link title

description

string

Payment link description

image

string

Payment link product image

publicImage

string

Payment link product image with absolute public url

tags

array of strings

required

Payment link tags

tags*

isActive

boolean

Whether the payment link is currently active

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

fields

array of objects

fields

object

key

string

required

type

string

required

text numeric dropdown

label

object

required

optional

boolean

required

Defaults to false

submitType

string

required

Payment link submit type

pay book donate

afterCompletion

string

required

After completion action to perform on checkout page

redirect hosted_confirmation

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

Suggested currency to take payment in

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

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

allowedChains

array of objects

Allowed chains to take payment from

allowedChains

object

chainId

number

required

Chain id

isPreferred

boolean

required

Is this chain preferred. If yes then it will be selected by default on checkout page

interval

string

The interval at which to bill for this price. Only required for subscriptions

day week month year

intervalCount

number

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

priceType

string

required

The type of the price

one_time recurring streaming

allowPromotionCodes

boolean

Enables user redeemable promotion codes.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.copperx.dev/api/v1/payment-links/linkId/activate \
3
     --header 'accept: application/json'

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

application/json

200

500