Sign in

v1

latestOpenAPI 3.1.02026-07-2022194782.1 KB
Payment links

Update the status of a payment link

Updates the status of a payment link. Use this endpoint to force the expiry of a payment link.

patch/paymentLinks/{linkId}

Path parameters

linkIdstring required

Unique identifier of the payment link.

Request body

status'expired' required

Status of the payment link. Possible values:

  • expired

Response

OK - the request has succeeded.

allowedPaymentMethodsstring[]

List of payment methods to be presented to the shopper. To refer to payment methods, use their payment method type.

Example: "allowedPaymentMethods":["ideal","applepay"]

blockedPaymentMethodsstring[]

List of payment methods to be hidden from the shopper. To refer to payment methods, use their payment method type.

Example: "blockedPaymentMethods":["ideal","applepay"]

countryCodestring

The shopper's two-letter country code.

deliverAtstring date-time

The date and time when the purchased goods should be delivered.

ISO 8601 format: YYYY-MM-DDThh:mm:ss+TZD, for example, 2020-12-18T10:15:30+01:00.

descriptionstring

A short description visible on the payment page. Maximum length: 280 characters.

expiresAtstring

The date when the payment link expires.

ISO 8601 format with time zone designator Z: YYYY-MM-DDThh:mm:ss+TZD, for example, 2020-12-18T10:15:30Z.

The maximum expiry date is 70 days after the payment link is created.

If not provided, the payment link expires 24 hours after it was created.

installmentOptionsobject

A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, card to specify installment options for all cards, or visa or mc. The value must be an object containing the installment options.

manualCaptureboolean

Indicates if the payment must be captured manually.

merchantAccountstring required

The merchant account identifier for which the payment link is created.

merchantOrderReferencestring

This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle.

metadataobject

Metadata consists of entries, each of which includes a key and a value. Limitations:

  • Maximum 20 key-value pairs per request. Otherwise, error "177" occurs: "Metadata size exceeds limit"
  • Maximum 20 characters per key. Otherwise, error "178" occurs: "Metadata key size exceeds limit"
  • A key cannot have the name checkout.linkId. Any value that you provide with this key is going to be replaced by the real payment link ID.
recurringProcessingModel'CardOnFile' | 'Subscription' | 'UnscheduledCardOnFile'

Defines a recurring payment type. Required when storePaymentMethodMode is set to askForConsent or enabled. Possible values:

  • Subscription – A transaction for a fixed or variable amount, which follows a fixed schedule.
  • CardOnFile – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.
  • UnscheduledCardOnFile – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or has variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.
referencestring required

A reference that is used to uniquely identify the payment in future communications about the payment status.

returnUrlstring

Website URL used for redirection after payment is completed. If provided, a Continue button will be shown on the payment page. If shoppers select the button, they are redirected to the specified URL.

reusableboolean

Indicates whether the payment link can be reused for multiple payments. If not provided, this defaults to false which means the link can be used for one successful payment only.

shopperEmailstring

The shopper's email address.

shopperLocalestring

The language to be used in the payment page, specified by a combination of a language and country code. For example, en-US.

For a list of shopper locales that Pay by Link supports, refer to Language and localization.

shopperReferencestring

Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters.

Your reference must not include personally identifiable information (PII) such as name or email address.

showRemovePaymentMethodButtonboolean

Set to false to hide the button that lets the shopper remove a stored payment method.

status'active' | 'completed' | 'expired' | 'paid' | 'paymentPending' required

Status of the payment link. Possible values:

  • active: The link can be used to make payments.
  • expired: The expiry date for the payment link has passed. Shoppers can no longer use the link to make payments.
  • paid: The shopper completed the payment.
storestring

The physical store, for which this payment is processed.

updatedAtstring date-time

The date when the payment link status was updated.

ISO 8601 format: YYYY-MM-DDThh:mm:ss+TZD, for example, 2020-12-18T10:15:30+01:00.

urlstring required

The URL at which the shopper can complete the payment.