Models and enums

An operation of Bill or Withdrawal creation will return a representation of this object on success. Also, the representation will be sent in a callback once the order is finalized.

Bill data representation

Parameter name	Type	Description
bill_id	Number	AnyCash order ID.
external_id	String	Order external ID (ID of order in calling system).
amount	String	The amount of payment to be paid. This is given in the major currency unit with up to 2 decimals of the minor currency unit. Example, 1000.50
currency	String	Currency of payment. Supported fiat currencies: UAH USD EUR KZT
payee_wallet_id	String	Funds recipient`s Any.Cash wallet ID. Example: AC11422
payer_wallet_id	String	Any.Cash user ID of a sender of the funds. NOTE! Will be empty for Bill order in all statuses, except COMPLETED state. Example: AC11422
is_kyc_required	Boolean	Flag determining if KYC-verification is mandatory for a payer.
payer_wallet_name	String	First and last names of a payer in Latin. Passed for Bill order type.
payer_wallet_name_ua	String	First and last names of a payer in Cyrillic. Passed for Bill order type.
payer_external_id	String (or null)	Additional info of a user - e.g. nickname of a payer in your system. If passed in the method call, it will be used in order details in UI of Any.Cash.
payee_external_id	String (or null)	Additional info of a payee - e.g. nickname of a payee in your system. If passed in the method call, it will be used in order details in UI of Any.Cash.
creation_timestamp	Number	Bill order creation time.
finalization_timestamp	Number	Bill order completion time. Empty if the status is PENDING.
expiration_timestamp	Number	Bill order expiration time (echoed from “expiration_time” of a request OR system`s default value OR empty if not configured)
status	String	Any.Cash order status. See Order status codes
comment	String	Free field for some additional information. Will be stored with the transaction details but not used in any logic.
deep_link	String (URL)	Any.Cash Telegram bot payment link with a token of the bill in Any.Cash.

Example:

{
   "bill_id": 767235763848585,
   "external_id": "800f696f-d0cd-45c8-bda4-b0a7a0727a24",
   "amount": "1000.62",
   "currency": "UAH",
   "payee_wallet_id": "AC54371",
   "payer_wallet_id": "AC12345",
   "is_kyc_required": true,
   "payer_wallet_name": "Elon Musk",
   "payer_wallet_name_ua": "Илон Маск",
   "payer_external_id": "@King_Arthur",
   "payee_external_id": "superuser20",
   "creation_timestamp": 1648461164,
   "finalization_timestamp": 1648161251,
   "expiration_timestamp": 1648161358,
   "status": "COMPLETED",
   "comment": "some additional data",
   "deep_link": "http://t.me/hog_polies_bot?start=bill-2324324"
}

Withdrawal data representation

Parameter name	Type	Description
withdrawal_id	Number	Any.Cash order ID
external_id	String	Order external ID (ID of order in calling system).
amount	String	The amount of payout. This is given in the major currency unit with up to 2 decimals of the minor currency unit. Example, 1000.50
currency	String	Currency of payment. Supported fiat currencies: UAH USD EUR KZT
payway	String	Payway of the withdrawal. NOTE! Only payway anycash is available for now.
payee_account	String	Funds recipient`s Any.Cash wallet ID. Example: AC11422
payer_wallet_id	String	Any.Cash user ID of a sender of the funds.
payee_external_id	String	Additional info of a payee - e.g. nickname of a payee in your system. Will be used in withdrawal details in UI of Any.Cash.
creation_timestamp	Number	Withdrawal order creation time.
finalization_timestamp	Number	Withdrawal order completion time.
comment	String	Free field for some additional information. Will be stored with the transaction details but not used in any logic.
status	String	Any.Cash order status. See Order status codes

Example:

{
  "withdrawal_id": "767235763848585",
  "external_id": "800f696f-d0cd-45c8-bda4-b0a7a0727a24",
  "amount": "1000.62",
  "currency": "UAH",
  "payee_account":"Korol (AC53442)",
  "payway": "anycash",
  "payer_wallet_id": "AC50959",
  "payee_external_id": null,
  "creation_timestamp": 1648461164,
  "finalization_timestamp": 1648462489,
  "comment": "some additional data",
  "status": "COMPLETED"
}

Order status codes enum

Status	Description
PENDING	An order is pending payment confirmation
COMPLETED	An order is completed successfully (payment is done)
CANCELLED	An order is canceled by initiator
REJECTED	An order is declined by the system for any reason
EXPIRED	An order is declined for a reason of order expiration

KYC-status enum

Value	Description
NONE	non-KYC user
VERIFIED_NAME	verified user identity
VERIFIED_ADDRESS	verified user identity and proof of address

API-key permissions enum

Value	Description
ALLOW_BILL_CREATION	eligible create Bill
ALLOW_WITHDRAWAL_CREATION	eligible create Withdrawal