Create Payment Link

Create Payment Link

POST {{Environment_URL}}/vendors/v1/payment-links

This endpoint creates a new Payment Link to collect payments via PIX. You must define the amount, currency, nature, expiration date (expireAt), and an optional externalId to avoid duplicates.

---

Business Rules

• If payerId is provided:

  • Maximum allowed amount: BRL 1,000,000.00 (converted from foreign currency at creation time)

• If payerId is NOT provided:

  • Maximum allowed amount: BRL 120,000.00

• payerId can be:

  • CPF (individual)

  • CNPJ (business)

• Even though the amount is defined in a foreign currency (USD, EUR, etc.), all limits are validated in BRL, using the exchange rate at the time of creation.

• externalId should be reused on retries to avoid creating duplicate links.

---

Result

When the Payment Link is created, you receive:

• A unique paymentLinkId

• The expiration date

• All configuration needed for the customer to pay using the link

The link can then be accessed in:

• Sandbox: https://pay.demo.commpix.com/plink/:paymentLinkId

• Production: https://pay.commpix.com/plink/:paymentLinkId

Headers

Name	Value
Authorization	Bearer <token>

Body

Key	Description	Required	Data Type	Example
externalId	Unique identifier to avoid duplicates. Is used to identify a specific payment. In case of resending due to some failure, the externalId must be the same previously declared so that we can verify if it has already been paid to the customer.	false	String	cmpny_34124jj5h1-12314hh51h-n123bb4tg
currency	Desired currency for Payment Link	true	String	USD
amount	Payment Link value in cents	true	Integer	10000 This results in a Payment Link with value $ 100,00
nature	Operation type	true	String	SERVICES_AND_OTHERS CASH_REMITTANCE GAMES_AND_BETS CRYPTO_ACTIVES UNKNOWN
expireAt	Expiration date for Payment Link. Max Value is 365	true	String	2025-09-11
payerId	taxId for create payment link above R$ 120.000,00	false	string	41299003079

The Payment Link can be accessed in SandBox via https://pay.demo.commpix.com/plink/:paymentLinkId, and in Production via https://pay.commpix.com/plink/:paymentLinkId

Request body

Create PaymentLink

{
  "amount": 12000000,
  "payerId": "41299003079",
  "currency": "USD",
  "nature": "SERVICES_AND_OTHERS",
  "expireAt": "2024-03-25T11:54:07+0000",
  "externalId": "internal-identifier-partner"
}

Response

201 - CREATED

{
    "id": "plink_01j6hq7cfta41wjchd3bh60g65",
    "amount": 12000000,
    "currency": "USD",
    "nature": "SERVICES_AND_OTHERS",
    "payerId": "41299003079",
    "phone": null,
    "email": null,
    "externalComment": null,
    "internalComment": null,
    "externalId": "internal-identifier-partner",
    "expireAt": "2024-03-25T11:54:07+0000",
    "createdAt": "2024-08-30T13:22:34.090Z",
    "vendor": {
        "id": "vnd_01hxwtx4cj2cmdpbjxz0zsmzzg",
        "businessType": "INDIVIDUAL",
        "businessClass": [
            "RESTAURANT"
        ],
        "name": "Frente Vendor",
        "vendorResponsiblePhone": "[phone]",
        "commercialPhone": "[phone]",
        "fullNameResponsible": "42231323232",
        "address": {
            "city": "dasdasd",
            "state": "3dasdas",
            "street": "dasdasd 3123",
            "country": "sc",
            "latitude": "312312",
            "longitude": "312312",
            "neighborhood": "dasdasdas",
            "openingHours": "312"
        },
        "email": "[email protected]",
        "metadata": {
            "additionalInformation[0].field": "",
            "additionalInformation[0].value": ""
        },
        "controller": {},
        "defaultCurrency": "USD",
        "natures": [
            "CRYPTO_ACTIVES"
        ],
        "vendorResponsible": {},
        "notificationsEmail": "[email protected]",
        "commercialEmail": "[email protected]",
        "externalAccounts": [],
        "status": "PENDING",
        "payoutsEnabled": true,
        "settings": {},
        "createdAt": "2024-05-15T00:37:14.728Z",
        "updatedAt": "2024-08-15T12:49:37.119Z",
        "financialDate": {
            "metaData": [
                {
                    "field": "BANK",
                    "value": "66263413"
                },
                {
                    "field": "AGENCY",
                    "value": "12332212"
                }
            ],
            "vendorBankDetails": {
                "country": "as",
                "currency": "USD",
                "accountName": "312"
            }
        },
        "agentId": "20",
        "logo": "https://simple-pay-vendors-demo.s3.amazonaws.com/logos/frente_vendor/0000000000000.png"
    }
}

400 - BAD REQUEST

401 - UNAUTHORIZED