API Reference

API

Possible transaction statuses

PENDING: The transaction is pending processing.
SUCCESS: The transaction has been successfully completed.
REVERTED: The transaction has been reversed.
CANCELED: The transaction has been canceled.

Possible operations

CASHIN: Represents an incoming money operation.
CASHOUT: Represents an outgoing money operation.

Basic Structure of a Transaction


The basic structure of a transaction, returned when searching for transactions and received by webhooks. Below are examples of both a CASHOUT and a CASHIN transaction:

{
  "status": "SUCCESS",
  "amount": "100.00",
  "operation": "CASHOUT",
  "conciliationId": "99649ad8436d426783a7b4828025ea3e",
  "amountWithFee": "100.00",
  "previousBalance": "2000.00",
  "details": {
    "senderName": "Sender Name",
    "senderClabe": "123456789",
    "receiverName": "Receiver Name",
    "receiverClabe": "123456789"
  }
}
{
  "status": "SUCCESS",
  "amount": "100.00",
  "operation": "CASHIN",
  "conciliationId": "67d87611d2de43fc9a9a44f805e23e33",
  "amountWithFee": "100.00",
  "previousBalance": "2000.00",
  "details": {
    "senderName": "Sender Name",
    "senderClabe": "123456789",
    "receiverName": "Receiver Name",
    "receiverClabe": "123456789"
  }
}