Criar Cobrança Pix Automático

cURL

curl --request POST \
  --url https://api.cakto.com.br/public_api/payments/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "customer": {
    "name": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "birthDate": "2023-12-25",
    "docType": "<string>",
    "docNumber": "<string>",
    "ip": "<string>",
    "fingerprint": "<string>"
  },
  "items": [
    {
      "offerId": "<string>",
      "quantity": 1,
      "offerType": "main",
      "installments": 6
    }
  ],
  "address": {
    "country": "<string>",
    "state": "<string>",
    "city": "<string>",
    "zipcode": "<string>",
    "street": "<string>",
    "number": "<string>",
    "neighborhood": "<string>",
    "complement": "<string>"
  },
  "affiliateShortId": "<string>",
  "coupon": "<string>",
  "metadata": {
    "utm_source": "<string>",
    "utm_medium": "<string>",
    "utm_campaign": "<string>",
    "utm_term": "<string>",
    "utm_content": "<string>",
    "sck": "<string>"
  },
  "dueDate": "2023-12-25",
  "pixExpiresIn": 61,
  "card": {
    "token": "<string>"
  },
  "threeDSecure": {
    "cavv": "<string>",
    "eci": "<string>",
    "xid": "<string>",
    "referenceId": "<string>",
    "version": "<string>",
    "dataOnly": false
  },
  "installments": 6,
  "antifraud_profiling_attempt_reference": "<string>"
}
'

import requests

url = "https://api.cakto.com.br/public_api/payments/"

payload = {
    "customer": {
        "name": "<string>",
        "email": "jsmith@example.com",
        "phone": "<string>",
        "birthDate": "2023-12-25",
        "docType": "<string>",
        "docNumber": "<string>",
        "ip": "<string>",
        "fingerprint": "<string>"
    },
    "items": [
        {
            "offerId": "<string>",
            "quantity": 1,
            "offerType": "main",
            "installments": 6
        }
    ],
    "address": {
        "country": "<string>",
        "state": "<string>",
        "city": "<string>",
        "zipcode": "<string>",
        "street": "<string>",
        "number": "<string>",
        "neighborhood": "<string>",
        "complement": "<string>"
    },
    "affiliateShortId": "<string>",
    "coupon": "<string>",
    "metadata": {
        "utm_source": "<string>",
        "utm_medium": "<string>",
        "utm_campaign": "<string>",
        "utm_term": "<string>",
        "utm_content": "<string>",
        "sck": "<string>"
    },
    "dueDate": "2023-12-25",
    "pixExpiresIn": 61,
    "card": { "token": "<string>" },
    "threeDSecure": {
        "cavv": "<string>",
        "eci": "<string>",
        "xid": "<string>",
        "referenceId": "<string>",
        "version": "<string>",
        "dataOnly": False
    },
    "installments": 6,
    "antifraud_profiling_attempt_reference": "<string>"
}
headers = {
    "X-Idempotency-Key": "<x-idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency-Key': '<x-idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customer: {
      name: '<string>',
      email: 'jsmith@example.com',
      phone: '<string>',
      birthDate: '2023-12-25',
      docType: '<string>',
      docNumber: '<string>',
      ip: '<string>',
      fingerprint: '<string>'
    },
    items: [{offerId: '<string>', quantity: 1, offerType: 'main', installments: 6}],
    address: {
      country: '<string>',
      state: '<string>',
      city: '<string>',
      zipcode: '<string>',
      street: '<string>',
      number: '<string>',
      neighborhood: '<string>',
      complement: '<string>'
    },
    affiliateShortId: '<string>',
    coupon: '<string>',
    metadata: {
      utm_source: '<string>',
      utm_medium: '<string>',
      utm_campaign: '<string>',
      utm_term: '<string>',
      utm_content: '<string>',
      sck: '<string>'
    },
    dueDate: '2023-12-25',
    pixExpiresIn: 61,
    card: {token: '<string>'},
    threeDSecure: {
      cavv: '<string>',
      eci: '<string>',
      xid: '<string>',
      referenceId: '<string>',
      version: '<string>',
      dataOnly: false
    },
    installments: 6,
    antifraud_profiling_attempt_reference: '<string>'
  })
};

