Sign in

v1

latestOpenAPI 3.1.02026-08-0671638.9 KB

Create Cash-Out

Creates a new cash-out operation that allows users to withdraw money at physical locations.

  • Amount Limits: 50 - 3000 MXN (may vary by physical location)
  • Expiration: 60 minutes from creation (default)
  • Reference: 20-digit unique reference number
  • Note: Maximum and minimum amount may vary by physical location.
post/api/v1/cash/cash_out

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 required

Transaction amount in MXN

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": 250,
  "external_user_id": "USER789012",
  "document_type": "CURP",
  "document_id": "ABCD123456HMNMNL01",
  "phone": "5587654321"
}

Response

Cash-out 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"
  }
}