Adicionar uma nova transação

curl --request POST \
  --url https://sandbox.api.veepag.com/v1/transaction \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "companyId": "company_id",
  "amount": 9900,
  "installments": 1,
  "capture": true,
  "paymentProfile": {
    "cardNumber": "4111111111111111",
    "cardExpiration": "10/2026",
    "holderName": "CLIENTE TESTE",
    "cardCvv": "123"
  },
  "client": {
    "name": "Cliente Teste",
    "doc": "12345678909",
    "email": "cliente@example.com"
  }
}
'

import requests

url = "https://sandbox.api.veepag.com/v1/transaction"

payload = {
    "companyId": "company_id",
    "amount": 9900,
    "installments": 1,
    "capture": True,
    "paymentProfile": {
        "cardNumber": "4111111111111111",
        "cardExpiration": "10/2026",
        "holderName": "CLIENTE TESTE",
        "cardCvv": "123"
    },
    "client": {
        "name": "Cliente Teste",
        "doc": "12345678909",
        "email": "cliente@example.com"
    }
}
headers = {
    "apiKey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {apiKey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    companyId: 'company_id',
    amount: 9900,
    installments: 1,
    capture: true,
    paymentProfile: {
      cardNumber: '4111111111111111',
      cardExpiration: '10/2026',
      holderName: 'CLIENTE TESTE',
      cardCvv: '123'
    },
    client: {name: 'Cliente Teste', doc: '12345678909', email: 'cliente@example.com'}
  })
};

