SPEI
SPEI is the system created by the Mexican Central Bank to bring 24/7 real-time settlements to life. SPEI allows funds transferring amongst its participants. Brings information indicating if a client ordered a payment, and this, identify him/her. Likewise, it can carry information to request a payment from one of its participants. Please note this service is for Mexico only.
Submit a payout
Request a payout and transfer the funds to an external bank institution. Please note each country may have its own additional requirements and will have their own payment schedules, see below for detail information.
HTTP Request
POST
/v1/payments/payouts/spei
Request Headers
{
"Content-Type": "application/json",
"Authorization": "Bearer {{access_token}}",
"x-api-key": "{{api_key}}"
}
Request Body
{
"idempotencyKey": "idempotency-key",
"country": "MX",
"targetName": "usera",
"targetLastName": "lastname",
"targetEmail": "usera@liquido.com",
"targetDocument": "24988323888",
"targetBankName": "STP",
"targetBankCode": "706",
"targetBankBranchId": "123456789",
"targetBankAccountId": "706180105940410332",
"targetBankId": "90706",
"amountInCents": 10000,
"currency": "USD",
"comment": "Liquido CompanyName",
"callbackUrl": "https://api.client.com/callback/",
"subMerchantId": "UUID"
}
HTTP Headers Details
Key | Value |
---|---|
Content-Type | application/json |
Authorization | "bearer"+ "" + {{access_token}} |
x-api-key | {{api_key}} |
Request Body Details
Parameter | Required | Type | Description |
---|---|---|---|
idempotencyKey | String | Unique key to ensure idempotent requests.The length is no more than 128 characters | |
country | String | The user's country. ISO 3166-1 alpha-2 code, Length 2 characters, such as MX. | |
targetName | String | Target account holder full name or account holder first name if targetLastName has been set. | |
targetLastName | String | Target account holder last name | |
targetEmail | String | Target account holder email address | |
targetDocument | String | Target account holder identity | |
targetBankName | String | Target bank name | |
targetBankCode | String | Target bank code | |
targetBankBranchId | String | Target bank branch id | |
targetBankAccountId | String | Target bank account id. | |
targetBankId | String | Target bank id. Required when targetBankAccountId is a 16-digit bank card. see Supported Bank. | |
amountInCents | Long | The transfer amount. note: 100 = 1MXN/1USD | |
currency | String | The currency of the transferred fund, Length 3 characters, such as MXN, USD | |
comment | String | The payment description. It is recommended to use company name or APP name.The length is no more than 40 characters. The default is "payment". | |
callbackUrl | String | URL where Liquido will send notifications associated to changes to this payment. will receive a post request. | |
subMerchantId | String | The sub merchant ID. Required for PSPs. | |
riskData | JSON | The risk data of the payment. MERCHANT_APP_NAME or MERCHANT_WEBSITE must be provided in risk Data. Please see here for further details. |
Create A Payment With Risk Data
Please see here for further details.
Response Body Details
Parameter | Type | Description |
---|---|---|
idempotencyKey | String | Unique key to ensure idempotent requests. |
statusCode | Integer | 200 Success, 401 Access denied, 422 Required fields missing or invalid data, 500 internal error |
errorMsg | String | error message if failed |
transferStatus | String | Transfer status, SETTLED, IN_PROGRESS, FAILED or REJECTED. We should use transferStatus to judge the payment status |
transferStatusCode | Integer | Transfer status code, TransferErrorCode |
transferErrorMsg | String | Transfer error message if failed |
Supported Bank
Bank ID | Bank Name |
---|---|
37006 | BANCOMEXT |
37009 | BANOBRAS |
37019 | BANJERCITO |
37135 | NAFIN |
37166 | BaBien |
37168 | HIPOTECARIA FED |
40002 | BANAMEX |
40012 | BBVA MEXICO |
40014 | SANTANDER |
40021 | HSBC |
40030 | BAJIO |
40036 | INBURSA |
40042 | MIFEL |
40044 | SCOTIABANK |
40058 | BANREGIO |
40059 | INVEX |
40060 | BANSI |
40062 | AFIRME |
40072 | BANORTE |
40106 | BANK OF AMERICA |
40108 | MUFG |
40110 | JP MORGAN |
40112 | BMONEX |
40113 | VE POR MAS |
40127 | AZTECA |
40128 | AUTOFIN |
40129 | BARCLAYS |
40130 | COMPARTAMOS |
40132 | MULTIVA BANCO |
40133 | ACTINVER |
40136 | INTERCAM BANCO |
40137 | BANCOPPEL |
40138 | ABC CAPITAL |
40140 | CONSUBANCO |
40141 | VOLKSWAGEN |
40143 | CIBANCO |
40145 | BBASE |
40147 | BANKAOOL |
40148 | PAGATODO |
40150 | INMOBILIARIO |
40151 | DONDE |
40152 | BANCREA |
40154 | BANCO COVALTO |
40155 | ICBC |
40156 | SABADELL |
40157 | SHINHAN |
40158 | MIZUHO BANK |
40159 | BANK OF CHINA |
40160 | BANCO S3 |
90600 | MONEXCB |
90601 | GBM |
90602 | MASARI |
90605 | VALUE |
90608 | VECTOR |
90616 | FINAMEX |
90617 | VALMEX |
90620 | PROFUTURO |
90630 | CB INTERCAM |
90631 | CI BOLSA |
90634 | FINCOMUN |
90638 | NU MEXICO |
90642 | REFORMA |
90646 | STP |
90652 | CREDICAPITAL |
90653 | KUSPIT |
90656 | UNAGRA |
90659 | ASP INTEGRA OPC |
90670 | LIBERTAD |
90677 | CAJA POP MEXICA |
90680 | CRISTOBAL COLON |
90683 | CAJA TELEFONIST |
90684 | TRANSFER |
90685 | FONDO (FIRA) |
90686 | INVERCAP |
90689 | FOMPED |
90703 | TESORED |
90710 | NVIO |
90706 | ARCUS |
90661 | ALTERNATIVOS |
90723 | CUENCA |
90722 | MERCADO PAGO W |
90903 | CoDi Valida |