SPEI

Where to submit a payout by SPEI in Mexico.

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

- 0 ~ 15 digits -

email

string

beneficiary 's 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

one of [beneficiary | merchant]

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

{
    "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"
    }
}

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
}'

Note: 94FAC**********************68548 is Pagsmile's test App ID for sandbox, and d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302 is authorization token associated with the test App ID.

In sandbox environment, please use 002010077777777771 as SPEI account for testing PAID payout, and the account 014027000005555558 for testing FAILED payout.

Example of SPEI account

Account Type
Account

clabe

112233445566778899

18 digits

debit

1122334455667788

16 digits

phone

5522123456

10 digits

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.

PreviousMexicoNextPeru

Last updated