fetch('https://api.cakto.com.br/public_api/payments/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cakto.com.br/public_api/payments/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer' => [
        'name' => '<string>',
        'email' => 'jsmith@example.com',
        'phone' => '<string>',
        'birthDate' => '2023-12-25',
        'docType' => '<string>',
        'docNumber' => '<string>',
        'ip' => '<string>',
        'fingerprint' => '<string>'
    ],
    'items' => [
        [
                'offerId' => '<string>',
                'quantity' => 1,
                'offerType' => 'main',
                'installments' => 6
        ]
    ],
    'address' => [
        'country' => '<string>',
        'state' => '<string>',
        'city' => '<string>',
        'zipcode' => '<string>',
        'street' => '<string>',
        'number' => '<string>',
        'neighborhood' => '<string>',
        'complement' => '<string>'
    ],
    'affiliateShortId' => '<string>',
    'coupon' => '<string>',
    'metadata' => [
        'utm_source' => '<string>',
        'utm_medium' => '<string>',
        'utm_campaign' => '<string>',
        'utm_term' => '<string>',
        'utm_content' => '<string>',
        'sck' => '<string>'
    ],
    'dueDate' => '2023-12-25',
    'pixExpiresIn' => 61,
    'card' => [
        'token' => '<string>'
    ],
    'threeDSecure' => [
        'cavv' => '<string>',
        'eci' => '<string>',
        'xid' => '<string>',
        'referenceId' => '<string>',
        'version' => '<string>',
        'dataOnly' => false
    ],
    'installments' => 6,
    'antifraud_profiling_attempt_reference' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Idempotency-Key: <x-idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.cakto.com.br/public_api/payments/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Idempotency-Key"] = '<x-idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"phone\": \"<string>\",\n    \"birthDate\": \"2023-12-25\",\n    \"docType\": \"<string>\",\n    \"docNumber\": \"<string>\",\n    \"ip\": \"<string>\",\n    \"fingerprint\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"offerId\": \"<string>\",\n      \"quantity\": 1,\n      \"offerType\": \"main\",\n      \"installments\": 6\n    }\n  ],\n  \"address\": {\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipcode\": \"<string>\",\n    \"street\": \"<string>\",\n    \"number\": \"<string>\",\n    \"neighborhood\": \"<string>\",\n    \"complement\": \"<string>\"\n  },\n  \"affiliateShortId\": \"<string>\",\n  \"coupon\": \"<string>\",\n  \"metadata\": {\n    \"utm_source\": \"<string>\",\n    \"utm_medium\": \"<string>\",\n    \"utm_campaign\": \"<string>\",\n    \"utm_term\": \"<string>\",\n    \"utm_content\": \"<string>\",\n    \"sck\": \"<string>\"\n  },\n  \"dueDate\": \"2023-12-25\",\n  \"pixExpiresIn\": 61,\n  \"card\": {\n    \"token\": \"<string>\"\n  },\n  \"threeDSecure\": {\n    \"cavv\": \"<string>\",\n    \"eci\": \"<string>\",\n    \"xid\": \"<string>\",\n    \"referenceId\": \"<string>\",\n    \"version\": \"<string>\",\n    \"dataOnly\": false\n  },\n  \"installments\": 6,\n  \"antifraud_profiling_attempt_reference\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

HttpResponse<String> response = Unirest.post("https://api.cakto.com.br/public_api/payments/")
  .header("X-Idempotency-Key", "<x-idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"phone\": \"<string>\",\n    \"birthDate\": \"2023-12-25\",\n    \"docType\": \"<string>\",\n    \"docNumber\": \"<string>\",\n    \"ip\": \"<string>\",\n    \"fingerprint\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"offerId\": \"<string>\",\n      \"quantity\": 1,\n      \"offerType\": \"main\",\n      \"installments\": 6\n    }\n  ],\n  \"address\": {\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipcode\": \"<string>\",\n    \"street\": \"<string>\",\n    \"number\": \"<string>\",\n    \"neighborhood\": \"<string>\",\n    \"complement\": \"<string>\"\n  },\n  \"affiliateShortId\": \"<string>\",\n  \"coupon\": \"<string>\",\n  \"metadata\": {\n    \"utm_source\": \"<string>\",\n    \"utm_medium\": \"<string>\",\n    \"utm_campaign\": \"<string>\",\n    \"utm_term\": \"<string>\",\n    \"utm_content\": \"<string>\",\n    \"sck\": \"<string>\"\n  },\n  \"dueDate\": \"2023-12-25\",\n  \"pixExpiresIn\": 61,\n  \"card\": {\n    \"token\": \"<string>\"\n  },\n  \"threeDSecure\": {\n    \"cavv\": \"<string>\",\n    \"eci\": \"<string>\",\n    \"xid\": \"<string>\",\n    \"referenceId\": \"<string>\",\n    \"version\": \"<string>\",\n    \"dataOnly\": false\n  },\n  \"installments\": 6,\n  \"antifraud_profiling_attempt_reference\": \"<string>\"\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.cakto.com.br/public_api/payments/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-Idempotency-Key", "<x-idempotency-key>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"phone\": \"<string>\",\n    \"birthDate\": \"2023-12-25\",\n    \"docType\": \"<string>\",\n    \"docNumber\": \"<string>\",\n    \"ip\": \"<string>\",\n    \"fingerprint\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"offerId\": \"<string>\",\n      \"quantity\": 1,\n      \"offerType\": \"main\",\n      \"installments\": 6\n    }\n  ],\n  \"address\": {\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipcode\": \"<string>\",\n    \"street\": \"<string>\",\n    \"number\": \"<string>\",\n    \"neighborhood\": \"<string>\",\n    \"complement\": \"<string>\"\n  },\n  \"affiliateShortId\": \"<string>\",\n  \"coupon\": \"<string>\",\n  \"metadata\": {\n    \"utm_source\": \"<string>\",\n    \"utm_medium\": \"<string>\",\n    \"utm_campaign\": \"<string>\",\n    \"utm_term\": \"<string>\",\n    \"utm_content\": \"<string>\",\n    \"sck\": \"<string>\"\n  },\n  \"dueDate\": \"2023-12-25\",\n  \"pixExpiresIn\": 61,\n  \"card\": {\n    \"token\": \"<string>\"\n  },\n  \"threeDSecure\": {\n    \"cavv\": \"<string>\",\n    \"eci\": \"<string>\",\n    \"xid\": \"<string>\",\n    \"referenceId\": \"<string>\",\n    \"version\": \"<string>\",\n    \"dataOnly\": false\n  },\n  \"installments\": 6,\n  \"antifraud_profiling_attempt_reference\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "id": "10bb51bb-03be-473c-b4c5-3490765c4096",
  "refId": "CATDiPp",
  "status": "waiting_payment",
  "paymentMethod": "pix",
  "amount": "49.90",
  "baseAmount": "49.90",
  "discount": "0.00",
  "fees": "0.00",
  "externalId": "7e1f0d37-9b5f-4f1f-bf7c-2bd4f97f9d23",
  "product": {
    "id": "cd287b31-d4b7-4e94-858a-66e05ce2f4a2",
    "short_id": "19bruPi",
    "name": "Product Name Example"
  },
  "offer": {
    "id": "77BcHrY",
    "name": "Product Name Example",
    "price": 49.9
  },
  "pix": {
    "qrCode": "00020126360014BR.GOV.BCB.PIX0114+5511999999999...",
    "expirationDate": "2026-04-29 01:30:00+00:00",
    "user_journey": null
  },
  "checkoutUrl": "https://pay.cakto.com.br/EXAMPLE",
  "createdAt": "2026-04-28T23:30:00-03:00"
}

POST

public_api

payments

cURL

curl --request POST \
  --url https://api.cakto.com.br/public_api/payments/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --data '
{
  "customer": {
    "name": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "birthDate": "2023-12-25",
    "docType": "<string>",
    "docNumber": "<string>",
    "ip": "<string>",
    "fingerprint": "<string>"
  },
  "items": [
    {
      "offerId": "<string>",
      "quantity": 1,
      "offerType": "main",
      "installments": 6
    }
  ],
  "address": {
    "country": "<string>",
    "state": "<string>",
    "city": "<string>",
    "zipcode": "<string>",
    "street": "<string>",
    "number": "<string>",
    "neighborhood": "<string>",
    "complement": "<string>"
  },
  "affiliateShortId": "<string>",
  "coupon": "<string>",
  "metadata": {
    "utm_source": "<string>",
    "utm_medium": "<string>",
    "utm_campaign": "<string>",
    "utm_term": "<string>",
    "utm_content": "<string>",
    "sck": "<string>"
  },
  "dueDate": "2023-12-25",
  "pixExpiresIn": 61,
  "card": {
    "token": "<string>"
  },
  "threeDSecure": {
    "cavv": "<string>",
    "eci": "<string>",
    "xid": "<string>",
    "referenceId": "<string>",
    "version": "<string>",
    "dataOnly": false
  },
  "installments": 6,
  "antifraud_profiling_attempt_reference": "<string>"
}
'

import requests

url = "https://api.cakto.com.br/public_api/payments/"

payload = {
    "customer": {
        "name": "<string>",
        "email": "jsmith@example.com",
        "phone": "<string>",
        "birthDate": "2023-12-25",
        "docType": "<string>",
        "docNumber": "<string>",
        "ip": "<string>",
        "fingerprint": "<string>"
    },
    "items": [
        {
            "offerId": "<string>",
            "quantity": 1,
            "offerType": "main",
            "installments": 6
        }
    ],
    "address": {
        "country": "<string>",
        "state": "<string>",
        "city": "<string>",
        "zipcode": "<string>",
        "street": "<string>",
        "number": "<string>",
        "neighborhood": "<string>",
        "complement": "<string>"
    },
    "affiliateShortId": "<string>",
    "coupon": "<string>",
    "metadata": {
        "utm_source": "<string>",
        "utm_medium": "<string>",
        "utm_campaign": "<string>",
        "utm_term": "<string>",
        "utm_content": "<string>",
        "sck": "<string>"
    },
    "dueDate": "2023-12-25",
    "pixExpiresIn": 61,
    "card": { "token": "<string>" },
    "threeDSecure": {
        "cavv": "<string>",
        "eci": "<string>",
        "xid": "<string>",
        "referenceId": "<string>",
        "version": "<string>",
        "dataOnly": False
    },
    "installments": 6,
    "antifraud_profiling_attempt_reference": "<string>"
}
headers = {
    "X-Idempotency-Key": "<x-idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency-Key': '<x-idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    customer: {
      name: '<string>',
      email: 'jsmith@example.com',
      phone: '<string>',
      birthDate: '2023-12-25',
      docType: '<string>',
      docNumber: '<string>',
      ip: '<string>',
      fingerprint: '<string>'
    },
    items: [{offerId: '<string>', quantity: 1, offerType: 'main', installments: 6}],
    address: {
      country: '<string>',
      state: '<string>',
      city: '<string>',
      zipcode: '<string>',
      street: '<string>',
      number: '<string>',
      neighborhood: '<string>',
      complement: '<string>'
    },
    affiliateShortId: '<string>',
    coupon: '<string>',
    metadata: {
      utm_source: '<string>',
      utm_medium: '<string>',
      utm_campaign: '<string>',
      utm_term: '<string>',
      utm_content: '<string>',
      sck: '<string>'
    },
    dueDate: '2023-12-25',
    pixExpiresIn: 61,
    card: {token: '<string>'},
    threeDSecure: {
      cavv: '<string>',
      eci: '<string>',
      xid: '<string>',
      referenceId: '<string>',
      version: '<string>',
      dataOnly: false
    },
    installments: 6,
    antifraud_profiling_attempt_reference: '<string>'
  })
};

