CARTÃO

POST

/transactions

Valor mínimo R$5

Requisição

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢201Created

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/transactions' \
--header 'x-api-key: sk_c6b0f1703772167d3ac262f4242a2d4e8ca8878bdec44ecb' \
--header 'Content-Type: application/json' \
--data-raw '{
  "amount": 5000,
  "method": "CREDIT_CARD",
  "installments": 1,
  "global": true, // enviar true caso seja transacao inernacional
  "customer": {
    "name": "Michael Smith",
    "email": "admin.msmith@example.com",
    "phone": "+329262988776655",
    "document": "48192765030",
    "documentType": "CPF"
  },
  "card": {
    "number": "4133333111114567",
    "holderName": "Michael Smith",
    "holderDocument": "48192765030",
    "expirationMonth": 10,
    "expirationYear": 33,
    "cvv": "688",
    "token": "xxx",
    "ip": "42.223.244.72",
    "currency": "BRL", // CASO SEJA INTERNACIONAL, O ENVIO DO CURRENCY NÃO PODE SER FEITO COM O VALOR BRL
    "sessionId": "", // o sessionId em caso de necessidade deve ser preenchid, mas nao é obrigatório
    "threeDS": {  // o 3DS em caso de necessidade deve ser preenchido, mas não é obrigatório
      "cavv": "AAABBBCCC123456789",
      "xid": "XID123456789",
      "eci": "05",
      "version": "2.1.0",
      "referenceId": "REF987654321"
    }
  },
  "items": [
    {
      "title": "Premium Hair Care Kit – Shine, Repair and Protection",
      "quantity": 2,
      "amount": 5218,
      "tangible": true,
      "externalRef": "216578125467"
    }
  ]
}'

Response Example

{
    "status": true,
    "data": {
        "id": "022d7383-2b95-4f75-be4b-fbba37ba50ae",
        "amount": 500,
        "customer": {
            "id": "82eb9fdf-06f5-4f9b-9a64-51714d0dfa00",
            "externalRef": null,
            "name": "John Doe",
            "email": "john@example.com",
            "phone": "1234567890",
            "documentType": "CPF",
            "document": "26841949048",
            "createdAt": "2025-06-27T12:03:50.890Z"
        },
        "items": [
            {
                "id": "7a10b701-43e9-47da-9cad-925543e52858",
                "title": "Wireless Mouse",
                "amount": 5999,
                "quantity": 1,
                "tangible": true,
                "externalRef": "item_abc123",
                "transactionId": "022d7383-2b95-4f75-be4b-fbba37ba50ae",
                "createdAt": "2025-06-27T12:03:50.890Z",
                "updatedAt": "2025-06-27T12:03:50.890Z"
            }
        ],
        "method": "CREDIT_CARD",
        "status": "FAILED", // PAID - PENDING
        "boleto": null,
        "card": {
            "id": "e42df45b-61cc-4e9d-939c-b52956cf01c6",
            "number": "",
            "holderName": "",
            "holderDocument": "",
            "expirationMonth": 0,
            "expirationYear": 0,
            "cvv": "",
            "brand": null,
            "createdAt": "2025-06-27T12:03:51.713Z",
            "updatedAt": "2025-06-27T12:03:51.713Z",
            "transactionId": "022d7383-2b95-4f75-be4b-fbba37ba50ae"
        },
        "pix": null,
        "description": null,
        "installments": null,
        "metadata": null,
        "paidAt": null,
        "postbackUrl": null,
        "createdAt": "2025-06-27T12:03:50.890Z"
    }
}

Modificado em 2025-12-12 18:48:32