Disable Payment Link
POST /paymentlinks/disable
This endpoint allows merchants to disable existing payment links, preventing any further transactions or tokenizations. Once disabled, the payment link becomes inaccessible to customers. Existing transactions and tokens remain unaffected.
Test URL
Send the request to the following URL:
https://checkout-api.staging.straumur.is/api/v1/paymentlinks/disable
This call disables the specified payment link immediately.
Request Example
{
"paymentLinkReference": "30001aylo2a"
}
Required Request Body Fields
| Field | Type | Required | Description | Example | Min Length | Max Length |
|---|---|---|---|---|---|---|
| paymentLinkReference | String | Required | Unique reference of the payment link to disable | 30001aylo2a | 1 | 100 |
Example Response – Success
{
"responseDateTime": "2025-01-04T09:50:14.343503Z",
"responseIdentifier": "e3605f81-6b09-4ce1-83ad-5a8d49f3cd44"
}
Response Fields
The response includes all payment link details with the updated status. Key changes after disabling:
| Field | Type | Description | Example |
|---|---|---|---|
| responseDateTime | String | The date and time when the response was generated. | 2024-09-04T09:50:14.343503Z |
| responseIdentifier | String | The unique identifier for the response. | 7be7111c-2e8e-4cd4-a5ba-f15bdfd177c1 |
Error Response
Error responses are standardized. For details, see Errors.
You can also find a detailed overview of our HTTP Status Codes.