Example of request for payment with Credit Card
{
"reference_id": "string",
"session_id": null,
"amount": 22.9,
"currency_type":"USDT",
"type": "credit",
"description": "2084657",
"customer": {
"name": "Teste",
"type": "F",
"email": "[email protected]",
"phones": [
{
"area": "12",
"number": "934567890"
}
],
"address": {
"city": "Sao Paulo",
"state": "SP",
"number": 11,
"street": "Rua Tabapua",
"district": "Itaim Bibi",
"postcode": "04003-030"
},
"lastname": "teste",
"tax_document": "03723668054"
},
"payments": [
{
"type": "credit",
"amount": 22.9,
"credit_card": {
"document": "69252889051",
"card_number": "5458034586623329",
"holder_name": "Teste teste",
"installments": 1,
"security_code": "802",
"expiration_year": "25",
"expiration_month": "01"
}
}
],
"qtd_dependents": 0,
"capture_manual":0
}Details and Information
| Field | Type | Required | Information |
|---|---|---|---|
| reference_id | string | no | Order ID from your system |
| session_id | string | yes | Session ID for fingerprint (explained in the Transaction Session) |
| amount | decimal | yes | Total order amount |
| currency_type | string | no | Currency type |
| type | string | yes | Payment type. Use "credit" for credit card. Possible values: credit, multi_credit, multi_ticket, ticket |
| description | string | no | Order description (optional) |
| customer | Object | yes | Customer data |
| customer.name | string | yes | Customer's full name |
| customer.lastname | string | yes | Customer's last name |
| customer.email | string | yes | Customer's email |
| customer.tax_document | string | yes | Customer's CPF or CNPJ. Used for fraud analysis |
| customer.type | string | yes | Customer type: "F" for individual, "J" for business |
| customer.phones | Object | yes | Customer phone data |
| customer.phones.area | string | yes | Area code with 2 digits |
| customer.phones.number | string | yes | Phone number with 8 or 9 digits |
| customer.address | Object | yes | Customer address data |
| customer.address.postcode | string | yes | 8-digit postal code |
| customer.address.street | string | yes | Street name |
| customer.address.number | string | yes | Address number |
| customer.address.complement | string | no | Address complement (optional) |
| customer.address.district | string | yes | Neighborhood |
| customer.address.city | string | yes | City |
| customer.address.state | string | yes | State (2-letter code) |
| shipping | Object | no | Shipping information (optional) |
| shipping.amount | decimal | no | Shipping amount (optional) |
| shipping.method | string | no | Shipping method name (optional) |
| items | Array | yes | Product data |
| items.n.name | string | yes | Product name |
| items.n.qty | int | yes | Product quantity |
| items.n.amount | decimal | yes | Total value of product(s) |
| items.n.image | string | no | Product image URL (optional) |
| items.n.link | string | no | Product page URL (optional) |
| payments | Array | yes | Payment data |
| payments.reference_id | string | no | Payment identifier |
| payments.amount | decimal | yes | Payment amount |
| payments.type | string | yes | Payment type: "credit" for credit card, "ticket" for boleto |
| payments.credit_card | Object | yes | Credit card information |
| payments.credit_card.installments | int | yes | Number of installments |
| payments.credit_card.card_number | string | yes | Credit card number |
| payments.credit_card.holder_name | string | yes | Cardholder's name |
| payments.credit_card.expiration_month | string | yes | Expiration month (2 digits) |
| payments.credit_card.expiration_year | string | yes | Expiration year (4 digits) |
| payments.credit_card.security_code | string | yes | Security code |
| payments.credit_card.cpf | string | yes | Cardholder's CPF |
| capture_manual | boolean | no | Enable manual payment capture |
Example of response
{
"success": true,
"order": {
"id": "f11f3170-f246-400d-9bf2-13c2d3ff01c0",
"reference_id": "4000000010",
"amount": "39.84",
"type": "credit",
"status": "ORDER_PAID",
"description": "",
"date_create": "2022-03-25 11:11:44",
"customer": {
"id": "F8F218AE-0077-4724-80A1-123404AD2917",
"name": "Jose silva ",
"tax_document": "00000000191",
"type": "F",
"email": "[email protected]",
"address": {
"postcode": "04533010",
"street": "Rua Tabapuã",
"number": "145",
"complement": null,
"district": "Itaim Bibi",
"city": "São paulo",
"state": "SP"
}
},
"items": [
{
"name": "Tocha Hitachi para trabalho com corpo leve",
"qty": 1,
"unit_amount": "18.84",
"image": "https://oregon-kitchen.lojadefault-shopaqpago.aqbank.io/media/catalog/product/cache/a2323c833ef4765e7544b8609e6c75c2/t/o/tool_7_1.jpg",
"link": "https://oregon-kitchen.lojadefault-shopaqpago.aqbank.io/mecanico/hitachi-torch-work-light-body-only.html"
}
],
"shipping": {
"id": "8aeeac8a-5643-4e41-9ad7-257149c556ed",
"amount": "21.00",
"method": "correios",
"address": {
"postcode": "04533010",
"street": "Rua Tabapuã",
"number": "145",
"complement": null,
"district": "Itaim Bibi",
"city": "São Paulo",
"state": "SP"
}
},
"payments": [
{
"id": "f44fb146-24b8-4fd9-b833-2ef444267d0m",
"reference_id": null,
"amount": "39.84",
"type": "credit",
"email": "[email protected]",
"payment_multi": false,
"status": "succeeded",
"message": "payment processed.",
"installments": "1",
"created_at": "2022-03-25 11:11:44",
"payment_date": "2022-03-25 11:11:46",
"credit_card": {
"id": "e5ba8d8e-dbc2-4084-88f1-98d48c0f6421",
"type_card": "credit",
"flag": "MasterCard",
"first4_digits": "5577",
"last4_digits": "6630",
"holder_name": "Jose silva",
"expiration_month": "03",
"expiration_year": "2024"
}
}
]
}
}