Update existing payment link

post

https://api.stage.payouts.com/payment-link/update/{id}

Required permissions for this API:

WRITE:FINANCE

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

amount

number

The payment amount. For Fixed pricing only.

collectableShopperInfo

object

Every payment link requires the shopper to enter their name and email address. Additionally, you can request information for the following fields on each payment link.

currency

string

The currency of the payment amount. For Fixed pricing only.

defaultCurrency

string

The default payment currency from the list of supported_currencies. The shopper can change the payment currency during checkout. For Flexible pricing only.

description

string

The additional description text that appears under the title in the payment checkout page.

metadata

object

A set of key-value pairs that you can attach to the PaymentLink for storing additional information.

reference

string

A reference only visible to the merchant.

supportedCurrencies

array of strings

List of supported currencies the shopper may choose from. For Flexible pricing only.

supportedCurrencies

title

string

required

The title of the payment link that is displayed in the payment checkout page.

Responses

200

401A response indicating that the provided api token is invalid or has already expired