Create payment

POST

/api/public/checkout/payment/{id}

💳 Realizar Pagamento do Pedido de Checkout

Este endpoint permite criar o pagamento de um pedido de checkout específico utilizando o ID do link.

✅ Requisitos da Requisição

Método HTTP: POST

Endpoint: /api/public/checkout/payment/{id}

Content-Type: application/json

🧠 Header da requisição

Campo	Tipo	Obrigatório	Descrição
`x-api-key`	string	Sim	Token de autenticação API Key
`User-Agent`	AtivoB2B/1.0	Sim

⚙️ Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID do link do pedido de checkout.
`hostname`	string	Não	O domínio do link a ser consultado.

Exemplo de ID: e653ca6c-479c-4aab-8935-6f542e97ead0

Request

Path Params

Query Params

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/public/checkout/payment/e653ca6c-479c-4aab-8935-6f542e97ead0?hostname=hostname.com' \
--header 'x-api-key: {Token}' \
--header 'User-Agent: AtivoB2B/1.0' \
--header 'Content-Type: application/json' \
--data-raw '{
  "card": {
    "number": "1234567890123456",
    "holderName": "John Doe",
    "expirationMonth": 12,
    "expirationYear": 2024,
    "cvv": "123"
  },
  "fullName": "John Doe",
  "document": "99999999999",
  "email": "john.doe@example.com",
  "phone": "1234567890",
  "zipCode": "1234567890",
  "street": "Rua das Flores",
  "streetNumber": "123",
  "neighborhood": "Bairro das Flores",
  "complement": "Apartamento 123",
  "city": "São Paulo",
  "state": "SP",
  "country": "BR",
  "paymentMethod": "pix",
  "installments": 1
}'

Response Example

200 - Success

{
  "data": {
    "id": "0",
    "layout": {
      "primaryColor": "#000000",
      "typography": "MONTESERRAT",
      "logo": {
        "id": "0",
        "key": "0.png",
        "url": "X"
      }
    },
    "info": {
      "id": "0",
      "title": "Teste",
      "description": "detalhes do curso",
      "maxInstallments": 0,
      "price": 0,
      "status": "ACTIVE",
      "paymentMethod": {
        "PIX": true,
        "BOLETO": true,
        "CREDIT_CARD": true
      },
      "additionalInfo": null,
      "images": [
        {
          "id": "0",
          "key": "0.jpeg",
          "url": "X"
        }
      ],
      "shippingType": "PHYSICAL",
      "accessLink": "X"
    },
    "order": {
      "id": "0",
      "contact": {
        "fullName": "XXXX XXX",
        "document": "XXX.XXX.XXX-XX",
        "email": "XXXX@XXXX.com",
        "phone": "XXXXXXXXXX"
      },
      "address": {
        "zipCode": "XXXXXXXX",
        "street": "XXXX XXXXXX",
        "streetNumber": "XXX",
        "neighborhood": "XXXXX XXX XXXXXX",
        "complement": "XXXXXXXXXXX XXX",
        "city": "SÃO PAULO",
        "state": "SP",
        "country": "BR"
      },
      "payment": {
        "id": "0",
        "amount": 0,
        "paymentMethod": "BOLETO",
        "refundedAmount": 0,
        "installments": null,
        "status": "REFUSED",
        "postbackUrl": null,
        "metadata": "{\"linkId\":\"0\",\"sellerId\":\"0\",\"orderId\":\"0\",\"gatewayId\":\"0\"}",
        "traceable": false,
        "secureId": null,
        "secureUrl": null,
        "paidAt": null,
        "ip": "::ffff:127.0.0.1",
        "externalRef": "undefined",
        "endToEndId": null,
        "externalNsu": null,
        "releaseDate": null,
        "refusedReason": "O valor da cobrança excede o seu limite autorizado. Entre em contato com o suporte para aumentar o limite.",
        "provider": "Asaas",
        "createdAt": "2025-04-17T17:57:19.545Z",
        "updatedAt": "2025-04-17T17:57:20.876Z",
        "gatewayId": "0",
        "companyId": "0",
        "customerId": "0",
        "cardId": null,
        "gatewayProviderId": "0",
        "affiliatesId": null,
        "anticipationId": null,
        "gatewayDynamicPaymentMethodId": null,
        "dynamicFields": null,
        "returnUrl": null,
        "currency": "BRL",
        "qrCode": null,
        "barcode": null,
        "payUrl": null,
        "webUrl": null,
        "appUrl": null,
        "pix": null,
        "boleto": null,
        "customer": {
          "id": "0",
          "externalRef": "0",
          "name": "XXXX XXX",
          "email": "XXXX@XXXX.com",
          "phone": "XXXXXXXXXX",
          "birthdate": null,
          "createdAt": "2025-04-17T17:57:19.500Z",
          "addressId": "0"
        },
        "items": [
          {
            "id": "0",
            "externalRef": "0",
            "title": "Teste",
            "unitPrice": 0,
            "quantity": 0,
            "tangible": true,
            "transactionId": "0"
          }
        ],
        "refunds": [],
        "shipping": {
          "id": "0",
          "fee": 0,
          "addressId": "0",
          "transactionId": "0",
          "address": {
            "id": "0",
            "street": "XXXX XXXXXX",
            "streetNumber": "XXX",
            "complement": "XXXXXXXXXXX XXX",
            "zipCode": "XXXXXXXX",
            "neighborhood": "XXXXX XXX XXXXXX",
            "city": "SÃO PAULO",
            "state": "SP",
            "country": "br"
          }
        }
      },
      "createdAt": "2025-04-17T17:09:58.881Z",
      "updatedAt": "2025-04-17T17:57:20.896Z",
      "deletedAt": null
    }
  },
  "error": null,
  "message": "A cobrança foi iniciada com sucesso",
  "status": 200
}

Modified at 2025-07-23 19:02:40

Find payment methods by ID

Find payment methods

Create payment

💳 Realizar Pagamento do Pedido de Checkout#

✅ Requisitos da Requisição#