fetch('https://api.cakto.com.br/public_api/payments/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cakto.com.br/public_api/payments/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer' => [
        'name' => '<string>',
        'email' => 'jsmith@example.com',
        'phone' => '<string>',
        'birthDate' => '2023-12-25',
        'docType' => '<string>',
        'docNumber' => '<string>',
        'ip' => '<string>',
        'fingerprint' => '<string>'
    ],
    'items' => [
        [
                'offerId' => '<string>',
                'quantity' => 1,
                'offerType' => 'main',
                'installments' => 6
        ]
    ],
    'address' => [
        'country' => '<string>',
        'state' => '<string>',
        'city' => '<string>',
        'zipcode' => '<string>',
        'street' => '<string>',
        'number' => '<string>',
        'neighborhood' => '<string>',
        'complement' => '<string>'
    ],
    'affiliateShortId' => '<string>',
    'coupon' => '<string>',
    'metadata' => [
        'utm_source' => '<string>',
        'utm_medium' => '<string>',
        'utm_campaign' => '<string>',
        'utm_term' => '<string>',
        'utm_content' => '<string>',
        'sck' => '<string>'
    ],
    'dueDate' => '2023-12-25',
    'pixExpiresIn' => 61,
    'card' => [
        'token' => '<string>'
    ],
    'threeDSecure' => [
        'cavv' => '<string>',
        'eci' => '<string>',
        'xid' => '<string>',
        'referenceId' => '<string>',
        'version' => '<string>',
        'dataOnly' => false
    ],
    'installments' => 6,
    'antifraud_profiling_attempt_reference' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Idempotency-Key: <x-idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://api.cakto.com.br/public_api/payments/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Idempotency-Key"] = '<x-idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"phone\": \"<string>\",\n    \"birthDate\": \"2023-12-25\",\n    \"docType\": \"<string>\",\n    \"docNumber\": \"<string>\",\n    \"ip\": \"<string>\",\n    \"fingerprint\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"offerId\": \"<string>\",\n      \"quantity\": 1,\n      \"offerType\": \"main\",\n      \"installments\": 6\n    }\n  ],\n  \"address\": {\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipcode\": \"<string>\",\n    \"street\": \"<string>\",\n    \"number\": \"<string>\",\n    \"neighborhood\": \"<string>\",\n    \"complement\": \"<string>\"\n  },\n  \"affiliateShortId\": \"<string>\",\n  \"coupon\": \"<string>\",\n  \"metadata\": {\n    \"utm_source\": \"<string>\",\n    \"utm_medium\": \"<string>\",\n    \"utm_campaign\": \"<string>\",\n    \"utm_term\": \"<string>\",\n    \"utm_content\": \"<string>\",\n    \"sck\": \"<string>\"\n  },\n  \"dueDate\": \"2023-12-25\",\n  \"pixExpiresIn\": 61,\n  \"card\": {\n    \"token\": \"<string>\"\n  },\n  \"threeDSecure\": {\n    \"cavv\": \"<string>\",\n    \"eci\": \"<string>\",\n    \"xid\": \"<string>\",\n    \"referenceId\": \"<string>\",\n    \"version\": \"<string>\",\n    \"dataOnly\": false\n  },\n  \"installments\": 6,\n  \"antifraud_profiling_attempt_reference\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

HttpResponse<String> response = Unirest.post("https://api.cakto.com.br/public_api/payments/")
  .header("X-Idempotency-Key", "<x-idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"phone\": \"<string>\",\n    \"birthDate\": \"2023-12-25\",\n    \"docType\": \"<string>\",\n    \"docNumber\": \"<string>\",\n    \"ip\": \"<string>\",\n    \"fingerprint\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"offerId\": \"<string>\",\n      \"quantity\": 1,\n      \"offerType\": \"main\",\n      \"installments\": 6\n    }\n  ],\n  \"address\": {\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipcode\": \"<string>\",\n    \"street\": \"<string>\",\n    \"number\": \"<string>\",\n    \"neighborhood\": \"<string>\",\n    \"complement\": \"<string>\"\n  },\n  \"affiliateShortId\": \"<string>\",\n  \"coupon\": \"<string>\",\n  \"metadata\": {\n    \"utm_source\": \"<string>\",\n    \"utm_medium\": \"<string>\",\n    \"utm_campaign\": \"<string>\",\n    \"utm_term\": \"<string>\",\n    \"utm_content\": \"<string>\",\n    \"sck\": \"<string>\"\n  },\n  \"dueDate\": \"2023-12-25\",\n  \"pixExpiresIn\": 61,\n  \"card\": {\n    \"token\": \"<string>\"\n  },\n  \"threeDSecure\": {\n    \"cavv\": \"<string>\",\n    \"eci\": \"<string>\",\n    \"xid\": \"<string>\",\n    \"referenceId\": \"<string>\",\n    \"version\": \"<string>\",\n    \"dataOnly\": false\n  },\n  \"installments\": 6,\n  \"antifraud_profiling_attempt_reference\": \"<string>\"\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.cakto.com.br/public_api/payments/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-Idempotency-Key", "<x-idempotency-key>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"customer\": {\n    \"name\": \"<string>\",\n    \"email\": \"jsmith@example.com\",\n    \"phone\": \"<string>\",\n    \"birthDate\": \"2023-12-25\",\n    \"docType\": \"<string>\",\n    \"docNumber\": \"<string>\",\n    \"ip\": \"<string>\",\n    \"fingerprint\": \"<string>\"\n  },\n  \"items\": [\n    {\n      \"offerId\": \"<string>\",\n      \"quantity\": 1,\n      \"offerType\": \"main\",\n      \"installments\": 6\n    }\n  ],\n  \"address\": {\n    \"country\": \"<string>\",\n    \"state\": \"<string>\",\n    \"city\": \"<string>\",\n    \"zipcode\": \"<string>\",\n    \"street\": \"<string>\",\n    \"number\": \"<string>\",\n    \"neighborhood\": \"<string>\",\n    \"complement\": \"<string>\"\n  },\n  \"affiliateShortId\": \"<string>\",\n  \"coupon\": \"<string>\",\n  \"metadata\": {\n    \"utm_source\": \"<string>\",\n    \"utm_medium\": \"<string>\",\n    \"utm_campaign\": \"<string>\",\n    \"utm_term\": \"<string>\",\n    \"utm_content\": \"<string>\",\n    \"sck\": \"<string>\"\n  },\n  \"dueDate\": \"2023-12-25\",\n  \"pixExpiresIn\": 61,\n  \"card\": {\n    \"token\": \"<string>\"\n  },\n  \"threeDSecure\": {\n    \"cavv\": \"<string>\",\n    \"eci\": \"<string>\",\n    \"xid\": \"<string>\",\n    \"referenceId\": \"<string>\",\n    \"version\": \"<string>\",\n    \"dataOnly\": false\n  },\n  \"installments\": 6,\n  \"antifraud_profiling_attempt_reference\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "id": "10bb51bb-03be-473c-b4c5-3490765c4096",
  "refId": "CATDiPp",
  "status": "waiting_payment",
  "paymentMethod": "pix",
  "amount": "49.90",
  "baseAmount": "49.90",
  "discount": "0.00",
  "fees": "0.00",
  "externalId": "7e1f0d37-9b5f-4f1f-bf7c-2bd4f97f9d23",
  "product": {
    "id": "cd287b31-d4b7-4e94-858a-66e05ce2f4a2",
    "short_id": "19bruPi",
    "name": "Product Name Example"
  },
  "offer": {
    "id": "77BcHrY",
    "name": "Product Name Example",
    "price": 49.9
  },
  "pix": {
    "qrCode": "00020126360014BR.GOV.BCB.PIX0114+5511999999999...",
    "expirationDate": "2026-04-29 01:30:00+00:00",
    "user_journey": null
  },
  "checkoutUrl": "https://pay.cakto.com.br/EXAMPLE",
  "createdAt": "2026-04-28T23:30:00-03:00"
}

Visão geral

O Pix Automático (pix_auto) é um método de pagamento recorrente baseado na especificação de Pix Automático do Banco Central do Brasil. O fluxo é diferente de uma cobrança Pix comum:

Primeira cobrança: sua aplicação chama este endpoint, a Cakto cria o contrato de recorrência junto à adquirente e retorna um QR Code. O cliente escaneia o QR Code no app do banco para autorizar os débitos automáticos futuros.
Cobranças seguintes: são debitadas automaticamente, sem ação do cliente.

A resposta inclui o campo user_journey, que indica a jornada de autorização definida pelo banco do cliente conforme a especificação do BCB (JORNADA_1 a JORNADA_4). Sua aplicação deve exibir o QR Code e aguardar o evento de webhook purchase_approved para confirmar a autorização.

Nenhum método Pix retorna imagem do QR Code. Apenas qrCode (copia-e-cola) está disponível na resposta — gere a imagem no seu lado a partir desse texto.

Autenticação

Todas as requisições exigem um token OAuth2 válido obtido em POST /public_api/token/.

Header	Obrigatório	Descrição
`Authorization`	Sim	`Bearer <access_token>`.
`Content-Type`	Sim	`application/json`.
`X-Idempotency-Key`	Sim	Identificador único da cobrança (até 255 caracteres). Recomendado UUID v4.

Escopo

write payments

A Chave de API utilizada deve ter o escopo payments habilitado. Configure no Painel Cakto.

Pré-requisitos

Pix Automático exige conta Cakto Banking. Pix Automático (pix_auto), Pix (pix) e Boleto (boleto) liquidam em uma conta Cakto Banking do produtor. Sem essa conta, a autorização é rejeitada com 400 antes de o contrato de recorrência ser criado na adquirente.Cartão (credit_card, threeDs) não exige conta Banking e continua funcionando normalmente.

A conta precisa atender às quatro condições ao mesmo tempo:

abertura concluída — a proposta chegou até o fim; conta em análise, em documentoscopia ou com proposta apenas aprovada ainda não vale;
ativa;
principal do produtor;
fora de encerramento — encerramento solicitado ou concluído invalida a conta, mesmo que ela ainda apareça como ativa.

Confira o status em Painel Cakto. A API pública (/public_api/) não expõe o status dessa conta — não há endpoint para consultá-lo antes de cobrar.

Idempotência

O header X-Idempotency-Key é obrigatório e permite reenviar a mesma requisição com segurança em caso de instabilidade de rede, sem criar contratos de recorrência duplicados.

Reuso com payload idêntico

A resposta original é devolvida (mesmo id e mesmo status HTTP). A autorização não é recriada. Janela de retenção: 24 horas.

Reuso com payload diferente

Resposta 409 Conflict com a mensagem Header X-Idempotency-Key reutilizado com payload diferente. Use uma nova chave para a nova cobrança.

Reuso enquanto a requisição original ainda processa

Resposta 409 Conflict com a mensagem Requisição idempotente em processamento. Aguarde a primeira finalizar.

Falha do servidor (5xx)

A chave é liberada automaticamente. A próxima retentativa com o mesmo header executa normalmente.

Gere a chave antes de chamar o endpoint e persista-a junto da operação de negócio. Use a mesma chave em todas as retentativas dessa operação.

Rate limit

Critério	Padrão
Por IP de origem	60 requisições / minuto
Por token de acesso	120 requisições / minuto

Ao exceder qualquer um dos limites, a resposta é 429 Too Many Requests com o header Retry-After indicando os segundos restantes.

Corpo da requisição

Resumo dos campos

Campo	Tipo	Obrigatório
`paymentMethod`	`"pix_auto"`	Sim
`customer`	object	Sim
`customer.name`	string	Sim
`customer.email`	string	Sim
`customer.phone`	string	Sim
`customer.fingerprint`	string	Sim
`customer.docType`	enum (`cpf`, `cnpj`)	Não (obrigatório na prática)
`customer.docNumber`	string	Não (obrigatório na prática)
`customer.birthDate`	string (ISO 8601)	Não
`customer.ip`	string	Não
`items` (exatamente 1 item)	array	Sim
`items[].offerId`	string	Sim
`items[].quantity`	integer	Não (default `1`)
`items[].offerType`	enum (`main`)	Não (default `main`)
`address`	object	Não (obrigatório se o produto exige entrega física)
`affiliateShortId`	string	Não
`coupon`	string	Não
`metadata`	object	Não
`pixExpiresIn`	integer (segundos)	Não (respeita o limite do produto)

Detalhamento dos campos

enum<string>

required

Deve ser "pix_auto" para iniciar uma autorização de débito automático via Pix Automático.

object

required

Dados do pagador. O docType e docNumber são exigidos pelas adquirentes para criação do contrato de recorrência.

Show Campos

string

required

Nome completo do pagador.

string

required

E-mail do pagador.

string

required

Telefone do pagador no formato E.164 (5511999999999).

string

required

Identificador estável do dispositivo/sessão do pagador. Deve ser uma string não vazia e consistente para a mesma sessão.

enum<string>

Tipo de documento do pagador. Valores aceitos: cpf, cnpj.

Para Pix Automático, docType e docNumber são exigidos pela adquirente para criar o contrato de recorrência. A omissão pode causar falha no processamento.

string

Número do documento (somente dígitos).

string

Data de nascimento no formato ISO 8601 (YYYY-MM-DD).

string

IP do pagador. Quando omitido, a Cakto utiliza o IP de origem da requisição.

array<object>

required

Itens da cobrança. Deve conter exatamente um item.

Show Campos do item

string

required

id da oferta cadastrada. A oferta deve estar com status active e pertencer à sua conta. O produto é resolvido automaticamente a partir da oferta e deve ter pix_auto habilitado nos métodos de pagamento.

integer

default:"1"

Quantidade vendida da oferta. Mínimo 1.

enum<string>

default:"main"

Tipo da oferta dentro do funil. Apenas main é aceito.

object

Endereço do pagador. Obrigatório quando o produto exige entrega física.

Show Campos

string

default:"BR"

País no formato ISO 3166-1 alpha-2.

string

required

UF (duas letras), por exemplo SP.

string

required

string

required

CEP, somente dígitos.

string

required

string

required

string

required

string

short_id do afiliado responsável pela venda. Deve estar active e cadastrado para o produto.

string

Código do cupom de desconto. Até 255 caracteres.

object

Parâmetros de rastreio associados à cobrança.

Show Campos

string

integer

Expiração do QR Code de autorização em segundos. Mínimo 60. Deve respeitar o limite máximo configurado no produto (pixExpiresIn).O valor é repassado à adquirente que processar a autorização. Se ela impuser um limite próprio, vale o dela — confira sempre o pix.expirationDate devolvido na resposta. Omitindo o campo, vale o padrão da adquirente.

Resposta de sucesso

201 Created

string

Identificador único do pedido criado.

string

Código curto de referência do pedido.

string

Status inicial. Normalmente waiting_payment — aguardando o cliente escanear e autorizar o QR Code.

string

Método de pagamento confirmado: pix_auto.

string

Valor da primeira cobrança, em reais, como string decimal.

string

Valor base da oferta, antes de descontos.

string

Valor de desconto aplicado.

string

Taxas aplicadas pela Cakto, já consolidadas.

string

Identificador da transação na adquirente.

string

URL do checkout Cakto.

string<date-time>

Timestamp ISO 8601 com fuso horário.

object

Resumo do produto associado.

Show Campos

string

object

Resumo da oferta cobrada.

Show Campos

string

number

object

Dados da autorização Pix Automático. Contém apenas o código copia-e-cola — a API não devolve imagem do QR Code.

Show Campos

string

Código copia-e-cola (BR Code) para o cliente escanear e autorizar os débitos automáticos futuros.

string

Data e hora de expiração do QR Code de autorização.

string

Jornada de autorização definida pelo BCB para o banco do cliente. Valores possíveis: JORNADA_1, JORNADA_2, JORNADA_3, JORNADA_4. Determinado automaticamente pela adquirente — não precisa ser enviado na requisição.

Exemplo de resposta

Pix Automático

{
  "id": "30dd73dd-25dg-695e-d6e7-5612987e6218",
  "refId": "PIXaUTo",
  "status": "waiting_payment",
  "paymentMethod": "pix_auto",
  "amount": "49.90",
  "baseAmount": "49.90",
  "discount": "0.00",
  "fees": "0.00",
  "externalId": "txid-gerado-pela-adquirente",
  "checkoutUrl": "https://pay.cakto.com.br/PIXaUTo",
  "createdAt": "2026-04-28T23:30:00-03:00",
  "product": {
    "id": "cd287b31-d4b7-4e94-858a-66e05ce2f4a2",
    "short_id": "19bruPi",
    "name": "Cakto Pro Plan"
  },
  "offer": {
    "id": "77BcHrY",
    "name": "Plano Mensal",
    "price": 49.9
  },
  "pix": {
    "qrCode": "00020126360014BR.GOV.BCB.PIX0114+5511999999999...",
    "expirationDate": "2026-04-29 01:30:00+00:00",
    "user_journey": "JORNADA_1"
  }
}

Respostas de erro

Código	Quando ocorre	Corpo de exemplo
`400`	Header `X-Idempotency-Key` ausente, vazio ou maior que 255 caracteres.	`{ "detail": "Header X-Idempotency-Key é obrigatório." }`
`400`	`paymentMethod` ausente ou fora da lista aceita.	`{ "paymentMethod": ["Método de pagamento não suportado."] }`
`400`	Oferta inexistente, inativa ou de outro tenant.	`{ "items": ["Oferta não encontrada."] }`
`400`	`pixExpiresIn` acima do limite do produto.	`{ "pixExpiresIn": ["A expiração do Pix excede o limite do produto (3600 segundo(s))."] }`
`400`	Produtor sem conta Cakto Banking válida (só afeta `pix`, `pix_auto` e `boleto`). Veja Pré-requisitos.	`{ "paymentMethod": ["Pix, Pix Automático e boleto só podem ser cobrados por produtores com conta Cakto Banking aberta, ativa e fora de encerramento — é nela que esses métodos liquidam. Confira o status da conta no Painel Cakto (https://app.cakto.com.br/dashboard); se a abertura não foi concluída, conclua-a. Cobranças com cartão (credit_card, threeDs) não dependem dessa conta e seguem disponíveis."] }`
`400`	Conta do produtor bloqueada.	`{ "detail": "Conta bloqueada." }`
`401`	Token ausente, inválido ou expirado.	`{ "detail": "As credenciais de autenticação não foram fornecidas." }`
`403`	Chave de API sem escopo `payments`.	`{ "detail": "Você não tem permissão para executar esta ação." }`
`409`	`X-Idempotency-Key` reutilizado com payload diferente.	`{ "detail": "Header X-Idempotency-Key reutilizado com payload diferente." }`
`409`	`X-Idempotency-Key` em processamento.	`{ "detail": "Requisição idempotente em processamento." }`
`429`	Rate limit excedido.	`{ "detail": "Request was throttled. Expected available in 60 seconds." }`

Erros 5xx indicam falha temporária da Cakto. A chave de idempotência é liberada automaticamente — a próxima retentativa executa normalmente.

Exemplo de requisição

curl -X POST 'https://api.cakto.com.br/public_api/payments/' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn...' \
  -H 'Content-Type: application/json' \
  -H 'X-Idempotency-Key: 9c2b4e7f-ae5g-5g2g-cg8d-3ce5g08gae34' \
  -d '{
    "paymentMethod": "pix_auto",
    "customer": {
      "name": "Maria Souza",
      "email": "maria@example.com",
      "phone": "5511999999999",
      "fingerprint": "fp_2f8c1e5e-1aa8-4d4d-b9d4-19f7e5e0e1ab",
      "docType": "cpf",
      "docNumber": "12345678909"
    },
    "items": [
      { "offerId": "77BcHrY", "quantity": 1, "offerType": "main" }
    ],
    "pixExpiresIn": 3600,
    "metadata": {
      "utm_source": "facebook",
      "utm_campaign": "lancamento-mai"
    }
  }'

import uuid
import requests

response = requests.post(
    "https://api.cakto.com.br/public_api/payments/",
    headers={
        "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsIn...",
        "Content-Type": "application/json",
        "X-Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "paymentMethod": "pix_auto",
        "customer": {
            "name": "Maria Souza",
            "email": "maria@example.com",
            "phone": "5511999999999",
            "fingerprint": "fp_2f8c1e5e-1aa8-4d4d-b9d4-19f7e5e0e1ab",
            "docType": "cpf",
            "docNumber": "12345678909",
        },
        "items": [
            {"offerId": "77BcHrY", "quantity": 1, "offerType": "main"}
        ],
        "pixExpiresIn": 3600,
        "metadata": {
            "utm_source": "facebook",
            "utm_campaign": "lancamento-mai",
        },
    },
    timeout=30,
)

response.raise_for_status()
payment = response.json()

# Exiba o QR Code para o cliente autorizar os débitos automáticos
print(payment["pix"]["qrCode"])
print(payment["pix"]["user_journey"])

import { randomUUID } from "node:crypto";

const response = await fetch("https://api.cakto.com.br/public_api/payments/", {
  method: "POST",
  headers: {
    Authorization: "Bearer eyJhbGciOiJIUzI1NiIsIn...",
    "Content-Type": "application/json",
    "X-Idempotency-Key": randomUUID(),
  },
  body: JSON.stringify({
    paymentMethod: "pix_auto",
    customer: {
      name: "Maria Souza",
      email: "maria@example.com",
      phone: "5511999999999",
      fingerprint: "fp_2f8c1e5e-1aa8-4d4d-b9d4-19f7e5e0e1ab",
      docType: "cpf",
      docNumber: "12345678909",
    },
    items: [{ offerId: "77BcHrY", quantity: 1, offerType: "main" }],
    pixExpiresIn: 3600,
    metadata: {
      utm_source: "facebook",
      utm_campaign: "lancamento-mai",
    },
  }),
});

if (!response.ok) throw new Error(`Cakto API error ${response.status}`);

const payment = await response.json();

// Exiba o QR Code para o cliente autorizar os débitos automáticos
console.log(payment.pix.qrCode);
console.log(payment.pix.user_journey);

Fluxo de autorização

Boas práticas

Exiba apenas pix.qrCode (texto copia-e-cola) — a API não retorna imagem base64 em nenhum método Pix; gere a imagem no seu lado.
Aguarde o webhook purchase_approved para confirmar que o cliente autorizou os débitos. Não ative o acesso ao produto antes da confirmação.
docType e docNumber são essenciais — sem eles a adquirente pode rejeitar a criação do contrato de recorrência.
Persista o id retornado para conciliar com webhooks e com GET /public_api/orders/{id}/.
Não reuse a chave de idempotência em situações distintas — uma nova intenção de assinatura exige uma nova chave.

Authorizations

Authorization

string

header

required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Headers

X-Idempotency-Key

string

required

Identificador único por cobrança. Reuso com payload idêntico devolve a mesma resposta (24h). Máximo de 255 caracteres; recomenda-se UUID v4.

Body

paymentMethod

enum<string>

required

Método de pagamento.

pix - pix
pix_auto - pix_auto
boleto - boleto
credit_card - credit_card
threeDs - threeDs

Available options:

pix,

pix_auto,

boleto,

credit_card,

threeDs

customer

object

required

Dados do pagador. CPF e CPNJ aceitos conforme contrato existente do checkout.

Show child attributes

items

object[]

required

Deve conter exatamente um item.

Show child attributes

address

object | null

Endereço do pagador. Obrigatório quando o produto exige envio físico.

Show child attributes

affiliateShortId

string

short_id do afiliado responsável pela venda, usado para resolver o split interno. Deve estar com status active e cadastrado para o produto informado.

Maximum string length: 40

coupon

string

Código do cupom de desconto.

Maximum string length: 255

metadata

object

Optional UTM/tracking metadata associated with the payment.

Show child attributes

dueDate

string<date>

Somente para boleto. Data de vencimento (YYYY-MM-DD). Deve ser futura e respeitar o ticketExpiration do produto.

pixExpiresIn

integer

Somente para pix e pix_auto. Expiração do código Pix em segundos. Mínimo 60. Deve respeitar o pixExpiresIn do produto.

Required range: x >= 60

card

object

Dados do cartão de crédito. Obrigatório quando paymentMethod é credit_card ou threeDs.

Show child attributes

threeDSecure

object

Dados de autenticação 3DS. Opcional para credit_card; recomendado para threeDs.

Show child attributes

installments

integer | null

Número de parcelas. Aplicável apenas para pagamentos com cartão de crédito.

Required range: 1 <= x <= 12

antifraud_profiling_attempt_reference

string

Referência de profiling do antifraude. Obrigatório para credit_card e threeDs; deve ser o mesmo attemptReference usado ao inicializar o profiler no navegador.

Response

Corpo da resposta status 201

Cobrança criada pelo endpoint público.

string

Identificador único do pedido criado.

refId

string | null

Código curto de referência do pedido.

status

string | null

Status inicial do pedido. Para Pix e Boleto, normalmente waiting_payment.

paymentMethod

enum<string>

Método de pagamento da cobrança, ecoando o valor enviado na requisição.

pix - pix
pix_auto - pix_auto
boleto - boleto
credit_card - credit_card
threeDs - threeDs

Available options:

pix,

pix_auto,

boleto,

credit_card,

threeDs

amount

string

Valor final cobrado, em reais, como string decimal.

baseAmount

string | null

Valor da oferta antes de descontos.

discount

string | null

Desconto aplicado.

fees

string | null

Taxas da transação.

externalId

string | null

Identificador da transação no provedor.

checkoutUrl

string | null

URL do checkout Cakto.

createdAt

string<date-time> | null

Data e hora de criação da cobrança.

product

object

Produto resolvido a partir da oferta enviada.

Show child attributes

offer

object

Oferta cobrada. Campos vazios no checkout são preenchidos com a oferta validada.

Show child attributes

pix

object

Presente apenas para pix e pix_auto.

Show child attributes

boleto

object

Presente apenas para boleto.

Show child attributes

Comece aqui

Conceitos

Cakto SDK

CaktoMCP

Pagamentos

Pedidos

Webhooks

Produtos

Checkouts

Ofertas

Order Bumps

Clientes

Taxas e Prazos

Juro de Parcelamento

Assinaturas

Criar Cobrança Pix Automático

Visão geral

Autenticação

Escopo

Pré-requisitos

Idempotência

Rate limit

Corpo da requisição

Resumo dos campos

Detalhamento dos campos

Resposta de sucesso

Exemplo de resposta

Respostas de erro

Exemplo de requisição

Fluxo de autorização

Boas práticas

Authorizations

Headers

Body

Response

​Visão geral

​Autenticação

​Escopo

​Pré-requisitos

​Idempotência

​Rate limit

​Corpo da requisição

​Resumo dos campos

​Detalhamento dos campos

​Resposta de sucesso

​Exemplo de resposta

​Respostas de erro

​Exemplo de requisição

​Fluxo de autorização

​Boas práticas

Authorizations

Headers

Body

Response

Visão geral

Autenticação

Escopo

Pré-requisitos

Idempotência

Rate limit

Corpo da requisição

Resumo dos campos

Detalhamento dos campos

Resposta de sucesso

Exemplo de resposta

Respostas de erro

Exemplo de requisição

Fluxo de autorização

Boas práticas