# Sqala Developer API API

> Sqala Developer API API on Apizie: 28 endpoints (Create an Access Token, List all Pix QR Codes, Create a Pix QR Code, Retrieve a Pix QR Code, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/payments:sqala/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `payments:sqala`
- Category: Payments
- Status: byok
- Source: https://www.sqala.tech
- Page: https://apizie.tech/api/payments/sqala
- OpenAPI: https://apizie.tech/api/payments/sqala/openapi.json

At Sqala, we believe that everyone deserves access to financial services, and we are committed to providing secure and reliable payment solutions to clients who may have been overlooked by traditional financial…

## Endpoints

### Create an Access Token
`POST https://apizie.tech/v1/payments:sqala/token-generate-access-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### List all Pix QR Codes
`GET https://apizie.tech/v1/payments:sqala/qr-code-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | A limit on the number of objects to be returned, between 1 and 50. |
| before | string | no | A cursor for use in pagination. ```before``` is an object ID that defines your place in the list. For instance, if you make a list request… |
| after | string | no | A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and… |

### Create a Pix QR Code
`POST https://apizie.tech/v1/payments:sqala/qr-code-generate-qr-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve a Pix QR Code
`GET https://apizie.tech/v1/payments:sqala/qr-code-get-qr-code-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique identifier for the object. |

### List all ITPs
`GET https://apizie.tech/v1/payments:sqala/itp-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | A limit on the number of objects to be returned, between 1 and 50. |
| before | string | no | A cursor for use in pagination. ```before``` is an object ID that defines your place in the list. For instance, if you make a list request… |
| after | string | no | A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and… |

### Create an ITP
`POST https://apizie.tech/v1/payments:sqala/itp-create-payment-instruction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve an ITP
`GET https://apizie.tech/v1/payments:sqala/itp-get-itp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique identifier for the object. |

### List all Boletos
`GET https://apizie.tech/v1/payments:sqala/boleto-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | A limit on the number of objects to be returned, between 1 and 50. |
| before | string | no | A cursor for use in pagination. ```before``` is an object ID that defines your place in the list. For instance, if you make a list request… |
| after | string | no | A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and… |

### Create a Boleto
`POST https://apizie.tech/v1/payments:sqala/boleto-create-payment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve a Boleto
`GET https://apizie.tech/v1/payments:sqala/boleto-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Unique identifier for the object. |

### Retrieve a Bank Transfer
`GET https://apizie.tech/v1/payments:sqala/bank-transfer-get-bank-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| bankTransferId | string | yes |  |

### List all Bank Transfers
`GET https://apizie.tech/v1/payments:sqala/bank-transfer-list-all-bank-transfers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | string | no | A limit on the number of objects to be returned, between 1 and 50. |
| before | string | no | A cursor for use in pagination. ```before``` is an object ID that defines your place in the list. For instance, if you make a list request… |
| after | string | no | A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and… |

### List all Recipients
`GET https://apizie.tech/v1/payments:sqala/recipient-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | A limit on the number of objects to be returned, between 1 and 50. |
| before | string | no | A cursor for use in pagination. ```before``` is an object ID that defines your place in the list. For instance, if you make a list request… |
| after | string | no | A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and… |

### Create a Recipient
`POST https://apizie.tech/v1/payments:sqala/recipient-create-recipient` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve a Recipient
`GET https://apizie.tech/v1/payments:sqala/recipient-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Update a Recipient
`POST https://apizie.tech/v1/payments:sqala/recipient-update-recipient-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### List all Bank Accounts
`GET https://apizie.tech/v1/payments:sqala/recipient-list-bank-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| recipientId | string | yes |  |

### Create a Bank Account
`POST https://apizie.tech/v1/payments:sqala/recipient-create-bank-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| recipientId | string | yes |  |
| body | object | no | JSON request body |

### Retrieve a Bank Account
`GET https://apizie.tech/v1/payments:sqala/recipient-get-bank-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| recipientId | string | yes |  |
| bankAccountId | string | yes |  |

### Delete a Bank Account
`POST https://apizie.tech/v1/payments:sqala/recipient-delete-bank-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| recipientId | string | yes |  |
| bankAccountId | string | yes |  |

### List all Withdrawals
`GET https://apizie.tech/v1/payments:sqala/recipient-list-withdrawals` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| recipientId | string | yes |  |
| limit | string | no | A limit on the number of objects to be returned, between 1 and 50. |
| before | string | no | A cursor for use in pagination. ```before``` is an object ID that defines your place in the list. For instance, if you make a list request… |
| after | string | no | A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and… |

### Create a Withdrawal
`POST https://apizie.tech/v1/payments:sqala/recipient-create-withdrawal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| recipientId | string | yes |  |
| body | object | no | JSON request body |

### Retrieve a Withdrawal
`GET https://apizie.tech/v1/payments:sqala/recipient-get-withdrawal-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| recipientId | string | yes |  |
| withdrawalId | string | yes |  |

### Get Balance
`GET https://apizie.tech/v1/payments:sqala/recipient-get-balance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| recipientId | string | yes |  |

### List all Transactions
`GET https://apizie.tech/v1/payments:sqala/recipient-list-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| recipientId | string | yes |  |
| limit | string | no | A limit on the number of objects to be returned, between 1 and 50. |
| before | string | no | A cursor for use in pagination. ```before``` is an object ID that defines your place in the list. For instance, if you make a list request… |
| after | string | no | A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and… |

### Resend a Webhook
`POST https://apizie.tech/v1/payments:sqala/webhook-resend-attempt` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Retrieve a Webhook
`GET https://apizie.tech/v1/payments:sqala/webhook-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### List all Webhooks
`GET https://apizie.tech/v1/payments:sqala/webhook-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| status | string | no |  |
| event | string | no |  |
| endpointId | string | no |  |
| limit | integer | no | A limit on the number of objects to be returned, between 1 and 50. |
| before | string | no | A cursor for use in pagination. ```before``` is an object ID that defines your place in the list. For instance, if you make a list request… |
| after | string | no | A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and… |

## Example
```
curl "https://apizie.tech/v1/payments:sqala/token-generate-access-token" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Sqala Developer API API?
Create a free Apizie key, then send POST https://apizie.tech/v1/payments:sqala/token-generate-access-token with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Sqala Developer API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Sqala Developer API itself also needs your own key from api.sqala.tech.

### Can AI agents use the Sqala Developer API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key payments:sqala.

### What is the status of the Sqala Developer API API?
Needs your own provider key (bring your own key)