For the complete documentation index, see llms.txt. This page is also available as Markdown.

Receive Operation

Webhook respond body:

{
  //Unique Event ID
  "hook_id": "string",
  //Webhook Type
  "hook_type": int,
  "Data": {
    "Operation": {
      //Operation unique ID
      "opid": "string",
      //Customer unique ID
      "cuid": "string",
      //Operation flag
      "is_visible": bool,
      //Status of operation
      "status": int,
      //Operation Type
      "type": int,
      //Payment Type
      "payment_type": int,
      "created_at": {
        "seconds": int,
        "nanos": int
      },
      "updated_at": {
        "seconds": int,
        "nanos": int
      },
      //Operation Source requisite
      "source": {
        "account": "string",
        "beneficiar": "string"
      },
      //Operation Destination requisite
      "destination": {
        "account": "string",
        "beneficiar": "string"
      },
      //Operation source amount
      "source_amount": {
        "sum": {
          "currency_code": "string",
          "units": int,
          "nanos": int
        },
        "default": {
          "currency_code": "string",
          "units": int,
          "nanos": int
        }
      },
      //Operation destination amount
      "destination_amount": {
        "sum": {
          "currency_code": "string",
          "units": int,
          "nanos": int
        },
        "default": {
          "currency_code": "string",
          "units": int,
          "nanos": int
        }
      },
      //Comission amount
      "commission_amount": {
        "sum": {
          "currency_code": "string",
          "units": int,
          "nanos": int
        },
        "default": {
          "currency_code": "string",
          "units": int,
          "nanos": int
        }
      },
      //Current balance of source account on operation moment
      "current_balance_amount": {
        "sum": {
          "currency_code": "string",
          "units": int,
          "nanos": int
        },
        "default": {
          "currency_code": "string",
          "units": int,
          "nanos": int
        }
      },
      "comment": "string",
      "reference": "string",
      "is_manual": bool
    }
  }
}

Example webhook body:

Statuses

  • NEW = 0 : Flow status: Created new

  • PENDING = 1 : Flow status: Operation in pending mode (wait)

  • WORKING = 2 : Flow status: Operation in progress

  • SUCCESS = 3 : Result status: Operation is success

  • FAIL = 4 : Result status: Operation is fail

  • CANCELED = 5 : Result status: Operation canceled

Operation Types

  • DEPOSIT = 1 : Deposit operation

  • TRANSFER = 2 : Transfer operation

  • WITHDRAW = 3 : Withdrawal operation

  • COMMISSION = 4 : Commission operation

  • EXCHANGE = 5 : Exchange operation

Payment Types

Note: This types use only WITHDRAW type operation. For others operation use 0 (EMPTY) by default.

  • EMPTY = 0 : Default payment type. For operations that are not withdrawals.

  • ACH = 1 :

  • FEDWIRE = 2 : Fedwire money transfer system

  • SWIFT = 3 : Swift money transfer system

  • CRYPTO = 4 : Cryptocurrency transfers

  • EFT = 5 : EFT money transfer system

  • SEPA = 6 : European SEPA money transfer system

  • IMPS = 7 : IMPS money transfer system

Last updated