Expire a payment link

Expire an existing payment link.

POST /payment-links/{payment_link_id}/expire

C#

C#

using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

await sdk.PaymentLinks.ExpireAsync(paymentLinkId: "a1b2c3d4-5678-90ab-cdef-1234567890ab");

// handle response

400

{
  "type": "error",
  "code": "bad_request",
  "status": 400,
  "message": "Generic error",
  "details": []
}

This endpoint requires the payment-links.write scope.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-gr4vy-merchant-account-id · string

The ID of the merchant account to use for this request.

Example:

"default"

Path Parameters

payment_link_id · string<uuid> · required

The unique identifier for the payment link.

Example:

"a1b2c3d4-5678-90ab-cdef-1234567890ab"

Response

204

Successful Response