Checkout
Create a payment link
selectkey<token>
API key para requisições autenticadas. Envie sua chave no cabeçalho selectkey (sandbox sk_test_…, produção sk_live_…).
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/checkouts/payment-links" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Ltda", "items": [ { "id": "var_0a1b2c3d4e5f60718293", "quantity": 1 } ], "discounts": [ "string" ], "customInputs": [ {} ], "expiresAt": "2026-01-15T12:00:00.000Z", "availableAt": "2026-01-15T12:00:00.000Z", "editable": false, "templateId": "tmpl_0a1b2c3d4e5f60718293", "metadata": {} }'{
"id": "link_0a1b2c3d4e5f60718293",
"name": "Acme Ltda",
"type": "string",
"enabled": true,
"accessId": "string",
"signature": "string",
"accessFullUrl": "string",
"sessionId": "string",
"editable": true,
"items": [
{}
],
"discounts": [],
"customInputs": [
{}
],
"expiresAt": "string",
"availableAt": "string",
"templateId": "string",
"integrationId": "string",
"domainId": "string",
"metadata": {},
"createdAt": "string",
"updatedAt": "string"
}{
"error": {
"status": "Bad Request",
"statusCode": 400,
"category": "validation",
"code": "invalidParameters",
"message": "Validation errors occurred.",
"resource": "server"
}
}{
"error": {
"status": "Unauthorized",
"statusCode": 401,
"category": "authentication",
"code": "unauthorized",
"message": "Authentication is required to access this resource.",
"resource": "server"
}
}{
"error": {
"status": "Forbidden",
"statusCode": 403,
"category": "authorization",
"code": "forbidden",
"message": "You do not have permission to perform this action.",
"resource": "server"
}
}{
"error": {
"status": "Bad Request",
"statusCode": 400,
"category": "validation",
"code": "invalidParameters",
"message": "Validation errors occurred.",
"resource": "server"
}
}{
"error": {
"status": "Internal Server Error",
"statusCode": 500,
"category": "server",
"code": "serverError",
"message": "An unexpected error occurred. Please try again later.",
"resource": "server",
"details": "If the problem persists, contact support with the correlationId from the response headers."
}
}