Skip to content

Order

Methods return the values of only requested keys leaving the rest remain empty

Caution!

If the payment was created for iban payway and the EUR currency, it is necessary to wait for an intermediate callback from Any.Money that will return the details for sending a SEPA transfer: payment_data. This information has to be provided to the payer in order for him to make a bank transfer.

order params representation (full callback message)

Parameters of Any.Money order

account_amount
debit/credit sum except for the fee
address
crypto address for cryptocurrency invoice payment. When paying with multy subpay, the address of the last one is returned
amount_paid
the parameter returned only by SCI-methods contains the amount of payments made as part of the SCI-payment
code
code data representation
confirmations
number of confirmations (confirmed blocks) for orders with cryptocurrencies
ctime
order creation time (timestamp)
delay
delay time before payment (milliseconds). For replenishments this parameter will always equal to "0"
email
e-mail address for sending the messages of invoice-payment status changes
externalid
unique ID specified by the merchant
front_params
list of merchant's parameters for frontend. In JSON object format: {key: value} (only for invoice type orders)
ftime
order finalizing time (timestamp)
in_amount
credit sum
in_curr
credit currency
in_fee_amount
fee sum in credit currency
is_multipay
the possibility flag of surcharges, refunds, reimburse for invoice payment. For a payout, indicates whether it was made by multiple transactions or by one
lid
local order ID
merchant_payfee
the share of the incoming payments fee paid by the merchant (values in the [0..1] range, accurate to two decimal places)
orig_amount
original order sum (that is booked during order creation)
out_amount
debit amount for the current order
out_curr
debit currency
out_fee_amount
fee amount in a debit currency
owner
order creator merchant ID
payer
payer ID
paylink
field available only for invoice orders. Contains link to the payment page
payway_name
the name of order payway. It is filled only for singlepay payments and remains empty for multipay ("btc", "perfect", "qiwi"... etc.)
rate
currency convertation rate, if performed. In the "rate": ["25.30301", "1"] format
redirect_url
URL, used by the fronted for default redirection
ref
internal order ID. For cryptocurrency transactions and is equal to tx_id
renumeration
recalculated sum (for the payout orders, if the order was recalculated), refund sum (for invoice order with overpay)
reqdata
original query data in the format {key: value}. For example: {amount: 10, externalid: 1556712010408, in_curr:UAH, out_curr:UAH, payway:privat24, userdata: {payee:4444444444444448}}
status
actual order status
tgt
merchant, the payee (for the transfer type transactions)
token
unique order ID-key
tp
order type (allowable options: "payin", "autopayin", "coderedeem", "payout", "convert, "transfer", "invoice", "sci_subpay", "sci_refund)
txid
the ID of cryptocurrency transaction (true = cryptocurrency used in transaction, false = only fiat currencies)
uaccount
payee details (for invoice, payout type transactions)
userdata
payee details (for external payways {"payee": 4444444444444448})
acs_url
a URL to which the payer should be redirected for 3DS authentication. Returns only for payment in wait status
payment_data
Data for making a payment. The actual values for making a payment are sent to the callback_url specified when creating the order.
Each payment system will have its own set of fields:
iban:
bank_address: payee's bank address
bank_name: payee's bank name
beneficiary: payee's name
bic: payee's bank code
country: bank country
iban: IBAN to transfer funds by the user
reference: purpose of the payment, which the user must indicate when transferring funds to IBAN
card:
card: card number
reference: purpose of the payment

restricted callback message representation

Restricted callback message returned for the cryptocurrency replenished orders .

Restricted callback message representation

account_amount
debit sum except for the fee
confirmations
number of confirmations (confirmed blocks)
ctime
order creation time (timestamp)
ftime
order finalizing time (timestamp)
in_amount
credit sum
in_curr
credit currency
in_fee_amount
fee sum in credit currency
lid
local order ID
out_amount
debit amount for the current order
out_curr
debit currency
out_fee_amount
fee amount in a debit currency
payway_name
the name of order payway ("btc", "perfect", "qiwi"... etc.)
status
actual order status
tp
order type (autopayin)
txid
the ID of cryptocurrency transaction (true for the cryptocurrency replenished orders)

front_params fields description

front_params fields description

logo
custom logo for SCI (the merchant selects the logo itself to be displayed on SCI instead of the standard ANYMONEY logo). Format: image converted to base64 format. Example: logo: "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVV...."
theme
set the day/night mode for SCI (volumes: “night”, “day”, ”auto”)
theme_color
set the color theme for SCI elements selected by the merchant. Format: “violet”, “yellow”, “red” etc.

order statuses description

Possible order states

status final description
new no accepted for execution
partially_paid no the invoice has not yet been paid in full, but there is already at least one successful payment on this invoice
pending no waiting for execution
started no processing
accepted no execution started after specified delay
wait no waiting for completion
retry no executing after error
abnormal no not defined (error)
finalizing no in a state of convertation from the receipt currency to the invoice crediting currency
done yes successfully completed
partially_done yes payment not fully paid
fail yes unsuccessfully completed
reject yes denied
canceled yes cancelled by the user
expired yes expired lifetime or expiry order params