Create
POST
/api/user/transactions
✅ Requisitos da Requisição
🧠 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 obrigatórios
| Campo | Tipo | Descrição |
|---|---|---|
| amount | inteiro | Valor total da transação em centavos (ex: 500 = R$5,00) |
| currency | string | Código da moeda (ex: BRL) |
| paymentMethod | string | Método de pagamento (PIX, credit_card, boleto) |
| installments | inteiro | Número de parcelas |
| postbackUrl | string | URL para receber notificações do status da transação |
| metadata | string | Dados adicionais personalizados em formato JSON |
| traceable | boolean | Define se a transação será rastreável |
| ip | string | Endereço IP do cliente |
| card.number | string | Número do cartão de crédito |
| card.holderName | string | Nome do titular do cartão |
| card.expirationMonth | inteiro | Mês de expiração do cartão (1-12) |
| card.expirationYear | inteiro | Ano de expiração do cartão |
| card.cvv | string | Código de segurança do cartão |
| customer.id | string | ID único do cliente |
| customer.name | string | Nome completo do cliente |
| customer.email | string | E-mail do cliente |
| customer.document.number | string | CPF ou CNPJ do cliente |
| customer.document.type | string | Tipo de documento (CPF ou CNPJ) |
| customer.phone | string | Telefone do cliente |
| customer.externalRef | string | Referência externa |
| customer.address.street | string | Nome da rua |
| customer.address.streetNumber | string | Número da residência |
| customer.address.complement | string | Complemento (apto, bloco, etc) |
| customer.address.zipCode | string | CEP do endereço |
| customer.address.neighborhood | string | Bairro |
| customer.address.city | string | Cidade |
| customer.address.state | string | Estado (UF) |
| customer.address.country | string | País (ex: BR) |
| items[].title | string | Título do item |
| items[].unitPrice | inteiro | Preço unitário em centavos |
| items[].quantity | inteiro | Quantidade do item |
| items[].tangible | boolean | Indica se o item é tangível |
| items[].externalRef | string | Referência externa do item |
| boleto.expiresInDays | inteiro | Dias até o vencimento do boleto |
| pix.expiresInDays | inteiro | Dias até o vencimento do PIX |
📥 Parâmetros Opcionais
| Campo | Tipo | Descrição |
|---|---|---|
| shipping.fee | inteiro | Valor do frete em centavos |
| shipping.address.street | string | Nome da rua de entrega |
| shipping.address.streetNumber | string | Número da residência para entrega |
| shipping.address.complement | string | Complemento do endereço de entrega |
| shipping.address.zipCode | string | CEP do endereço de entrega |
| shipping.address.neighborhood | string | Bairro da entrega |
| shipping.address.city | string | Cidade da entrega |
| shipping.address.state | string | Estado da entrega |
| shipping.address.country | string | País da entrega |
Request
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/user/transactions' \
--header 'x-api-key: {Token}' \
--header 'User-Agent: AtivoB2B/1.0' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 0,
"currency": "string",
"paymentMethod": "string",
"card": {
"number": "string",
"holderName": "string",
"expirationMonth": 0,
"expirationYear": 0,
"cvv": "string"
},
"installments": 0,
"customer": {
"name": "string",
"email": "string",
"document": {
"number": "string",
"type": "string"
},
"phone": "string",
"externalRef": "string",
"address": {
"street": "string",
"streetNumber": "string",
"complement": "string",
"zipCode": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string"
}
},
"shipping": {
"fee": 0,
"address": {
"street": "string",
"streetNumber": "string",
"complement": "string",
"zipCode": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"country": "string"
}
},
"items": [
{
"title": "string",
"unitPrice": 0,
"quantity": 0,
"tangible": true,
"externalRef": "string"
}
],
"boleto": {
"expiresInDays": 0
},
"pix": {
"expiresInDays": 0
},
"postbackUrl": "string",
"metadata": "string",
"traceable": true,
"ip": "string"
}'Response Response Example
200 - Success
{
"status": 200,
"message": "Transação criada com sucesso.",
"data": {
"id": "00000000-0000-0000-0000-0000000000000",
"amount": 1000,
"paymentMethod": "BOLETO",
"refundedAmount": 0,
"installments": null,
"status": "WAITING_PAYMENT",
"postbackUrl": "https://meusite.com/postback",
"metadata": "{\"chave\":\"valor\"}",
"traceable": true,
"secureId": null,
"secureUrl": null,
"paidAt": null,
"ip": "192.168.1.1",
"externalRef": "pay_pr1rmhejz75wmrcp",
"endToEndId": null,
"externalNsu": null,
"releaseDate": null,
"refusedReason": null,
"provider": "Asaas",
"createdAt": "2025-04-16T14:47:46.428Z",
"updatedAt": "2025-04-16T14:47:48.034Z",
"gatewayId": "00000000-0000-0000-0000-0000000000000",
"companyId": "00000000-0000-0000-0000-0000000000000",
"customerId": "00000000-0000-0000-0000-0000000000000",
"cardId": null,
"gatewayProviderId": "00000000-0000-0000-0000-0000000000000",
"affiliatesId": null,
"anticipationId": null,
"gatewayDynamicPaymentMethodId": null,
"dynamicFields": null,
"returnUrl": null,
"currency": "BRL",
"qrCode": null,
"barcode": null,
"payUrl": null,
"webUrl": null,
"appUrl": null,
"boleto": {
"url": "https://sandbox.asaas.com/b/pdf/pr1rmhejz75wmrcp",
"barcode": null,
"digitableLine": null,
"instructions": null,
"expirationDate": "2025-04-23T00:00:00.000Z"
},
"card": null,
"pix": null,
"customer": {
"id": "000000-0000-0000-0000-0000000000000",
"externalRef": "string",
"name": "João da Silva",
"email": "johndoe@email.com",
"phone": "(11) 98765-4321",
"birthdate": null,
"createdAt": "2025-04-16T14:47:46.364Z",
"addressId": "000000000-0000-00000-0000-0000000000",
"document": {
"type": "CPF",
"number": "000000000000"
},
"address": {
"city": "São Paulo",
"state": "SP",
"street": "Avenida Paulista",
"country": "br",
"zipCode": "01000-000",
"complement": "Apto 101",
"neighborhood": "Bela Vista",
"streetNumber": "123"
}
},
"shipping": {
"fee": 500,
"address": {
"city": "São Paulo",
"state": "SP",
"street": "Avenida Paulista",
"country": "br",
"zipCode": "01000-000",
"complement": "Apto 101",
"neighborhood": "Bela Vista",
"streetNumber": "123"
}
},
"items": [
{
"title": "Produto XYZ",
"quantity": 1,
"tangible": true,
"unitPrice": 10,
"externalRef": "item-12345"
}
],
"delivery": {
"status": "WAITING",
"trackingCode": "N/A",
"createdAt": "2025-04-16T14:47:46.428Z"
},
"fee": {
"netAmount": 776,
"fixedAmount": 199,
"estimatedFee": 223.9,
"spreadPercentage": 2.49
},
"refunds": []
},
"error": null
}Modified at 2025-07-25 19:00:28