Skip to main content
POST
/
v2
/
checkout-links
Create a Checkout Link
curl --request POST \
  --url https://api.pagou.ai/v2/checkout-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 4503599627370496,
  "currency": "BRL",
  "title": "<string>",
  "products": [
    {
      "external_id": "<string>",
      "name": "<string>",
      "price": 4503599627370496,
      "quantity": 1,
      "description": "<string>",
      "image_url": "<string>",
      "compare_price": 4503599627370496
    }
  ]
}
'
{
  "success": true,
  "requestId": "<string>",
  "data": {
    "url": "<string>"
  }
}
Send either products[] (each referenced by your own external_id) or a value-only amount — not both. Products are upserted by external_id, so re-sending the same id updates the product instead of duplicating it. The response is the final checkout url. For the full integration guide, value-only links, and AI prompts, see Create Checkout Links.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
amount
integer
Required range: 1 <= x <= 9007199254740991
​
currency
enum<string>
default:BRL
Available options:
BRL,
MXN,
COP,
CLP,
ARS,
PEN,
USD,
GTQ,
CRC,
NIO,
PYG,
UYU,
BOB,
PHP,
RUB,
INR,
SAR,
AED,
KWD,
QAR,
OMR,
KHR,
SGD,
IDR,
KRW,
THB,
MYR,
HKD,
CNY,
EGP,
EUR,
GBP,
BHD,
MAD,
AUD,
CAD,
CHF,
NZD,
PLN,
KZT,
UZS,
JPY,
GLC
​
title
string
Required string length: 1 - 255
​
products
object[]
Minimum array length: 1

Response

HTTP 201 response

​
success
boolean
required
​
requestId
string
required
​
data
object
required