Getting started
Getting started takes a new account to its first payment: verify the company, save the withdrawal key, create the first charge and, if you want, notify your system. It shows up on Home.
#When it shows up
- In the classic Home view, in place of the charts, while the account has no movement (no charge, balance or withdrawal).
- In the new view, until the company is verified and the account has movement. Dismiss hides the block for this account, in this browser. A pending verification stays in To do today.
- It does not show up for an account that only earns partner commission.
See Home for the two views.
#The list
The list has five steps. Done steps get a completed mark; the screen counts how many are done.
| Step | Done when |
|---|---|
| Verify your company | the company verification was approved |
| Where to receive withdrawals | the account has at least one saved Pix key |
| Create your first charge | the account has a charge |
| Test a payment | a charge of the account was paid |
| Notify your system | the account has a webhook or an API key (optional) |
Start, on each pending step, opens the assistant at that step. Continue (in the new view) or Continue getting started (in the classic one) opens the first missing step.
#The assistant
The Getting started assistant has four screens. Each step saves on its own action (send a document, save a key, generate a QR Code, save a URL), so you can leave and come back anytime.
#1. Verify your company
The step says how many documents are asked for your type of registration (CPF or CNPJ) and how long the review takes. Send each document in its own box. The summary below shows how many were submitted and how many were approved.
You can move on to the next steps while the review runs; the result arrives by email. Once the company is verified, the step shows "Company verified. Receiving is unlocked." More in Identity verification (KYC).
#2. Where do you want to receive withdrawals
- Pick the Key type: CNPJ, CPF, Email, Phone or Random key. The type of your registration comes marked as suggested.
- Type the Pix key.
- Type it again in Repeat the key. The screen asks twice because the key holder is not checked before sending.
- Check the Registered holder and click Save key.
With the account's default setting, a CPF or CNPJ key must be the document on your registration. When your account can withdraw to a key of another holder, the step says so.
Check the key before saving: you can change it later, but a withdrawal already sent to the wrong key cannot be undone here.
With saved keys, the step shows Saved keys, with Replace and Remove on each one, and Add another key. Replace saves the new key and only then removes the old one. A removed key no longer shows up in the withdrawal; past withdrawals do not change.
If you typed a key and did not save it, the assistant does not move on: save the key or clear the field to continue without it.
The same keys can be managed later in Withdraw, through the Manage saved keys link (see How to withdraw).
#3. Create your first charge
Type the Amount and the Description (the payer sees it) and click Generate QR Code. The charge is valid for 24 hours, as the screen says.
The screen shows the QR Code and the Pix copy-and-paste code and tells you right there when the payment lands. Create another charge clears the form. The charge shows up in Transactions.
To pick a checkout template, an expiry date or a usage limit, use Payment links.
#4. Notify your system (optional)
This step registers a webhook: a notice the platform sends to your system on every event. If you have no system, skip it: the dashboard and email already notify you.
- Type the Webhook URL. Only https addresses are accepted.
- In Events, Charge paid (
charge.paid) and Withdrawal completed (payout.paid) come checked. More events shows the others. - Click Save and send test.
- Copy the secret in Store the secret now. It is shown only once; your system uses it to verify the signature of every notice, which arrives in the
X-RottaPay-Signatureheader.
The test result shows right below: Received, No response in time or Failed, with the HTTP code, the time taken and the notice that was sent.
If the account already has a webhook, the step lists the registered addresses, with Send test on each one. The rest lives in Webhooks.
To skip, click Finish without filling in the URL. If you typed a URL and did not save it, the assistant asks you to save it or clear the field before finishing.
To handle the notices in your system, see Webhooks in the integration docs.
#Finish
When you click Finish, the assistant shows "Done — your account is ready to receive" and four shortcuts: Create charge (opens Transactions), View statement, Make a withdrawal and Invite team.
Questions this page does not answer? Write to suporte@rottapay.com.