Payin API — Create CLABE Reference

Overview

Creates a CLABE reference (18 digits). Show the returned clabe to the payer; the payer transfers via SPEI to this account. The platform calls back the merchant once the funds arrive.

API Info

• Endpoint: POST /api/mx/payin
• Method: POST
• Content-Type: application/json

Request Headers

See API Signature:

Header	Type	Required	Description
Content-Type	string	Y	application/json
MerchantId	string	Y	Merchant ID provided by Veloraya
Timestamp	string	Y	Millisecond timestamp, anti-replay
Nonce	string	Y	Random string, unique per request
Signature	string	Y	RSA signature, Base64 encoded

Request Parameters

Parameter	Type	Required	Description
merchantOrderId	String(≤32)	Y	Merchant order ID, globally unique (idempotency key)
amount	BigDecimal(2dp)	Y	Order amount, > 0, MXN
currency	string	Y	Fixed MXN
payinMethod	string	Y	Fixed CLABE
payerName	String(≤128)	Y	Payer name (KYC)
payerIdCard	String(≤50)	Y	Payer ID / RFC (13 chars)
payerEmail	string	Y	Payer email
payerIdType	String(≤20)	Y	Payer ID type
payerMobile	String(≤36)	Y	Payer mobile
expireSeconds	Integer	N	Expiry (seconds), 15min~7 days, default 3 days
redirectUrl	String(≤255)	N	Redirect URL (reserved)

Request Example

{
  "merchantOrderId": "M20260813001",
  "amount": "100.00",
  "currency": "MXN",
  "payinMethod": "CLABE",
  "payerName": "JUAN PEREZ",
  "payerIdCard": "XAXX010101000",
  "payerEmail": "payer@example.com",
  "payerIdType": "RFC",
  "payerMobile": "5551234567",
  "expireSeconds": 259200
}

Response Parameters (data)

Parameter	Type	Description
orderId	string	Platform order ID
merchantOrderId	string	Merchant order ID
clabe	string	CLABE reference (18 digits), the payer's transfer target
vaName	string	Account name
amount	BigDecimal	Order amount
fee	BigDecimal	Fee
orderStatus	string	PENDING / SUCCESS / FAILED
resultCode	string	Error code (on failure)
resultDesc	string	Error description (on failure)

Response Example

{
  "code": 200,
  "msg": "success",
  "data": {
    "orderId": "2100000000000000001",
    "merchantOrderId": "M20260813001",
    "clabe": "659437000000225142",
    "vaName": "JUAN PEREZ",
    "amount": 100.00,
    "fee": 1.50,
    "orderStatus": "PENDING",
    "resultCode": "200",
    "resultDesc": "success"
  }
}