> For the complete documentation index, see [llms.txt](https://docs.pagsmile.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pagsmile.com/reference/payout/submit-a-payout/mexico/spei.md).
# SPEI
## Submit a payout by SPEI in Mexico
`POST` `https://sandbox.transfersmile.com/api/payout`
This endpoint allows you to submit a payout by SPEI in Mexico.
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | ----------------------------------- |
| Content-Type\* | string | application/json; charset=UTF-8 |
| AppId\* | string | Your App ID in payout platform |
| Authorization\* | string | SHA256($sorted\_params + $app\_key) |
#### Request Body
| Name | Type | Description |
| ---------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| name\* | string | beneficiary's name, length must between 5 and 40 |
| phone | string | beneficiary's phone
- Max 15, valid phone -
|
| email | string | beneficiary 's email
- Max 64, valid email -
|
| bank\_code\* | number | bank code, see bank list
- Required when account\_type is not clabe -
|
| account\* | number | account
- 10 \~ 18 digits -
|
| account\_type\* | string | one of \[debit \| phone \| clabe] |
| document\_id\* | string | beneficiary document id |
| document\_type\* | string | one of \[RFC \| CURP ] |
| method\* | string | payout method, e.g. SPEI |
| custom\_code\* | string | merchant payout id |
| fee\_bear\* | string | All fees charge to merchant or beneficiary
- One of: merchant, beneficiary -
|
| amount\* | number | Payout Amount, 2 decimal numbers
- Min 0.01, Max 400,000 -
|
| source\_currency\* | string | Merchant Account Currency
One of: USD, EUR, GBP, MXN
|
| arrival\_currency\* | string | MXN for Mexico |
| notify\_url\* | string | Where pagsmile will callback to |
| additional\_remark\* | string | Additional Remark
- Max Length: 40 -
|
| country\* | string | MEX for Mexico |
{% tabs %}
{% tab title="200: OK submit successfully." %}
```
{
"code": 200,
"msg": "success",
"time": 1628580845,
"data": {
"id": "S202108100734054iRiUZFPXfQM",
"custom_code": "custom_code9982674851738108",
"arrival_amount": "0.51",
"arrival_currency": "MXN",
"source_amount": "0.07",
"source_currency": "USD",
"status": "IN_PROCESSING"
}
}
```
{% endtab %}
{% tab title="400: Bad Request order already existed." %}
```
{
"code": 4001020,
"msg": "order already existed",
"time": 1628580940,
"data": {}
}
```
{% endtab %}
{% tab title="401: Unauthorized unauthorized" %}
```javascript
{
"code": 4004003,
"msg": "permission denied",
"time": 1637224716,
"data": {
... ...
}
}
```
{% endtab %}
{% tab title="500: Internal Server Error fee not configured" %}
```javascript
{
"code": 5001003,
"msg": "fee not configured",
"time": 1637224716,
"data": {
... ...
}
}
```
{% endtab %}
{% tab title="500: Internal Server Error balance insufficient" %}
```javascript
{
"code": 5001102,
"msg": "balance insufficient",
"time": 1637224716,
"data": {
... ...
}
}
```
{% endtab %}
{% tab title="500: Internal Server Error system error" %}
```javascript
{
"code": 5001000,
"msg": "system error",
"time": 1637224716,
"data": {
... ...
}
}
```
{% endtab %}
{% endtabs %}
## Example
```
curl --location --request POST 'https://sandbox.transfersmile.com/api/payout' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
* "name" : "GUILHERME ****** SOUZA",
"phone" : "468****068",
"email" : "g******me@gmail.com",
* "bank_code" : "40002",
* "account" : "002010077777777771",
* "account_type" : "clabe",
* "document_id" : "CUP800****691",
* "document_type" : "RFC",
* "method" : "SPEI", // fixed value: SPEI
* "custom_code" : "custom_code9982674851738108", // merchant order id
* "fee_bear" : "merchant",
* "amount" : "0.51",
* "source_currency" : "MXN",
* "arrival_currency" : "MXN", // fixed value: MXN
* "notify_url" : "https://notify.url",
* "additional_remark" : "pagsmile payout test remark",
* "country" : "MEX" // fixed value: MEX
}'
```
{% hint style="info" %}
Note: ***94FAC\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*68548*** is Pagsmile's test App ID for sandbox, and ***d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302*** is authorization token associated with the test App ID.
{% endhint %}
{% hint style="success" %}
In **sandbox** environment, please use ***002010077777777771*** as **SPEI** account for testing **PAID** payout, and the account ***014027000005555558*** for testing **FAILED** payout.
{% endhint %}
## Example of SPEI account
| Account Type | Account | |
| ------------ | ------------------ | --------- |
| clabe | 112233445566778899 | 18 digits |
| debit | 1122334455667788 | 16 digits |
| phone | 5522123456 | 10 digits |
{% tabs %}
{% tab title="Mexico document type" %}
Mexican taxpayers could get RFC.
RFCs are 13 digits long for individuals, 12 for companies, and they’re made up of letters and numbers. The first 4 digits for individuals, or 3 for companies, are taken from the name, then there are six numbers denoting the date of birth or when the business was founded, and the end digits are check digits.
Mexican citizen or resident could get CURP.
It’s an 18-digit social security number for people living in Mexico. The 18 characters combine information deriving from your name, date and place of birth, and gender to create a unique code.
{% endtab %}
{% tab title="Mexico bank account" %}
The first three digits of the bank account should be the last three digits of the bank code.
```
"bank_code":"90646",
"account":"64618**********1800"
```
{% endtab %}
{% endtabs %}