Create Payment Link

Create Payment Link

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

To create a new Payment Link you must provide the amount for the transaction, the currency, the nature, an expiration date with expireAt, and an externalId to uniquely identify the payment.

Business rules to consider:

  • When the payerId parameter is provided, the Payment Link can be created for amounts up to BRL 1,000,000.00.

  • If payerId is not included, the maximum allowed amount is BRL 120,000.00.

  • The payerId may be either a CPF or CNPJ, corresponding to an individual or business taxpayer identification number in Brazil.

  • Although the transaction amount is defined in foreign currency (USD, EUR, etc.), the limit rule is always evaluated in BRL, based on the converted value at the time of creation

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

Response

PreviousPayment LinkNextGet Payment Link by ID