cURL

curl --request POST \
  --url https://sandbox-api.superpagamentos.com/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "paymentType": "card",
  "billingData": {
    "amount": 10000,
    "installments": 1,
    "postbackUrl": "https://example.com/callback"
  },
  "customerData": {
    "remoteIpv4": "192.168.1.1",
    "firstName": "João",
    "lastName": "Silva",
    "document": "12345678909",
    "email": "joao.silva@email.com",
    "address": {
      "street": "Rua das Flores",
      "streetNumber": 123,
      "neighborhood": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "zipcode": "01234567",
      "complement": "Apto 123",
      "reference": "Próximo ao shopping"
    },
    "phone": "11999999999"
  },
  "cardData": {
    "cardNumber": "4532650104137832",
    "holderName": "João Silva",
    "expirationMonth": "12",
    "expirationYear": "2024",
    "securityCode": "123"
  },
  "splits": [
    {
      "subaccountId": "beff457d-e893-49df-8395-e8b67ab21e7c",
      "chargebackLiable": true,
      "splitPercentage": 10,
      "splitAmount": 450
    }
  ]
}
'

{
  "data": {
    "id": "4309e70d-fa20-4103-84c6-27370138948b",
    "status": "SUCCEEDED",
    "paymentMethod": "card",
    "currency": "BRL",
    "amount": 10000,
    "postbackUrl": "",
    "installments": 10,
    "buyerDetails": {
      "firstName": "João",
      "lastName": "Silva",
      "email": "joao.silva@email.com",
      "document": "12345678909",
      "phone": null,
      "street": "Rua das Flores",
      "streetNumber": 123,
      "neighborhood": "Centro",
      "complement": null,
      "reference": null,
      "city": "São Paulo",
      "state": "SP"
    },
    "cardDetails": {
      "brand": "Visa",
      "first4Digits": "4532",
      "last4Digits": "7832",
      "expirationMonth": "12",
      "expirationYear": "2024"
    },
    "splits": [
      {
        "subaccountId": "beff457d-e893-49df-8395-e8b67ab21e7c",
        "splitType": "percentage",
        "splitPercentage": 29.33,
        "liquidAmount": 2933,
        "chargebackLiable": false
      }
    ],
    "createdAt": "2025-06-09T19:14:20.125Z",
    "updatedAt": "2025-06-09T19:14:20.125Z"
  },
  "message": "Pagamento criado com sucesso"
}

Transações

Gerar transação

Cria uma nova transação no método de pagamento selecionado. Essa rota pode ser utilizada para criar transações com cartão de crédito, cartão tokenizado, PIX e boleto. Também é possível realizar splits entre subcontas.

Tipos de pagamento disponíveis:

Cartão de Crédito: Pagamento direto com cartão de crédito, requerendo dados completos do cliente, endereço e cartão
Cartão Tokenizado: Pagamento com cartão de crédito previamente tokenizado
PIX: Pagamento instantâneo via PIX
Boleto: Geração de boleto bancário

POST

payments

cURL

curl --request POST \
  --url https://sandbox-api.superpagamentos.com/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "paymentType": "card",
  "billingData": {
    "amount": 10000,
    "installments": 1,
    "postbackUrl": "https://example.com/callback"
  },
  "customerData": {
    "remoteIpv4": "192.168.1.1",
    "firstName": "João",
    "lastName": "Silva",
    "document": "12345678909",
    "email": "joao.silva@email.com",
    "address": {
      "street": "Rua das Flores",
      "streetNumber": 123,
      "neighborhood": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "zipcode": "01234567",
      "complement": "Apto 123",
      "reference": "Próximo ao shopping"
    },
    "phone": "11999999999"
  },
  "cardData": {
    "cardNumber": "4532650104137832",
    "holderName": "João Silva",
    "expirationMonth": "12",
    "expirationYear": "2024",
    "securityCode": "123"
  },
  "splits": [
    {
      "subaccountId": "beff457d-e893-49df-8395-e8b67ab21e7c",
      "chargebackLiable": true,
      "splitPercentage": 10,
      "splitAmount": 450
    }
  ]
}
'

{
  "data": {
    "id": "4309e70d-fa20-4103-84c6-27370138948b",
    "status": "SUCCEEDED",
    "paymentMethod": "card",
    "currency": "BRL",
    "amount": 10000,
    "postbackUrl": "",
    "installments": 10,
    "buyerDetails": {
      "firstName": "João",
      "lastName": "Silva",
      "email": "joao.silva@email.com",
      "document": "12345678909",
      "phone": null,
      "street": "Rua das Flores",
      "streetNumber": 123,
      "neighborhood": "Centro",
      "complement": null,
      "reference": null,
      "city": "São Paulo",
      "state": "SP"
    },
    "cardDetails": {
      "brand": "Visa",
      "first4Digits": "4532",
      "last4Digits": "7832",
      "expirationMonth": "12",
      "expirationYear": "2024"
    },
    "splits": [
      {
        "subaccountId": "beff457d-e893-49df-8395-e8b67ab21e7c",
        "splitType": "percentage",
        "splitPercentage": 29.33,
        "liquidAmount": 2933,
        "chargebackLiable": false
      }
    ],
    "createdAt": "2025-06-09T19:14:20.125Z",
    "updatedAt": "2025-06-09T19:14:20.125Z"
  },
  "message": "Pagamento criado com sucesso"
}

Authorizations

Authorization

string

header

required

Token JWT gerado na rota de autenticação (/auth). Deve ser enviado no formato: Bearer

Body

application/json

Payload para criação de um novo pagamento. O tipo de pagamento determina a estrutura específica dos dados necessários.

Cartão de crédito
Cartão de Crédito Tokenizado
PIX
Boleto

paymentType

enum<string>

required

Método de pagamento a ser utilizado

Available options:

card

billingData

object

required

Dados de faturamento do pagamento

Show child attributes

customerData

object

required

Dados do cliente

Show child attributes

cardData

object

required

Dados do cartão de crédito

Show child attributes

splits

object[]

Configuração de splits do pagamento (opcional)

Show child attributes

Response

Pagamento criado com sucesso

data

object

Show child attributes

message

string

Example:

"Pagamento criado com sucesso"

Remover token Listar transações