Skip to content
Loading keys…
Authorization<token>

A public key (pk./pk_test.) is accepted on /payments, /customers, /links, /invoices and the catalogue reads (/channels, /providers, /countries, /currencies); anything that moves money out, reads the balance or manages the account answers 406 to it. It is an identifier, never an authorization. Use a secret key (sk./sk_test.) for sensitive operations (transfers, refunds, balance), or a restricted key (rk./rk_test.) scoped to specific permissions. The _test. variant of any key selects the sandbox environment, there is no separate sandbox URL. Never expose your secret key in client-side code.

In: header

Path Parameters

idstringrequired

Link identifier.

Request Body

application/json

titlestring

The title shown to payers, 3 to 255 characters.

descriptionstring

Up to 5 000 characters.

custom_urlstring

Your own slug for the link's address: letters, digits, dashes and underscores. Unique across Wajub, deleted links included: a slug already taken answers `422`.

pricenumber

A product link's price, in the major unit of the link's currency.

target_amountnumber

A fundraising link's goal, in the major unit.

min_amountnumber

The smallest amount a payer may enter, in the major unit.

max_amountnumber

The largest amount a payer may enter, in the major unit.

is_publicboolean

`false` takes the page offline; `true` publishes it.

is_archivedboolean

`true` archives the link (its page stops taking payments), `false` restores it.

expiry_datestring | null

When the page stops taking payments, ISO 8601. `null` removes the date.

sales_limitinteger | null

How many units the link may sell, payments in progress included; `null` removes the limit.

tagsarray<string>

Your own labels, up to 50 characters each.

callback_urlstring

Where the payer is sent back after paying. HTTPS (`http://localhost` in sandbox).

cta_typestring

The pay button: `buy_now`, `pay`, `donate`, `register` or `custom`.

custom_cta_textstring

The button's text when `cta_type` is `custom`, up to 50 characters.

acceptobject

Restricts the methods a payer is offered, as on `POST /payments`; `{}` removes the restriction.

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "https://api.wajub.com/links/aB3dE5fG7" \  -H "Content-Type: application/json" \  -d '{}'
PUT
/links/{id}
{  "code": 200,  "status": "OK",  "message": "Payment link updated",  "link": {    "id": "lnk_01JXXXXXXXXXXXXX",    "title": "Masterclass 2026, second session",    "custom_url": "masterclass-2026-bis"  }}

OK

What did you think of this content?