Create Pix In Transaction
POST
{{baseUrl}}/api/v1/transactions
postbackUrl is provided, webhook notifications will be sent to this URL. If webhookSecret is also provided, webhooks will include an HMAC-SHA256 signature in the X-Webhook-Signature header.Request Body Fields
| Field | Type | Required | Description |
|---|---|---|---|
| amount | integer | Yes | Amount in cents (min: 100) |
| paymentMethod | string | Yes | Fixed value: pix |
| customer | object | Yes | Payer/customer information |
| customer.name | string | Yes | Payer name |
| customer.email | string | No | Payer email |
| customer.phone | string | No | Phone with area code, digits only |
| customer.document | object | Yes | Document information |
| customer.document.type | string | Yes | cpf or cnpj |
| customer.document.number | string | Yes | Document number (digits only) |
| items | array | Yes | List of items/products |
| items[].title | string | Yes | Item title/description |
| items[].unitPrice | integer | Yes | Unit price in cents |
| items[].quantity | integer | Yes | Quantity of items |
| items[].tangible | boolean | No | Whether physical product |
| postbackUrl | string | No | URL for webhook notifications |
| webhookSecret | string | No | Secret key for HMAC signature |
| metadata | object | No | Custom metadata for tracking |
Requisição
Parâmetros Header
Parâmetros Bodyapplication/json
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST '{{baseUrl}}/api/v1/transactions' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 10000,
"paymentMethod": "pix",
"externalRef": "ORD-123",
"customer": {
"name": "John Smith",
"email": "john@email.com",
"phone": "11999999999",
"document": {
"type": "cpf",
"number": "12345678910"
}
},
"items": [
{
"title": "Pro Subscription",
"unitPrice": 10000,
"quantity": 1,
"tangible": false
}
],
"postbackUrl": "https://webhook.example.com/postback",
"webhookSecret": "your-secret-key-for-hmac",
"metadata": {
"orderId": "ORD-123"
}
}'Response Response Example
201 - 201 - Pix In Created
{
"id": "bc06ccc9-c64f-4dc5-b54e-baabf08fbb1b",
"amount": 500,
"refundedAmount": 0,
"companyId": "4d1a3c25-2cfc-4f72-b814-23d9fd168c8e",
"paymentMethod": "pix",
"status": "pending",
"externalRef": "ORD-123",
"postbackUrl": "https://webhook.example.com/postback",
"metadata": {
"item1": "item1",
"item2": "item2"
},
"traceable": false,
"secureId": "bc06ccc9-c64f-4dc5-b54e-baabf08fbb1b",
"secureUrl": "https://pay.example.com/pay/bc06ccc9-c64f-4dc5-b54e-baabf08fbb1b",
"createdAt": "2025-12-12T02:05:53.724Z",
"updatedAt": "2025-12-12T02:05:53.724Z",
"paidAt": null,
"ip": "::1",
"customer": {
"id": "e00d270d-84de-4b94-8d1b-3bb26921e04f",
"name": "John Smith",
"email": "john@email.com",
"phone": "11999999999",
"createdAt": "2025-12-02T19:12:51.628Z",
"document": {
"number": "12345678910",
"type": "cpf"
}
},
"card": null,
"pix": {
"qrcode": "00020101021226880014br.gov.bcb.pix2566qrcode.example.com/pix/a1b2c3d4-e5f6-7890-abcd-ef12345678905204000053039865802BR5918COMPANY EXAMPLE LTDA6008SaoPaulo62070503***6304ABCD",
"expiresAt": "2025-12-14T02:05:52.012Z"
},
"boleto": null,
"shipping": null,
"refusedReason": null,
"items": [
{
"externalRef": null,
"title": "Digital Product",
"unitPrice": 500,
"quantity": 1,
"tangible": false
}
],
"splits": [],
"refunds": [],
"delivery": null,
"fee": {
"fixedAmount": 50,
"spreadPercentage": 1.5,
"estimatedFee": 58,
"netAmount": 442,
"pixInFeeType": "MIXED"
}
}Modificado em 2025-12-29 21:39:26