Request Parameters

HTTP (web) Intent

The gateway URL:

https://apichain.catappult.io/transaction/inapp?value=XXX&currency=XXX&to=XXX&product=XXX&domain=XXX&data=XXX&callback_url=XXX

Request parameters

ParameterTypeDescription_of_fieldStaticOptionalExample
valueDoubleThe value in APPC (AppCoins by default) of the transaction.NY2.5
currencyStringThe currency in which the value is sent, if no currency is sent it is considered APPC (AppCoins).NYUSD or EUR
toStringThe wallet address of the receiver of the transaction. Attention: if your domain is registered on bds, this argument is ignored.YY0xda99070eb09ab6ab7e49866c390b01d3bca9d516
productStringThe id of the item being bought.YYsword.001
domainStringThe application id, also known as package name.YYcom.mygamestudio.game
dataStringAdditional information to be sent if needed.NY100 Gems
callback_urlStringThe developer's URL to be called after the transaction is completed.NYhttps://mygamestudio.co/appcoins?out_trade_no=1234
order_referenceStringUnique identifier of the transaction created by the developer.NY

Callback URL

The composition of the callback URL can contain as query string any parameter relevant to the transaction so that it can be handled on the developer's side. As an example, the following url beside the endpoint contains also a transaction id relevant to the developer.

https://www.mygamestudio.com/v1/appcoins_ipn.php?out_trade_no=2082389608326064

Parameters restriction

There are some ground rules that need to be taken in consideration regarding the parameter combination, when building the URL to call the wallet.

A transaction without product management requires at least the value for the transaction and the package name of the application as below:
https://apichain.catappult.io/transaction/inapp?value=1.50&domain=com.developers.mygame

Parameters possible combinations

valueproductdomaincallback_url

Note: The currency, to and data parameters are optional. In the case of the value set in the to parameter, if does not match the value defined as the wallet address for the given domain, the value is replaced with the later.