> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.sqril.io/llms.txt.
> For full documentation content, see https://docs.sqril.io/llms-full.txt.
# Pay QR codes like a local across Asia, Africa and Latin America.
This collection includes all HTTP endpoints for the SQRIL SaaS payout system:
* Customer registration and profile management (registerCustomer/checkCustomer/updateCustomer)
* QR code decoding (decodeQr)
* Payout execution (executePayout)
* Payment provider integrations
* Transaction management
* Account webhook notifications
**Currency precision (request amounts)**\
Pass amounts as JSON numbers in standard currency units:
| Currency | Decimal places | Example |
| -------- | -------------- | ---------------------------- |
| IDR | 0 | `100000.00` = 100,000 IDR |
| PHP | 2 | `1000.50` = 1,000.50 PHP |
| VND | 0 | `1000000.00` = 1,000,000 VND |
| USD | 2 | `100.00` = 100.00 USD |
`decodeQr`**,** `getQuotation`**, and** `executePayout` **response formatting**\
\
USD fields in JSON responses from those endpoints:
* `fee` (total SaaS fee in USD), `percentage_fee`, `fixed_fee`, `amount_usd`: **2** decimal places
* `exchange_rate`: **10** decimal places (source currency → USD)
Where pricing is returned, `fee` equals `percentage_fee` + `fixed_fee` (within rounding). Older transactions may omit the breakdown.
Stored transaction data may keep higher precision; these limits apply to the HTTP response body.
All endpoints are RESTful HTTP endpoints.
**Customer flow (required):**
1. Call `registerCustomer` and store the returned `customer_id`.
2. (Optional) Call `checkCustomer` / `updateCustomer` to verify or update profile data.
3. Use the same `customer_id` in `decodeQr`, `getQuotation`, and `executePayout`.
4. `getQuotation` and `executePayout` enforce that `tx_id` belongs to the same `customer_id`.
These are the sender fields currently required by the local providers to execute a payment transaction.
## Sender Fields
This is a one-time call that will allow your customer to transact in any regions you integrated with.
#### **Sender Field Definition**
| Field name | Data Type | Description |
| -------------------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
| **name\_first** | string | First name of the sender |
| **name\_last** | string | Last name of the sender |
| **gender** | string | Gender of the sender (M if male, F if female) |
| **ic\_number** | string | ID number of the ic\_type |
| **ic\_type** | string | Type of identity card |
| **ic\_country** | String (ISO3166, country code) | The country the identity card was issued in |
| **occupation** | string | Code of the occupation of the sender. |
| **country\_of\_residence** | string (ISO3166, country code) | Country of residence of the sender |
| **phone** | string (E.164 format) | Phone number of the sender |
| **email** | string | Email address of the sender |
| **nationality** | string (ISO3166, country code) | nationality of the sender |
| **dob** | string (ISO8601 (YYYY-MM-DD) | Date of birth of the sender |
| **address** | string | Complete address |
| **ic\_expiry\_date** | string (ISO8601 (YYYY-MM-DD) | The expiration date for the provided identification card or passport. For non-expiring credentials, please input 2099-01-01. |
#### **Occupation List**
| **Code** | **Description** |
| --------- | ------------------------------- |
| **OCC1** | C-Suite executive / Board membe |
| **OCC2** | Employee |
| **OCC3** | Entrepreneur / Business owner |
| **OCC4** | Foreign worker |
| **OCC5** | Foreign domestic worker |
| **OCC6** | Home-maker |
| **OCC7** | Middle management employee |
| **OCC8** | Pilot |
| **OCC9** | Professional |
| **OCC10** | Senior management employee |
| **OCC11** | Student |
#### **Identification Card List**
| **Code** | **Description** |
| -------- | ------------------------------------------------------ |
| **NIC** | National ID Card / Identity Card / Identification Card |
| **PP** | Passport |
| **WEP** | Work Permit / Employment Pass |