Public API
Transactions, hosted checkout, balances and withdrawals through documented contracts.
From the first signal to the next step.
Start with the contract, preserve intent and follow events. Documentation explains the path between your application and Akkro.
Built to connectPOST /v1/transactionsHost: api.akkropay.appx-api-key: <YOUR_SERVER_KEY>X-Idempotency-Key: <ORDER_KEY>Content-Type: application/json { "amount": 27900, "paymentMethod": "pix", "customer": { "name": "Example", "email": "demo@example.com", "document": { "type": "cpf", "number": "<CUSTOMER_CPF>" } }, "items": [{ "title": "Example", "unitPrice": 27900, "quantity": 1, "tangible": true }]}Read-only example. Consult the complete contract before integrating. No public test environment is available.
Every handoff has a responsibility. Explore the contract before connecting your application.
Transactions, hosted checkout, balances and withdrawals through documented contracts.
A key identifies financial intent across creation retries.
Receive events, validate signatures when configured and handle delivery securely.
Prepare authentication, retries and the events connecting your backend to the payment.
Go deeper in the documentationNo. Payment API credentials belong in your backend, outside public JavaScript, repositories and logs. Separate the buyer experience from the code that authorizes an operation. If a credential is exposed, replace it and review its use.
Explore this topicPreserve the X-Idempotency-Key when retrying the same financial intent and follow the endpoint's rules. A timeout does not prove failure: check the state before starting another intent. A different charge must be treated as a new operation.
Explore this topicReceive webhooks in your backend, validate signatures when a secret is configured and handle repeated events idempotently. Match each event to the order reference and query the transaction when needed. The buyer's visual return alone should not release an order.
Explore this topicFind the transaction by its reference, check its state and available records, and compare them with the order in your system. Querying the transaction through the API complements received events. Do not assume a payment failed simply because a notification has not arrived.
Explore this topicDemonstrations use fictional records and do not make financial requests. They explain the journey but are not an API testing environment. Akkro documentation uses production; there is no public staging or sandbox environment. Plan any real validation before running it.
Explore this topicDiscover the Akkro platform and follow your payments with context.