Quick Start

Step 1: Get your API Keys

Before you begin, you'll need API keys to authenticate your requests.

Contact our team to receive:

• Your API keys

• The complete Postman collection for testing our API

Step 2: Setting up your environment

Start with our sandbox environment for testing:

https://api.sandbox.unblockpay.com

For mocked transaction states and webhooks, please visit our Sandbox mocks section.

Step 3: Onboard your first customer

You're now ready to start using our APIs.

The first step is to create a Customer object to represent a user in your system.

When you create a customer, UnblockPay handles all KYC verification and returns a status field indicating their KYC status. Note that in the sandbox environment, customers will always have an approved status.

Step 4: Register your customer's bank account

Next, create an External Account object that represents the bank account where your customer will receive their fiat funds. External Accounts can be either first-party or third-party bank accounts.

For this example, we'll create an External Account for a bank account in Brazil. You'll need to provide the account_name, payment_rail, and pix_key.

Now that you've created an External Account, let's initiate a payout from USDC to BRL.

Step 5: Move USDC directly to a bank account in Brazil via Pix

• First, create a quote to lock in the exchange rate.

• Second, use the quote ID to create a payout, along with amount, sender, and receiver information.

• After initiating the payout, you'll receive a response with the transaction details and deposit instructions for the stablecoins.

• Upon successful deposit, the fiat payout will be processed and the receiver will get the funds in their bank account.