Skip to main content

​
Get started in three steps

Make your first API request and start integrating CashQ money transfers into your application.

​
Step 1: Get your API credentials

1

Request sandbox access

Fill out the Sandbox Request Form to get your sandbox API credentials.
You’ll receive your API key via email within 24 hours.
2

Understand the environments

CashQ provides two environments:
EnvironmentBase URLPurpose
Sandboxhttps://api.cashqbot.com/Testing and development
ProductionContact supportLive transactions
Data created in sandbox will not affect production and cannot be transferred between environments.

​
Step 2: Make your first API request

1

Check your balance

Test your API credentials by checking your merchant balance:
curl -X GET 'https://api.cashqbot.com/api/agent_balance' \
  -H 'API-KEY: your_api_key_here'
A successful response will return your balance in cents:
{
  "balance": {
    "balance": 0,
    "overdraft": 2000
  }
}
2

Verify recipient KYC status

Check if a recipient is KYC verified and their transfer limits before sending money:
curl -X GET 'https://api.cashqbot.com/api/kyc/16175551212' \
  -H 'API-KEY: your_api_key_here'
A successful response will show the recipient’s KYC status and limits:
{
  "kyc_verify": true,
  "money_limit": "8990",
  "kyc_url": ""
}
Phone numbers must be in E.164 format without the + sign: [country code][subscriber number]
Important: Always verify KYC status before sending transfers. Recipients must be KYC verified and the transfer amount must not exceed their money_limit.

​
Step 3: Send your first transfer

1

Check the transfer

Before sending money, validate the transfer details:
curl -X POST 'https://api.cashqbot.com/api/checkTransfer' \
  -H 'API-KEY: your_api_key_here' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "123456789",
    "sender_phone": "5551234567",
    "receiver_phone": "5551234568",
    "amount": "5.0",
    "receiver_country": "MX"
  }'
2

Execute the transfer

Once validated, execute the money transfer:
curl -X POST 'https://api.cashqbot.com/api/transfer' \
  -H 'API-KEY: your_api_key_here' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "123456789",
    "sender_phone": "5551234567",
    "receiver_phone": "5551234568",
    "amount": "5.0",
    "receiver_country": "MX"
  }'
You’ll receive a response with the transfer status and ID.

​
Next steps

Now that you’ve made your first API request, explore the full API capabilities:

KYC Verification

Learn about KYC requirements and verification limits.

API Reference

Explore all available API endpoints and parameters.

Authentication

Learn about API authentication and security best practices.

Error Handling

Understand error responses and how to handle them.

Status Codes

Reference guide for transfer status codes.

Transaction Flow

Complete payment flow combining Payin and Payout APIs.

​
Need help?

Contact Support

Have questions or need production credentials? Reach out to our team.