Bills
Create Bill
Creates a bill
POST https://rest.any.cash/v1/bills
This operation is intended to allow a user to create a bill (payment request) requesting a sender to confirm funds transfer from their wallet account to a user (merchant) wallet account (recipient of the funds). If parameter - payer_wallet_id - is passed in the request, then Any.Cash will send bill order push-notification to the payer's account in Any.Cash bot (Telegram web/desktop/mobile app will send a standard message notification to the user).
Request Body
external_id*
String
External Order ID
amount*
String
The amount of order. 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 ISO 4217 (alpha-3). UAH/USD/EUR/KZT
callback_url
String
URL to send the result of the payment order to.
is_kyc_required
Boolean
Flag determining if KYC-verification is mandatory for a payer. If not passed in the request, by default it is TRUE. If set to TRUE and a payer of BILL is non-verified, then they will get an error with the request to pass verification first.
payer_wallet_id
String
Any.Cash wallet ID of a sender of the funds. NOTE! Creating a bill with a predefined payer is eligible only for tenants. If the request is created without a tenant signature, then the method will return an error - VALIDATION_ERROR
payer_external_id
String
Additional info of a user - e.g. nickname of the user (payer) in your system. Will be used in order details in UI of Any.Cash
payee_external_id
String
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.
expiration_time
String
Expiration timestamp of the order. It allows for avoiding funds transfer after the order is expired. Default 15 min after bill creation.
comment
String
Free field for some additional information. Will be stored with the transaction details but not used in any logic.
amount exceeds transaction max limit
amount is under transaction min limit
currency is not supported
an order with such an external_id already exists
Query Bill status
Returns a current status of a bill
GET https://rest.any.cash/v1/bills/{external_id}
This method is intended to allow a user (merchant) to query a current status of a bill (payment request).
Path Parameters
external_id*
String
External Order ID
Cancel Bill
Cancels a bill
PUT https://rest.any.cash/v1/bills/{external_id}/cancel
This method is intended to allow a user (merchant) to cancel a bill (payment request). Successful execution of this method will return 200 OK status code and will be followed by Transaction completion notification with CANCELED status.
Path Parameters
external_id*
String
External Order ID
Last updated