SPEI

The address of the request

The name of the environment	URL
SandBox	POST http://8.130.9.219:8899/api/supefina/transactions/payout
Formal environment	POST https://api.supefina.net/api/supefina/transactions/payout

How the request is made

Request header

Key	Value
Content-Type	application/json

Request body

Variable name	type	Required	description
account	String	Yes	Beneficiary account number The CLABE number is 18 digits Most bank card numbers are 16 digits
bankId	String	Yes	Beneficiary's bank number For details, please refer to: Download > list of Mexican banks
callbackUrl	String	No	Callback address For details, see Notification Callbacks
countryId	String	Yes	Country number Reference: Dictionary table - country number Mexico: MEX
currency	String	Yes	Currency Reference: Dictionary Table - Currency Mexican Peso: MXN
customerName	String	Yes	Beneficiary's name
description	String	Yes	Description of the order No special symbols
merId	String	Yes	Merchant ID Merchant ID acquisition path: Supefina Merchant Background - Merchant Management - Basic Information - Merchant ID
merOrderNo	String	Yes	Merchant order number
nonceStr	String	Yes	Random strings The length cannot exceed 32 bits
orderAmount	String	Yes	The amount of the order
payProduct	String	Yes	Payment type Clabe No: 15 Bank card number: 16 When the beneficiary account number belongs to CLABE, the example is 15 When the bankId is 90646-STP, 90706-ARCUS FI, 90684-TRANSFER, and 90659-ASP INTEGRA OPC, the payProduct only supports 15
sign	String	Yes	signature For details, please refer to: Signature algorithm

Sample request

{
    "account": "646150996402711110",
    "bankId": "40138",
    "callbackUrl": "https://test.com",
    "countryId": "MEX",
    "currency": "MXN",
    "customerName": "Test Name",
    "description": "1",
    "merId": "8302489774950079",
    "merOrderNo": "P02024051517452550031520001",
    "nonceStr": "4qeo9p0kuz0d1a4ehtujvbdqivn7mpvg",
    "orderAmount": "100.00",
    "payProduct": "15",
    "sign": "CD4B69BE52D44552B94CFB404CA5B54F"
}

Response parameters

Variable name	type	description
code	String	Response coding For details, see Response Status Code
data	Object	Response data
amount	BigDecimal	The amount of the order
fee	BigDecimal	Advance handling fee will be charged
merCode	String	Merchant ID
merOrderNo	String	Merchant order number
supefinaOrderNo	String	Supefina order number
transactionStatus	String	Order status Whether the initiation status of the order is successful or not has nothing to do with the real transaction status of the order. 00: The order is successful 04: Failed to place an order
msg	String	Response Information

Sample response

{
    "code": "200",
    "data": {
        "amount": 100.00,
        "fee": 2.80,
        "merCode": "8302489774950079",
        "merOrderNo": "P02024051517452550031520001",
        "supefinaOrderNo": "2024051503020044f56bd9608964b",
        "transactionStatus": "00"
    },
    "msg": "success "
}

Callback notifications

Submission method：POST

Note：

There are two callback notification statuses for SPEI payment. After receiving a successful callback event, the payment order may still receive a callback event with the payment status changing, and the payment status changes from successful to failed. The bank will check the account information twice, and the channel will call us successful after the first pass; At this time, the channel will send the money to the issuing bank of the receiving account, and the issuing bank will conduct a second account verification; If the customer's receiving account is wrong/expired, the account is locked, etc., the card issuer will not make the payment and will notify the failure.

Variable name	type	description
amount	String	The amount of the order
countryId	String	Country number Reference: Dictionary table - country number Mexico: MEX
customerName	String	Beneficiary's name
fee	String	Advance handling fee will be charged
merId	String	Merchant ID
merOrderId	String	Merchant order number
msg	String	message
nonceStr	String	Random strings The length cannot exceed 32 bits
realityAmount	String	Paid-in amount
realityFee	String	Actual handling fee
reference	String	Payment Reference
sign	String	signature
status	String	Transaction status For details, please refer to: Dictionary Table - Trading Order Status
successTime	String	The time at which the transaction was successful
supefinaOrderId	String	Supefina order number
transactionType	String	The type of transaction 01：Payin 02：Payout

An example of a callback notification

{
    "amount": "100.00",
    "countryId": "MEX",
    "customerName": "Test Name",
    "fee": "2.80",
    "merId": "8302489774950079",
    "merOrderId": "P02024051517452550031520001",
    "msg": "SUCCESS",
    "nonceStr": "20cba2cd-248b-4b4d-b59b-9e6997",
    "realityAmount": "100.00",
    "realityFee": "2.80",
    "reference": "2024051590706SXX5HDKCMTN4DM1S",
    "sign": "EAB0EF13923B2969FD9D55E5065B3D09",
    "status": "01",
    "successTime": 1715766375520,
    "supefinaOrderId": "2024051503020044f56bd9608964b",
    "transactionType": "02"
}

Callback notification response

After the merchant successfully receives the callback, it needs to return the specified string synchronously: SUCCESS does not return or returns other content by default, and the notification fails As：

public String test(){
	return "SUCCESS";
}

List of banks in Mexico

bankId	bankName
40138	ABC CAPITAL
40133	ACTINVER
40062	AFIRME
90661	ALTERNATIVOS
90706	ARCUS FI
90659	ASP INTEGRA OPC
40128	AUTOFIN
40127	AZTECA
37166	BaBien
40030	BAJIO
40002	BANAMEX
40154	BANCO COVALTO
37006	BANCOMEXT
40137	BANCOPPEL
40160	BANCO S3
40152	BANCREA
37019	BANJERCITO
40147	BANKAOOL
40106	BANK OF AMERICA
40159	BANK OF CHINA
37009	BANOBRAS
40072	BANORTE
40058	BANREGIO
40060	BANSI
40129	BARCLAYS
40145	BBASE
40012	BBVA MEXICO
40112	BMONEX
90677	CAJA POP MEXICA
90683	CAJA TELEFONIST
90630	CB INTERCAM
40143	CIBANCO
90631	CI BOLSA
90901	CLS
40130	COMPARTAMOS
40140	CONSUBANCO
90652	CREDICAPITAL
90688	CREDICLUB
90680	CRISTOBAL COLON
90723	Cuenca
40151	DONDE
90616	FINAMEX
90634	FINCOMUN
90689	FOMPED
90685	FONDO (FIRA)
90601	GBM
37168	HIPOTECARIA FED
40021	HSBC
40155	ICBC
40036	INBURSA
90902	INDEVAL
40150	INMOBILIARIO
40136	INTERCAM BANCO
90686	INVERCAP
40059	INVEX
40110	JP MORGAN
90653	KUSPIT
90670	LIBERTAD
90602	MASARI
90722	Mercado Pago W
40042	MIFEL
40158	MIZUHO BANK
90600	MONEXCB
40108	MUFG
40132	MULTIVA BANCO
37135	NAFIN
90638	NU MEXICO
90710	NVIO
40148	PAGATODO
90620	PROFUTURO
40156	SABADELL
40014	SANTANDER
40044	SCOTIABANK
40157	SHINHAN
90646	STP
90703	TESORED
90684	TRANSFER
90656	UNAGRA
90617	VALMEX
90605	VALUE
90608	VECTOR
40113	VE POR MAS
40141	VOLKSWAGEN
40124	CITI MEXICO
90699	FONDEADORA
90732	Peibo
90728	SPIN BY OXXO