Payment Link In Pay Mode

Payment Link In Pay Mode

PATCH {{environment_url}}/vendors/v1/public/payment-links/:id

This endpoint creates a PIX charge from a public Payment Link and returns the updated Payment Link data with the charge included.

This is a public route — no authentication is required — but the Payment Link must exist and must not be expired.

Usage

• Route Parameters:

  • id (string) — Payment Link ID in ULID format.

  • Example: pl_01HQXP3K8M9N2Q5R7T8V0W1X2Y

Request Body (JSON)

• quotationId (string) — required. Identifier of the quotation retrieved via GET from the Payment Link.

• email (string) — optional. Payer’s email for notifications.

• phone (string) — optional. Payer’s phone number in E.164 format for notifications.

• expire (number) — optional. Charge expiration time in seconds; if omitted, the application default is used.

Headers

Name	Value
Authorization	Bearer <token>

Path Params

Name	Type	Description	Value
id	string	Payment Link Identifier	plink_01j6hq7cfta41wjchd3bh60g65

Body

Name	Type	Description	Value
quotationId	string	Identifier of the quotation retrieved via GET from the Payment Link.	01HQXP3K8M9N2Q5R7T8V0W1X2Y
email	string	Payer’s email for notifications	[email protected]
phone	string	Payer’s phone number in E.164 format for notifications	[phone]
expire	number	Charge expiration time in seconds; if omitted, the application default is used.	7200

Request body

Payment Link in Pay Mode

{
  "quotationId": "01HQXP3K8M9N2Q5R7T8V0W1X2Y",
  "email": "[email protected]",
  "phone": "[phone]",
  "expire": 7200
}

Response

201 - CREATED

{
  "id": "pl_01HQXP3K8M9N2Q5R7T8V0W1X2Y",
  "amount": 100,
  "currency": "USD",
  "nature": "SERVICES_AND_OTHERS",
  "status": "ACTIVE",
  "expireAt": "2025-12-31T23:59:59.000Z",
  "email": "[email protected]",
  "phone": "[phone]",
  "charge": {
    "id": "chrg_01HQXP3K8M9N2Q5R7T8V0W1X2Y",
    "status": "CREATED",
    "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "qrCodeText": "00020126580014br.gov.bcb.pix...",
    "expiresAt": "2025-10-02T16:00:00.000Z"
  },
  "vendor": {
    "id": "vnd_01HQXP3K8M9N2Q5R7T8V0W1X2Y",
    "name": "Vendor Name"
  }
}