Sign in

v1

latestOpenAPI 3.1.02026-08-0671638.9 KB

Create Cash-In

Creates a new cash-in operation that allows users to deposit money at physical locations.

  • Amount Limits: 10 - 6000 MXN (may vary by physical location)
  • Expiration: 3 days from creation (on closed references)
  • Reference: 20-digit unique reference number

Open References: Some clients can create "open references" without specifying an amount upfront. When creating an open reference, the amount parameter can be omitted, and the actual amount will be determined at the time of payment at the physical location.

post/api/v1/cash/cash_in

Headers

X-Client-Idstring required

Client API key (32-character hex)

X-Signaturestring required

HMAC-SHA256 signature generated using api_secret

X-Timestampstring required

Unix timestamp (seconds since epoch)

Request body

amountinteger

Transaction amount in MXN (required for standard cash-in, optional for open references)

external_user_idstring required

Unique identifier for the end user

document_type'INE' | 'CURP' | 'RFC'

Type of identification document (optional)

document_idstring

Document identification number (optional)

phonestring

User's phone number - exactly 10 digits (optional)

Example request

{
  "amount": 500,
  "external_user_id": "USER123456",
  "document_type": "INE",
  "document_id": "1234567890123",
  "phone": "5512345678"
}

Response

Cash-in created successfully

response_codestring

Response code ("0" for success)

response_textstring

Response message

Example response

{
  "response_code": "0",
  "response_text": "Operacion creada",
  "result": {
    "operation_id": 123,
    "kind": "cash_in",
    "reference": "10511175512161627448",
    "status": "close",
    "transaction_id": "FMXdbnBuiw2SHqSyfzSkqN71q",
    "amount": 500,
    "created_at": "2025-01-15T10:30:00Z",
    "expire_at": "2025-01-18T10:30:00Z"
  }
}