Create Virtual SPEI Account

How to create virtual SPEI account to submit a payin in Mexico.

Payin by SPEI

POST https://gateway-test.pagsmile.com/virtual-account/spei/create

This endpoint allows you to create virtual SPEI account number in Mexico.

Headers

Name	Type	Description
Content-Type*	string	application/json; chartset=UTF-8
Authorization*	string	Basic Base($app_id:$security_key)

Request Body

Name	Type	Description
app_id*	string	created app's id at dashboard - Max. 32 chars -
customer.email*	string	User's email
customer.identify.number*	string	User's identification number - 13 chars, ex: MAMB780915969; CURP: 18 chars -
notify_url*	string	Where Pagsmile will send notification to
customer.identify.type*	string	User's identification type - RFC or CURP -
customer.name*	string	User's name
timestamp*	string	yyyy-MM-dd HH:mm:ss - Max. 19 chars -
customer.buyer_id*	string	Customer's user id

200 submit successfully

{
    "account_id": "692W********MRW4",
    "account_number": "6461xxxxxxxxxx0137", //Clabe
    "buyer_id": "0001",
    "provider": "STP", //Bank name
    "status": "ACTIVE", //Status ENUM[ACTIVE/CANCELED]
    "beneficiary_name": "PAGSMILE MEXICO SA DE CV",
    "notify_url": "https://your-notify-url.com"
}

400 account pool run out

{
    "code": "40002",
    "msg": "Business Failed",
    "sub_code": "account-pool-run-out",
    "sub_msg": "account pool run out"
}

Example

curl --location --request POST 'https://gateway-test.pagsmile.com/virtual-account/spei/create' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    * "app_id": "162************38",
    * "notify_url": "http://merchant/callback/success",
    * "timestamp": "2022-01-01 03:54:01",
    * "customer" : {
    *     "identify": {
    *         "type": "RFC",
    *         "number": "MAMB780915969"
          },
    *     "buyer_id": "buyer_0101_0001",
    *     "name": "Test User Name",
    *     "email": "[email protected]"
      }
      }'

Note: 162************38 is pagsmile's test app id for sandbox, and MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ== is authorization token associated with the test app id.

Please use your own app_id and generate your own authorization token when testing.