fetch('https://sandbox.api.veepag.com/v1/transaction', 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://sandbox.api.veepag.com/v1/transaction",
  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([
    'companyId' => 'company_id',
    'amount' => 9900,
    'installments' => 1,
    'capture' => true,
    'paymentProfile' => [
        'cardNumber' => '4111111111111111',
        'cardExpiration' => '10/2026',
        'holderName' => 'CLIENTE TESTE',
        'cardCvv' => '123'
    ],
    'client' => [
        'name' => 'Cliente Teste',
        'doc' => '12345678909',
        'email' => 'cliente@example.com'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apiKey: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.api.veepag.com/v1/transaction"

	payload := strings.NewReader("{\n  \"companyId\": \"company_id\",\n  \"amount\": 9900,\n  \"installments\": 1,\n  \"capture\": true,\n  \"paymentProfile\": {\n    \"cardNumber\": \"4111111111111111\",\n    \"cardExpiration\": \"10/2026\",\n    \"holderName\": \"CLIENTE TESTE\",\n    \"cardCvv\": \"123\"\n  },\n  \"client\": {\n    \"name\": \"Cliente Teste\",\n    \"doc\": \"12345678909\",\n    \"email\": \"cliente@example.com\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apiKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.api.veepag.com/v1/transaction")
  .header("apiKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"companyId\": \"company_id\",\n  \"amount\": 9900,\n  \"installments\": 1,\n  \"capture\": true,\n  \"paymentProfile\": {\n    \"cardNumber\": \"4111111111111111\",\n    \"cardExpiration\": \"10/2026\",\n    \"holderName\": \"CLIENTE TESTE\",\n    \"cardCvv\": \"123\"\n  },\n  \"client\": {\n    \"name\": \"Cliente Teste\",\n    \"doc\": \"12345678909\",\n    \"email\": \"cliente@example.com\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.api.veepag.com/v1/transaction")

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

request = Net::HTTP::Post.new(url)
request["apiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"companyId\": \"company_id\",\n  \"amount\": 9900,\n  \"installments\": 1,\n  \"capture\": true,\n  \"paymentProfile\": {\n    \"cardNumber\": \"4111111111111111\",\n    \"cardExpiration\": \"10/2026\",\n    \"holderName\": \"CLIENTE TESTE\",\n    \"cardCvv\": \"123\"\n  },\n  \"client\": {\n    \"name\": \"Cliente Teste\",\n    \"doc\": \"12345678909\",\n    \"email\": \"cliente@example.com\"\n  }\n}"

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

{
  "_id": "transaction_id",
  "companyId": "company_id",
  "status": "PAID",
  "amount": 9900,
  "paymentMethod": "CREDIT_CARD"
}

{
  "error_messages": [
    {
      "msg": "Payload invalido.",
      "type": "field",
      "path": "companyId",
      "location": "body"
    }
  ],
  "code": "ZodValidationException",
  "path": "/v1/transaction",
  "metadata": {}
}

{
  "error_messages": [
    {
      "msg": "Unauthorized."
    }
  ],
  "code": "unauthorized",
  "path": "/v1/transaction",
  "metadata": {}
}

{
  "error_messages": [
    {
      "msg": "Forbidden."
    }
  ],
  "code": "forbidden",
  "path": "/v1/transaction",
  "metadata": {}
}

{
  "error_messages": [
    {
      "msg": "Unknown server error."
    }
  ],
  "code": "unknown_server_error",
  "path": "/v1/transaction",
  "metadata": {}
}

POST

transaction

Adicionar uma nova transação

curl --request POST \
  --url https://sandbox.api.veepag.com/v1/transaction \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "companyId": "company_id",
  "amount": 9900,
  "installments": 1,
  "capture": true,
  "paymentProfile": {
    "cardNumber": "4111111111111111",
    "cardExpiration": "10/2026",
    "holderName": "CLIENTE TESTE",
    "cardCvv": "123"
  },
  "client": {
    "name": "Cliente Teste",
    "doc": "12345678909",
    "email": "cliente@example.com"
  }
}
'

import requests

url = "https://sandbox.api.veepag.com/v1/transaction"

payload = {
    "companyId": "company_id",
    "amount": 9900,
    "installments": 1,
    "capture": True,
    "paymentProfile": {
        "cardNumber": "4111111111111111",
        "cardExpiration": "10/2026",
        "holderName": "CLIENTE TESTE",
        "cardCvv": "123"
    },
    "client": {
        "name": "Cliente Teste",
        "doc": "12345678909",
        "email": "cliente@example.com"
    }
}
headers = {
    "apiKey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {apiKey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    companyId: 'company_id',
    amount: 9900,
    installments: 1,
    capture: true,
    paymentProfile: {
      cardNumber: '4111111111111111',
      cardExpiration: '10/2026',
      holderName: 'CLIENTE TESTE',
      cardCvv: '123'
    },
    client: {name: 'Cliente Teste', doc: '12345678909', email: 'cliente@example.com'}
  })
};

fetch('https://sandbox.api.veepag.com/v1/transaction', 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://sandbox.api.veepag.com/v1/transaction",
  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([
    'companyId' => 'company_id',
    'amount' => 9900,
    'installments' => 1,
    'capture' => true,
    'paymentProfile' => [
        'cardNumber' => '4111111111111111',
        'cardExpiration' => '10/2026',
        'holderName' => 'CLIENTE TESTE',
        'cardCvv' => '123'
    ],
    'client' => [
        'name' => 'Cliente Teste',
        'doc' => '12345678909',
        'email' => 'cliente@example.com'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apiKey: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.api.veepag.com/v1/transaction"

	payload := strings.NewReader("{\n  \"companyId\": \"company_id\",\n  \"amount\": 9900,\n  \"installments\": 1,\n  \"capture\": true,\n  \"paymentProfile\": {\n    \"cardNumber\": \"4111111111111111\",\n    \"cardExpiration\": \"10/2026\",\n    \"holderName\": \"CLIENTE TESTE\",\n    \"cardCvv\": \"123\"\n  },\n  \"client\": {\n    \"name\": \"Cliente Teste\",\n    \"doc\": \"12345678909\",\n    \"email\": \"cliente@example.com\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apiKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.api.veepag.com/v1/transaction")
  .header("apiKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"companyId\": \"company_id\",\n  \"amount\": 9900,\n  \"installments\": 1,\n  \"capture\": true,\n  \"paymentProfile\": {\n    \"cardNumber\": \"4111111111111111\",\n    \"cardExpiration\": \"10/2026\",\n    \"holderName\": \"CLIENTE TESTE\",\n    \"cardCvv\": \"123\"\n  },\n  \"client\": {\n    \"name\": \"Cliente Teste\",\n    \"doc\": \"12345678909\",\n    \"email\": \"cliente@example.com\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.api.veepag.com/v1/transaction")

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

request = Net::HTTP::Post.new(url)
request["apiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"companyId\": \"company_id\",\n  \"amount\": 9900,\n  \"installments\": 1,\n  \"capture\": true,\n  \"paymentProfile\": {\n    \"cardNumber\": \"4111111111111111\",\n    \"cardExpiration\": \"10/2026\",\n    \"holderName\": \"CLIENTE TESTE\",\n    \"cardCvv\": \"123\"\n  },\n  \"client\": {\n    \"name\": \"Cliente Teste\",\n    \"doc\": \"12345678909\",\n    \"email\": \"cliente@example.com\"\n  }\n}"

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

{
  "_id": "transaction_id",
  "companyId": "company_id",
  "status": "PAID",
  "amount": 9900,
  "paymentMethod": "CREDIT_CARD"
}

{
  "error_messages": [
    {
      "msg": "Payload invalido.",
      "type": "field",
      "path": "companyId",
      "location": "body"
    }
  ],
  "code": "ZodValidationException",
  "path": "/v1/transaction",
  "metadata": {}
}

{
  "error_messages": [
    {
      "msg": "Unauthorized."
    }
  ],
  "code": "unauthorized",
  "path": "/v1/transaction",
  "metadata": {}
}

{
  "error_messages": [
    {
      "msg": "Forbidden."
    }
  ],
  "code": "forbidden",
  "path": "/v1/transaction",
  "metadata": {}
}

{
  "error_messages": [
    {
      "msg": "Unknown server error."
    }
  ],
  "code": "unknown_server_error",
  "path": "/v1/transaction",
  "metadata": {}
}

Authorizations

apiKey

string

header

required

API key no formato keyId.secret.

Body

application/json

companyId

string

required

ID da empresa que recebera a transacao. A credencial precisa ter acesso a essa empresa.

paymentProfile

object

required

Dados do cartao usados para processar a transacao.

Show child attributes

amount

number

required

Valor da transacao em centavos. Exemplo: 9900 representa R$ 99,00.

Example:

9900

client

object

Dados do cliente enviados inline. Quando informado, o documento deve ser enviado em doc ou cpf.

Show child attributes

installments

number

default:1

Quantidade de parcelas. Quando omitido, o fluxo usa 1 parcela.

capture

boolean

default:true

Indica se a transacao deve ser capturada imediatamente. Quando omitido, o fluxo usa true.

Response

Transacao criada.

_id

string

ID da transacao.

companyId

string

ID da empresa vinculada a transacao.

clientId

string

ID do cliente vinculado, quando houver.

productId

string

ID do produto vinculado, quando houver.

subscriptionId

string

ID da assinatura vinculada, quando houver.

chargeId

string

ID da cobranca vinculada, quando houver.

amount

number

Valor da transacao, normalmente com value em centavos e currency BRL.

installments

number

Parcelamento da transacao.

paymentMethod

enum<string>

Meio de pagamento usado na transacao.

Available options:

CREDIT_CARD,

DEBIT_CARD,

BOLETO,

PIX

status

enum<string>

Status atual da transacao.

Available options:

PAID,

PROCESSING,

DECLINED,

CANCELED,

DISCARDED,

AUTHORIZED,

IN_ANALYSIS,

ERROR_PAYMENT,

DISPUTE,

STANDBY,

CHARGEBACK,

PENDING_REVIEW,

PENDING_3DS,

BLOCKED,

INVALID_PAYMENT,

NO_PAYMENT_ROUTE,

PENDING_PAYMENT,

ERROR_REFUNDED

message

string

Mensagem principal retornada pelo processamento.

message2

string

Mensagem complementar retornada pelo processamento.

card

object

Dados de cartao salvos internamente, quando houver.

acquirer

object

Dados da adquirente vinculada a transacao.

boleto

object | null

Dados de boleto, quando gerados.

qrCode

object | null

Dados de Pix, quando gerados.

metadata

object

Metadados livres vinculados a transacao.

createdAt

string<date-time>

Data de criacao da transacao.

lastUpdate

string<date-time>

Data da ultima atualizacao da transacao.

Comece aqui

Guias

API Reference

Adicionar uma nova transação

Authorizations

Body

Response