Payments
All payments endpoints have path prefix /payments-service.
Example of main payments doc
{
"_id": "shping_payments_plans",
"currency": "aud",
"list": [
{
"id": "basic",
"name": "BASIC",
"cost": 0,
"hidden": false,
"commitment_period": 0,
"description": "Basic plan",
"modules": [],
"coin_rate": 0,
"upgrade_description": "You are currently on the Basic plan and have limited access to product analytics and promotional opportunities. Upgrade now!",
"description_list": [
{
"label": "GTIN",
"value": "Unlimited"
},
{
"label": "Product catalogue",
"value": true
},
{
"label": "Ingredients and Raw Materials",
"value": true
},
{
"label": "Availability Map",
"value": false
},
{
"label": "Engagement and Consumer Analytics",
"value": false
},
{
"label": "Reviews",
"value": false
},
{
"label": "Shoutouts",
"value": false
},
{
"label": "Shping bot",
"value": false
},
{
"label": "Rewards",
"value": false
},
{
"label": "Advanced Engagement (ToDo cards)",
"value": false
}
]
},
{
"id": "light",
"cost": 195,
"name": "LIGHT",
"hidden": false,
"coin_rate": 0.1,
"upgrade_description": "You are currently on the Light plan and have limited access to product analytics and promotional opportunities. Upgrade now!",
"description": "Lite plan",
"commitment_period": 52,
"modules": [
"product360",
"reviews"
],
"description_list": [
{
"label": "GTIN",
"value": "1-20"
},
{
"label": "Product catalogue",
"value": true
},
{
"label": "Ingredients and Raw Materials",
"value": true
},
{
"label": "Availability Map",
"value": true
},
{
"label": "Engagement and Consumer Analytics",
"value": true
},
{
"label": "Reviews",
"value": true
},
{
"label": "Shoutouts",
"value": false
},
{
"label": "Shping bot",
"value": false
},
{
"label": "Rewards",
"value": false
},
{
"label": "Advanced Engagement (ToDo cards)",
"value": false
}
]
},
{
"id": "pro",
"cost": 395,
"name": "PRO",
"description": "Standart plan",
"coin_rate": 0.2,
"hidden": false,
"commitment_period": 52,
"upgrade_description": "You are currently on the Pro plan and have limited access to product analytics and promotional opportunities. Upgrade now!",
"modules": [
"product360",
"reviews",
"rewards"
],
"description_list": [
{
"label": "GTIN",
"value": "21-500"
},
{
"label": "Product catalogue",
"value": true
},
{
"label": "Ingredients and Raw Materials",
"value": true
},
{
"label": "Availability Map",
"value": true
},
{
"label": "Engagement and Consumer Analytics",
"value": true
},
{
"label": "Reviews",
"value": true
},
{
"label": "Shoutouts",
"value": true
},
{
"label": "Shping bot",
"value": true
},
{
"label": "Rewards",
"value": true
},
{
"label": "Advanced Engagement (ToDo cards)",
"value": true
}
]
},
{
"id": "pro-corp",
"name": "PRO-CORP",
"description": "Pro plan",
"upgrade_description": "Corp-Pro is our top level, you already have access to all Shping's great features!",
"cost": 495,
"hidden": false,
"coin_rate": 0.3,
"commitment_period": 52,
"modules": [
"product360",
"reviews",
"livechat",
"rewards"
],
"description_list": [
{
"label": "GTIN",
"value": "501-999"
},
{
"label": "Product catalogue",
"value": true
},
{
"label": "Ingredients and Raw Materials",
"value": true
},
{
"label": "Availability Map",
"value": true
},
{
"label": "Engagement and Consumer Analytics",
"value": true
},
{
"label": "Reviews",
"value": true
},
{
"label": "Shoutouts",
"value": true
},
{
"label": "Shping bot",
"value": true
},
{
"label": "Rewards",
"value": true
},
{
"label": "Advanced Engagement (ToDo cards)",
"value": true
}
]
}
],
"type": "system_doc"
}
User card
Set the by token
PUT /payments-service/user/card/:token
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
TODO
Delete the card
DELETE /payments-service/user/card
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Read actual billing plans
Read this plans
GET /payments-service/billing_plans
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
{
"currency": "aud",
"id": "shping_payments_plans",
"list": [
{
"commitment_period": 0,
"cost": 0,
"description": "Basic plan",
"description_list": {
"Advanced Engagement (ToDo cards)": false,
"Availability Map": false,
"Engagement and Consumer Analytics": false,
"GTIN": "Unlimited",
"Ingredients and Raw Materials": true,
"Product catalogue": true,
"Reviews": false,
"Rewards": false,
"Shoutouts": false,
"Shping bot": false
},
"hidden": false,
"id": "basic",
"modules": [],
"name": "BASIC",
"coin_rate": 0
},
{
"commitment_period": 52,
"cost": 195,
"description": "Lite plan",
"description_list": {
"Advanced Engagement (ToDo cards)": false,
"Availability Map": true,
"Engagement and Consumer Analytics": true,
"GTIN": "1-20",
"Ingredients and Raw Materials": true,
"Product catalogue": true,
"Reviews": true,
"Rewards": false,
"Shoutouts": false,
"Shping bot": false
},
"hidden": false,
"id": "light",
"modules": [
"product360",
"reviews"
],
"name": "LIGHT",
"coin_rate": 0.1
},
{
"commitment_period": 52,
"cost": 395,
"description": "Standart plan",
"description_list": {
"Advanced Engagement (ToDo cards)": true,
"Availability Map": true,
"Engagement and Consumer Analytics": true,
"GTIN": "21-500",
"Ingredients and Raw Materials": true,
"Product catalogue": true,
"Reviews": true,
"Rewards": true,
"Shoutouts": true,
"Shping bot": true
},
"hidden": false,
"id": "pro",
"modules": [
"product360",
"reviews",
"rewards"
],
"name": "PRO",
"coin_rate": 0.2
},
{
"commitment_period": 52,
"cost": 495,
"description": "Pro plan",
"description_list": {
"Advanced Engagement (ToDo cards)": true,
"Availability Map": true,
"Engagement and Consumer Analytics": true,
"GTIN": "501-999",
"Ingredients and Raw Materials": true,
"Product catalogue": true,
"Reviews": true,
"Rewards": true,
"Shoutouts": true,
"Shping bot": true
},
"hidden": false,
"id": "pro-corp",
"modules": [
"product360",
"reviews",
"livechat",
"rewards"
],
"name": "PRO-CORP",
"coin_rate": 0.3
}
]
}
Participant Billing Plan
Read Current Billing Plan
Retrieves active billing plan of current participant. Returns JSON with plan and payment card info.
GET /payments-service/participants/current/billing_plan
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Activated plan. Example Response
{
"card": {
"address_city": null,
"address_country": null,
"address_line1": null,
"address_line2": null,
"address_state": null,
"address_zip": null,
"brand": "Visa",
"exp_month": 11,
"exp_year": 2022,
"id": "card_1CrRhbEFVOePY2EFnZr18Tmf",
"last4": "4242",
"name": "user surname"
},
"contract": {
"from": "2017-07-11",
"terminate_available": true,
"terminated": false,
"to": "2018-08-24"
},
"paid_from": "2018-07-24",
"paid_to": "2018-08-24",
"plan": "light",
"trial": {
"status": false
},
"updated_at": "2017-07-11T14:41:30Z",
"user_email": [
"billing_test5@mailinator.com"
]
}
Trial plan. Example Response
{
"card": null,
"contract": {
"terminate_available": true,
"terminated": false
},
"paid_from": null,
"paid_to": null,
"plan": "complete",
"trial": {
"form": "2018-06-24T14:33:40Z",
"status": true,
"to": "2018-07-24T14:33:40Z"
},
"updated_at": "2018-07-24T15:36:23Z",
"user_email": [
"billing_test5@mailinator.com"
]
}
Change Billing Plan
Change Billing Plan
Change active billing plan for current participant. Takes JSON object containing new plan name (basic, lite, standard or pro) and payment card information. For plans other than basic payment card is required. Payment card details may be specified directly (card object must contain number, exp_year, exp_month and cvc) or by means of a card token generated on client side (card object must contain nonce token). Card token generation is the preferred method, it's payment service provider dependent. Currently server uses Stripe for actual payment processing (see https://stripe.com/docs/stripe-js for client side library).
The default modules for plans:
* basic - hasn't active modules;
* lite has product360 and reviews;
* standard has product360, reviews, rewards;
* pro has product360, reviews, chat, rewards.
The default modules may be set in sys.config. The participant can upgrade the plan at any time. The plan can only be downgraded after 52 weeks of using the current plan. When the plan is changed, the payment is recalculated and fees for used rewards campaign coins. The coins will be convert to сurrency depending on the plan:
* lite - 1point = 0.1 (usd);
* standard - 1point = 0.2 (usd);
* pro - 1point = 0.3 (usd).
The actual currency may be set in sys.config. Default is usd. Payment depends of the participant's plan:
* basic - 0;
* lite - 195;
* standard - 395;
* pro - 495.
PUT /payments-service/participants/current/billing_plan
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Example Request
{
"plan": "standard",
"card": {
"number": "5200828282828210",
"exp_month": 12,
"exp_year": 2019,
"name": "JANE DOE",
"cvc": 323
}
}
Set email for user's notification
User, who was activate the billing plan (or set new card) can set/remove additionals emails for receiving notifications.
PUT /payments-service/participants/notifications/email
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| Email (“foo@bar.com”) - optional | ||
| user_id | User ID (“urn:authenticateit:user:email:foo@bar.com”) - optional. If id is user_id then email will be read from user profile |
Example Response
[
"some_user@gmail.com",
"foo@bar.com",
"foo1@bar.com"
]
Remove email
POST /payments-service/participants/notifications/delete_email
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| string |
Example Response
[
"some_user@gmail.com",
"foo1@bar.com"
]
Get participant payment history
API to read payment history of current participant. Returns JSON list of history entries. Each entry has timestamp ts, type of the payment in payment_type field (either subscription or rewards), amount field and card object field. Card object has last four digits of the card number in the last4 field.
GET /payments-service/participants/current/payment_history
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
[
{
"card_barnd": "MasterCard",
"card_exp_month": 12,
"card_exp_year": 2019,
"card_last4": "8210",
"card_name": "JANE DOE",
"currency": "usd",
"rows": [
{
"amount": "395.00",
"description": "Selected plan - \"standard\". Paid period: from 2017-03-24 to 2017-04-24"
},
{
"amount": "20.00",
"description": "Used rewards coins. Paid period: from 2017-03-24 to 2017-04-24"
}
],
"status": "Payment successful",
"summary_amount": "415.00",
"ts": "2017-04-23T21:10:03Z"
}
]
Terminate contract
GET /participants/:id/contract/terminate
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Participant Ethereum Account
Read Ethereum Account
Retrieves Ethereum account information of current participant. Returns
JSON with address field (checksum encoded Ethereum address). If
participant has no Ethereum account configured, address may be
null or missing in the response.
GET /payments-service/participants/current/ethereum
Parameters
| Name | Type | Description |
|---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
Example Response
{
"address": "0x5aAeb6053F3E94C9b9A09f33669435E7Ef1BeAed"
}
Update Ethereum Account
Change Ethereum account information of current participant. Accepts
JSON object with field address (Ethereum address, or null to clear
the address). Responds with updated participant's Ethereum account
information. Participant must have no active reward campaigns to
change Ethereum address.
PUT /payments-service/participants/current/ethereum
Parameters
| Name | Type | Description |
|---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
Example Request
{
"address": null
}
Get participant deposit settings
GET /payments-service/participants/deposit/ethereum
Parameters
| Name | Type | Description |
|---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
Example Response
{
"address": "0x3d74e50Fb155f32d2A477F9068B30C2B28377f8e",
"unlimited_coins": false,
"coins": "1250000000000000000000",
"fee": {
"source": "invoice",
"status": "active",
"ts": "2019-04-05T02:34:35Z",
"type": "coins",
"value": "20000000000000000000"
}
}
Response parameters
| Name | Type | Description |
|---|---|---|
| address | body | Deposit ethereum address |
| unlimited_coins | body | Boolean parameter. Optional |
| coins | body | Deposit coins value. Optional, 0 by default |
User's coins transfers
Add new / update address
POST /user/ethereum/addresses
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| address | body | Required: Ethereum address |
| description | body | Description |
Example Request
{
"address": "0xe40555b43d60656b9510860A11D6bDCDDb8E78A2",
"description": "My new wallet"
}
Example Response
{
"list": [
{
"address": "0xe40555b43d60656b9510860A11D6bDCDDb8E78A2",
"description": "My new wallet",
"ts": "2018-08-30T14:16:07Z"
}
]
}
Get user's addresses
GET /user/ethereum/addresses
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
{
"list": [
{
"address": "0xe40555b43d60656b9510860A11D6bDCDDb8E78A2",
"description": "My new wallet",
"ts": "2018-08-30T14:16:07Z"
}
]
}
Remove addresses
PUT /user/ethereum/addresses/remove
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| list | body | Required: Ethereum addresses |
Example Request
{
"list": ["0xe40555b43d60656b9510860A11D6bDCDDb8E78A2"]
}
Example Response
{
"list": []
}
Get user's balance
GET /payments-service/user/ethereum/balance
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
{
"account_coins": "1949979999999999999934",
"balance_coins": "10111020000000000000000",
"coins_fee": {
"max": "50000000000000000000",
"min": "1000000000000000000"
},
"total_coins": "12060999999999999999934"
}
Return parameters
| Name | Description |
|---|---|
| account_coins | Coins from user's profile |
| balance_coins | Coins from all user's addresses |
| total_coins | account_coins + account_coins |
| coins_fee | Min and Max values for transaction fee parameter |
Transfer coins method
POST /payments-service/user/ethereum/transfer
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| address | body | Required: Ethereum address |
| coins | body | Required: Coins value |
| fee | body | Required: Fee value |
Example Request
{"address":"0xe40555b43d60656b9510860A11D6bDCDDb8E78A2", "coins":"9000000000000000000", "fee": "1000000000000000000"}
Example Response
{
"address": "0xe40555b43d60656b9510860A11D6bDCDDb8E78A2",
"coins": "9000000000000000000",
"fee": "1000000000000000000",
"hash": null,
"id": "urn:authenticateit:transaction_request:9f5885f7-b013-440c-b86e-a247fc8d6ba2",
"status": "pending",
"ts": "2018-03-08T09:16:49Z"
}
Read transfers history
GET /payments-service/user/ethereum/transfer/history
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
{
"history": [
{
"account": {
"address": "0xC306c35423c6EB246C545B9F3F4B6a18cE29290d",
"description": "11111 ",
"id": "9f8e166a35a20dff1c2e92f506b1d76f95ab48cf",
"status": "success",
"ts": "2023-02-12T23:54:18Z"
},
"coins": "6476600000000000000",
"converted_aud_value": 0.04707192880000001,
"fee_summary": {
"coins": "6476680000000000000",
"coins_with_fee": "6476680000000000000",
"coins_without_fee": "6476680000000000000",
"fee_coins": 0,
"fee_value": 0.0,
"gas_coins": "18000000000000000000",
"gas_fee_coins": 0,
"gas_fee_precent": 0,
"gas_fee_value": 0.0,
"pay_fee_with_coins": false,
"transaction_fee": 0,
"transaction_fee_coins": 0,
"transaction_fee_value": 0.0,
"value": 0.04,
"value_with_fee": 0.04,
"value_without_fee": 0.04
},
"hash": "16705382",
"id": "urn:authenticateit:transaction_request:1fe053e1-8cf4-4371-a8bc-312c0d65a00b",
"status": "failure",
"ts": "2023-02-14T01:13:24Z",
"type": "poloniex"
},
{
"account": {
"account": "67774555",
"bank": "gjkkklllo",
"bsb": "355896",
"country": "036",
"description": "gjkkklllo",
"id": "ab97eff9-1ef5-4612-95ea-b557d9b106fe",
"name": "754fffhu",
"postcode": "6646"
},
"considered_id": "6f3e93b76b6d1e7cad1340e221edd76794e71a0bfd65c79ceb0b6c6d5ed6e889f1d78f391c32433cfeff106ff890ae03",
"currency": "aud",
"hash": "b1e52970ad70b75fb12a82c84bd5efed",
"id": "urn:authenticateit:transaction_request:8c8ae4f9-adbe-43c4-a4c7-2fe0622ffb10",
"owner": "urn:authenticateit:user:email:email@gmail.com",
"row_id": "6f3e93b76b6d1e7cad1340e221edd76794e71a0bfd65c79ceb0b6c6d5ed6e889f1d78f391c32433cfeff106ff890ae03@8c8ae4f9-adbe-43c4-a4c7-2fe0622ffb10",
"status": "pending",
"submission_id": "8c8ae4f9-adbe-43c4-a4c7-2fe0622ffb10",
"ts": "2021-11-30T15:16:00Z",
"type": "user_cashback",
"value": 0.99
},
{
"account": {
"account": "67774555",
"bank": "gjkkklllo",
"bsb": "355896",
"country": "036",
"description": "gjkkklllo",
"id": "ab97eff9-1ef5-4612-95ea-b557d9b106fe",
"name": "754fffhu",
"postcode": "6646"
},
"considered_id": "6f3e93b76b6d1e7cad1340e221edd76794e71a0bfd65c79ceb0b6c6d5ed6e889f1d78f391c32433cfeff106ff890ae03",
"currency": "aud",
"hash": "b1e52970ad70b75fb12a82c84bd5efed",
"id": "urn:authenticateit:transaction_request:8c8ae4f9-adbe-43c4-a4c7-2fe0622ffb10",
"owner": "urn:authenticateit:user:email:email@gmail.com",
"row_id": "6f3e93b76b6d1e7cad1340e221edd76794e71a0bfd65c79ceb0b6c6d5ed6e889f1d78f391c32433cfeff106ff890ae03@8c8ae4f9-adbe-43c4-a4c7-2fe0622ffb10",
"status": "success",
"submission_id": "8c8ae4f9-adbe-43c4-a4c7-2fe0622ffb10",
"ts": "2021-11-30T15:16:00Z",
"type": "user_cashback",
"value": 0.99
},
{
"account": {
"account": "67774555",
"bank": "SomeBank",
"bsb": "355896",
"country": "036",
"description": "My account",
"id": "ab97eff9-1ef5-4612-95ea-b557d9b106fe",
"name": "User's account",
"postcode": "6646"
},
"coins": "43611000000000000000000",
"converted_aud_value": 3.3080050413996833,
"converted_value": 3.3,
"currency": "aud",
"fee_summary": {
"coins": "30000000000000000000000",
"coins_with_fee": "43611000000000000000000",
"coins_without_fee": "16389000000000000000000",
"fee_coins": "13611000000000000000000",
"fee_value": 1.5,
"gas_coins": "160000000000000000000",
"gas_fee_coins": "8000000000000000000",
"gas_fee_precent": 5,
"gas_fee_value": 0.0,
"pay_fee_with_coins": true,
"transaction_fee": 1.5,
"transaction_fee_coins": "13603000000000000000000",
"transaction_fee_value": 1.5,
"value": 1.8,
"value_with_fee": 3.3,
"value_without_fee": 1.8
},
"hash": null,
"id": "urn:authenticateit:transaction_request:08650dfa-ac5c-44e9-960a-ad3ad2f717fc",
"status": "pending",
"ts": "2021-06-30T06:25:13Z",
"type": "cashout"
},
{
"account": {
"account": "67774555",
"bank": "SomeBank",
"bsb": "355896",
"country": "036",
"description": "My account",
"id": "ab97eff9-1ef5-4612-95ea-b557d9b106fe",
"name": "User's account",
"postcode": "6646"
},
"coins": "43611000000000000000000",
"converted_aud_value": 3.3080050413996833,
"converted_value": 3.3,
"currency": "aud",
"fee_summary": {
"coins": "30000000000000000000000",
"coins_with_fee": "43611000000000000000000",
"coins_without_fee": "16389000000000000000000",
"fee_coins": "13611000000000000000000",
"fee_value": 1.5,
"gas_coins": "160000000000000000000",
"gas_fee_coins": "8000000000000000000",
"gas_fee_precent": 5,
"gas_fee_value": 0.0,
"pay_fee_with_coins": true,
"transaction_fee": 1.5,
"transaction_fee_coins": "13603000000000000000000",
"transaction_fee_value": 1.5,
"value": 1.8,
"value_with_fee": 3.3,
"value_without_fee": 1.8
},
"hash": null,
"id": "urn:authenticateit:transaction_request:61538c96-7f7c-492d-90ed-a6cd8efca19d",
"status": "pending",
"ts": "2021-06-30T06:25:10Z",
"type": "cashout"
},
{
"account": {
"account": "22334455",
"bank": "Commonwealth",
"bsb": "123456",
"city": "Melbourne",
"country": "036",
"description": "My primary account",
"id": "f50b74b3-8605-4985-af89-20cd0adfe89d",
"name": "John Smith"
},
"coins": "200000000000000000000",
"converted_value": 0.14,
"converted_aud_value": 0.4,
"currency": "aud",
"hash": "8320be4b7890fdef8c4d0d0f840067eb",
"id": "urn:authenticateit:transaction_request:9ab1b8e4-307c-44cd-8f42-49220dfb396e",
"status": "success",
"ts": "2018-09-03T07:17:00Z",
"type": "cashout"
},
{
"address": "0xe40555b43d60656b9510860A11D6bDCDDb8E78A2",
"coins": "500000000000000000000",
"fee": "44000000000000000000",
"converted_aud_value": 0.0024809999999999997,
"hash": "0x73c5528ecc390743329b8c154da42c361f7096335fb62819913ae237650a5c4c",
"id": "urn:authenticateit:transaction_request:a0ba1883-cbec-4a2c-9659-9a8b0aa7cd3a",
"status": "success",
"ts": "2018-08-30T20:46:04Z"
},
{
"coins": "10000000000000000000",
"hash": "0xb567ada4a95ba99124d5babd45f7e9a74cd4c35e6852b77c81c99b8f841d7ef4",
"id": "297eb890-bfda-4500-97ba-7c04c795271a",
"status": "success",
"ts": "2018-08-30T20:30:28Z",
"type": "deposit"
},
{
"coins": "10000000000000000000",
"hash": "0x77800628f6368b8b2d1ee0959d15aadd947651536c8a1a80008a0bc5ce8dbc2a",
"id": "00ad7965-320a-4772-8f0a-4a8eae6025fb",
"status": "success",
"ts": "2018-08-30T20:29:27Z",
"type": "deposit"
}
]
}
Manual transfer approving
Information on pending transfer will be emailed to a moderator (moderators) who will either approve or reject transfer by clicking on approve/reject links. URLs to approve or reject pending transfer are /user/ethereum/transfer/:code/approve and /user/ethereum/transfer/:code/reject.
Approve transfer
GET /user/ethereum/transfer/:code/approve
Parameters
| Name | Type | Description |
|---|---|---|
| code | body | Required: Code UUID |
Reject transfer
GET /user/ethereum/transfer/:code/reject
Parameters
| Name | Type | Description |
|---|---|---|
| code | body | Required: Code UUID |
User's deposit address
Get deposit address
GET /user/ethereum/deposit
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
{
"address": "0xAc08558735d2a968f8D7B6a00b37328899dF1f28"
}
User's cashout methods
Get allowed countries and currencies
GET /cashout/countries
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
{
"allowed_countries": [
{
"country": "036",
"currency": "aud"
}
]
}
Convert coins to currency of selected country
GET /cashout/convert_coins
Request parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| coins | body | Required: Coins value |
| country | body | Allowed country |
| negative_values | body | Flag to show negative values (true/false). false is dafault. |
Response parameters
| Name | Description |
|---|---|
| coins | Requested coins |
| currency | Matched currency |
| fee_coins | Total fee coins (gas_fee_coins + transaction_fee_coins) |
| fee_value | Total fee value in currency (gas_fee_value + transaction_fee_value) |
| gas_coins | Current min gas price in coins |
| gas_fee_coins | Gas fee in coins |
| gas_fee_precent | Gas fee option. Percent of gas_coins |
| gas_fee_value | Gas fee value in currency |
| transaction_fee_coins | Transaction fee in coins |
| transaction_fee | Transaction fee option. |
| transaction_fee_value | Transaction fee value in currency |
| value | Value in currency without fee (for support old mobile releases). value = value_without_fee |
| value_with_fee | Value in currency with fee (value_without_fee + fee_value) |
| value_without_fee | Value in currency without fee |
Example Request
GET /cashout/convert_coins?coins=10000000000000000000000&country=036&negative_values=true
Example Response. No configured fee
{
"coins": "1000000000000000000000",
"currency": "USD",
"fee_coins": 0,
"fee_value": 0.0,
"gas_coins": "2661000000000000000000",
"gas_fee_coins": 0,
"gas_fee_precent": 0,
"gas_fee_value": 0.0,
"transaction_fee_coins": 0,
"transaction_fee": 0,
"transaction_fee_value": 0.0,
"value": 0.08,
"value_with_fee": 0.08,
"value_without_fee": 0.08
}
Example Response. Fee configured. negative_values=true
{
"coins": "1000000000000000000000",
"currency": "USD",
"fee_coins": "1830500000000000000000",
"fee_value": 0.15,
"gas_coins": "2661000000000000000000",
"gas_fee_coins": "1330500000000000000000",
"gas_fee_precent": 50,
"gas_fee_value": 0.11,
"transaction_fee_coins": "500000000000000000000",
"transaction_fee": 0.04,
"transaction_fee_value": 0.04,
"value": -0.06,
"value_with_fee": 0.08,
"value_without_fee": -0.06
}
Example Response. Fee configured. negative_values=false
{
"coins": "2000000000000000000000000",
"coins_with_fee": "2013611000000000000000000",
"coins_without_fee": "1986389000000000000000000",
"currency": "AUD",
"fee_coins": "13611000000000000000000",
"fee_value": 1.5,
"gas_coins": "160000000000000000000",
"gas_fee_coins": "8000000000000000000",
"gas_fee_precent": 5,
"gas_fee_value": 0.0,
"transaction_fee": 1.5,
"transaction_fee_coins": "13603000000000000000000",
"transaction_fee_value": 1.5,
"value": 219.03,
"value_with_fee": 220.53,
"value_without_fee": 219.03
}
Create new cashout account
POST /cashout/account
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| account | body | Required: Account object |
Example Request
{
"account": {
"country": "036",
"city": "Melbourne",
"bank": "Test BN",
"name": "John Smith",
"bsb": "123456",
"account": "22334455",
"description": "My second account"
}
}
Example Response
{
"account": "22334455",
"bank": "Test BN",
"bsb": "123456",
"city": "Melbourne",
"country": "036",
"description": "My second account",
"id": "03192aaa-a314-4eed-9d1c-a42bf36cdb70",
"name": "John Smith"
}
Get cashout accounts
GET /cashout/account
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
{
"accounts": [
{
"account": "22334455",
"bank": "SB",
"bsb": "123456",
"city": "Melbourne",
"country": "036",
"description": "My second account",
"id": "1d1af3aa-5d62-49d5-a0d7-9e1a3f34c365",
"name": "John Smith"
},
{
"account": "22334455",
"bank": "Commonwealth",
"bsb": "123456",
"city": "Melbourne",
"country": "036",
"description": "My primary account",
"id": "f50b74b3-8605-4985-af89-20cd0adfe89d",
"name": "John Smith"
}
]
}
Update account
PUT /cashout/account
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| account | body | Required: Account object |
| id | body | Required: Account id |
Example Request
{
"account": {
"country": "036",
"city": "Melbourne",
"bank": "SB",
"name": "John Smith",
"bsb": "123456",
"account": "22334455",
"description": "New descritpion test"
},
"id": "1d1af3aa-5d62-49d5-a0d7-9e1a3f34c365"
}
Example Response
{
"accounts": [
{
"account": "22334455",
"bank": "SB",
"bsb": "123456",
"city": "Melbourne",
"country": "036",
"description": "New descritpion test",
"id": "1d1af3aa-5d62-49d5-a0d7-9e1a3f34c365",
"name": "John Smith"
},
{
"account": "22334455",
"bank": "Commonwealth",
"bsb": "123456",
"city": "Melbourne",
"country": "036",
"description": "My primary account",
"id": "f50b74b3-8605-4985-af89-20cd0adfe89d",
"name": "John Smith"
}
]
}
Remove account
POST /cashout/account/remove
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| accounts | body | Required: List of ids |
Example Request
{
"accounts": ["1d1af3aa-5d62-49d5-a0d7-9e1a3f34c365"]
}
Example Response
{
"accounts": [
{
"account": "22334455",
"bank": "Commonwealth",
"bsb": "123456",
"city": "Melbourne",
"country": "036",
"description": "My primary account",
"id": "f50b74b3-8605-4985-af89-20cd0adfe89d",
"name": "John Smith"
}
]
}
Cashout transaction request
POST /cashout/transfer
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| account | body | Required: Account data. |
| coins | body | Required: Coins |
| version | body | Version key. Only v2 version is applicable |
| pay_fee_with_coins | boolean | Flag that indicates how amount will be calculated |
Example Request. No version key/bad version key
{
"account": {
"account": "67774555",
"bank": "SomeBank",
"bsb": "355896",
"country": "036",
"description": "My account",
"id": "ab97eff9-1ef5-4612-95ea-b557d9b106fe",
"name": "User's account",
"postcode": "6646"
},
"coins": "2000000000000000000000"
}
Example Response
{
"error": "Unsupported version. Your Mobile App needs to be updated.",
"error_data": null,
"error_id": "payments-bad_version",
"error_object": null
}
Example Request
{
"account": {
"account": "67774555",
"bank": "SomeBank",
"bsb": "355896",
"country": "036",
"description": "My account",
"id": "ab97eff9-1ef5-4612-95ea-b557d9b106fe",
"name": "User's account",
"postcode": "6646"
},
"coins": "30000000000000000000000",
"pay_fee_with_coins":true,
"version": "v2"
}
Example Response
{
"account": {
"account": "67774555",
"bank": "SomeBank",
"bsb": "355896",
"country": "036",
"description": "My account",
"id": "ab97eff9-1ef5-4612-95ea-b557d9b106fe",
"name": "User's account",
"postcode": "6646"
},
"coins": "43609000000000000000000",
"converted_usd_value": 2.5,
"converted_value": 3.3,
"currency": "aud",
"fee": {
"coins": "30000000000000000000000",
"coins_with_fee": "43609000000000000000000",
"coins_without_fee": "16391000000000000000000",
"fee_coins": "13609000000000000000000",
"fee_value": 1.5,
"gas_coins": "160000000000000000000",
"gas_fee_coins": "8000000000000000000",
"gas_fee_precent": 5,
"gas_fee_value": 0.0,
"pay_fee_with_coins": true,
"transaction_fee": 1.5,
"transaction_fee_coins": "13601000000000000000000",
"transaction_fee_value": 1.5,
"value": 1.8,
"value_with_fee": 3.3,
"value_without_fee": 1.8
},
"hash": null,
"id": "urn:authenticateit:transaction_request:5b22e550-2f75-4d79-a059-778f653c823f",
"status": "pending",
"stored_account": "ab97eff9-1ef5-4612-95ea-b557d9b106fe",
"ts": "2021-06-30T06:31:53Z"
}
Converting of coins by current price
GET /rewards/convert/coins
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| coins | body | Required: Coins |
| country | body | Country code |
| currency | body | Currency |
Example Request
{
"coins" : "100000000000000000"
}
Example Response
{
"currency": "aud",
"value": 0.000024
}
Check promo code
GET /participants/promo_code/check
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Session's ticket |
| code | body | Required: Promo code |
Example Response
{
"code": "promo60",
"days_value": 60
}
Coins TopUp
Conditions for TopUp coins:
1) Participant has a supported currency (currently aud, sgd and usd)
2) Participant had coupled credit card to the account
Get minimal amount value
The method also can be used for checking the availability of TopUp for participant
GET /participants/topup/min_amount
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
{
"amount": 510,
"coins": "100000000000000000000",
"currency": "aud"
}
amount - amount in returned currency in cents (510 = $5.10)coins - how many coins can be bought for this minimum amountcurrency - currency for participant
Set/Update TopUp
POST /participants/topup/
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| amount | body | TopUp amount in cents (510 = $5.10). Non negative integer |
| minimal_amount | body | Boolean. If true TopUp with min_amount value will be requested. Default: false |
| coins_threshold | body | Required: Coins threshold on deposit. If coins <= coins_threshold TopUp will be requested |
| frequency | body | Frequency for requesting TopUp |
| status | body | TopUp status. active or inactive |
amount must be equal or more than min_amount or minimal_amount must be set. If minimal_amount has been set (true), then amount value will be ignored.
Default frequency is daily. daily - one per 1 day. weekly - one per 7 days, monthly - one per 30 days
Example Request
{
"minimal_amount":true,
"coins_threshold": "10000000000000000000000",
"frequency": "daily",
"status": "active"
}
Example Responce
{
"amount": 0,
"coins_threshold": "10000000000000000000000",
"currency": "aud",
"frequency": "daily",
"minimal_amount": true,
"status": "active"
}
Get TopUp settings
GET /participants/topup/
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
{
"amount": 109,
"coins_threshold": "10000000000000000000000",
"currency": "aud",
"frequency": "daily",
"minimal_amount": false,
"status": "active"
}
Delete TopUp settings
DELETE /participants/topup/
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Get TopUp history
GET /participants/topup/history?format=v2
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| format | body | v2is the last format of history |
Each topup history subelement has a status (success, failure or pending) field and sub_type field. Possible value of sub_type is charge, topup or refund.
TopUp chains -
1) Charge (failure) -> Refund (success or failure)
2) Charge (success) -> TopUp (failure) -> Refund (success or failure)
3) Charge (success) -> TopUp (success)
Charge and Refund are synchronous operations and can be marked only success or failure statuses.
TopUp is asynchronous blockchain operation. Possible statuses success, failure or pending
Example Response
[
{
"amount": 2022,
"history": [
{
"amount": 2022,
"charge_id": null,
"currency": "aud",
"hash": null,
"id": "urn:authenticateit:transaction_request:ea3a2403-2157-4043-adf7-51d92f71907f",
"status": "pending",
"sub_type": "topup",
"ts": "2019-05-03T19:51:55Z",
"type": "topup"
}
],
"id": "urn:authenticateit:transaction_request:ea3a2403-2157-4043-adf7-51d92f71907f",
"status": "pending",
"ts": "2019-05-03T19:51:55Z"
},
{
"amount": 22,
"history": [
{
"amount": 2200,
"charge_id": "ch_1EVtkcEFVOePY2EFQBBtOqDj",
"coins": "56420000000000000000000",
"currency": "aud",
"hash": "ceac3ab7c0c9256cce9b7cb39e0048ff",
"id": "urn:authenticateit:transaction_request:0c97d9c6-402f-4fd3-8fdb-a34af3148edd",
"status": "success",
"sub_type": "topup",
"topup_history": [
{
"result": "56420000000000000000000",
"status": "done",
"ts": "2019-05-03T05:16:14.331Z"
},
{
"order": {
"price": "0.0000017",
"side": "bid",
"size": "56420",
"source": "fake_order",
"trading_pair_id": "SHPING-ETH",
"type": "market"
},
"status": "cobinhood_done",
"total": "56420",
"ts": "2019-05-03T05:16:04.291Z"
},
{
"status": "btcmarkets_done",
"total": "0.09591436093920491",
"ts": "2019-05-03T05:16:04.103Z"
},
{
"status": "init",
"ts": "2019-05-03T05:16:03.453Z"
}
],
"ts": "2019-05-03T05:16:20Z",
"type": "topup"
},
{
"amount": 2200,
"charge_id": "ch_1EVtkcEFVOePY2EFQBBtOqDj",
"currency": "aud",
"hash": null,
"id": "urn:authenticateit:transaction_request:0c97d9c6-402f-4fd3-8fdb-a34af3148edd",
"status": "success",
"sub_type": "charge",
"ts": "2019-05-03T05:16:00Z",
"type": "topup"
}
],
"id": "urn:authenticateit:transaction_request:0c97d9c6-402f-4fd3-8fdb-a34af3148edd",
"status": "success",
"ts": "2019-05-03T05:16:00Z"
},
{
"amount": 1500,
"history": [
{
"amount": 150000,
"charge_id": "ch_1EUWiMEFVOePY2EFQAanmBb7",
"currency": "aud",
"hash": "d748ecf0c4c9704fa55def804900081e",
"id": "urn:authenticateit:transaction_request:4209ca46-e83c-46a0-ae76-e636942b3bfb",
"status": "success",
"sub_type": "refund",
"ts": "2019-04-29T10:28:00Z",
"type": "topup"
},
{
"amount": 150000,
"charge_id": "ch_1EUWiMEFVOePY2EFQAanmBb7",
"currency": "aud",
"hash": "d748ecf0c4c9704fa55def804900081e",
"id": "urn:authenticateit:transaction_request:4209ca46-e83c-46a0-ae76-e636942b3bfb",
"status": "failure",
"sub_type": "topup",
"ts": "2019-04-29T10:28:00Z",
"type": "topup"
},
{
"amount": 150000,
"charge_id": "ch_1EUWiMEFVOePY2EFQAanmBb7",
"currency": "aud",
"hash": null,
"id": "urn:authenticateit:transaction_request:4209ca46-e83c-46a0-ae76-e636942b3bfb",
"status": "success",
"sub_type": "charge",
"ts": "2019-04-29T10:28:00Z",
"type": "topup"
}
],
"id": "urn:authenticateit:transaction_request:4209ca46-e83c-46a0-ae76-e636942b3bfb",
"status": "failure",
"ts": "2019-04-29T10:28:00Z"
},
{
"amount": 20,
"history": [
{
"amount": 2000,
"charge_id": null,
"currency": "aud",
"hash": null,
"id": "urn:authenticateit:transaction_request:0183600d-a96e-4549-a2ed-21605002b7cd",
"reason": "Can't charge customer. 2019-02-20T08:21:01Z",
"status": "failure",
"sub_type": "charge",
"ts": "2019-02-20T08:21:01Z",
"type": "topup"
}
],
"id": "urn:authenticateit:transaction_request:0183600d-a96e-4549-a2ed-21605002b7cd",
"status": "failure",
"ts": "2019-02-20T08:21:01Z"
},
{
"amount": 20,
"history": [
{
"amount": 2000,
"charge_id": null,
"currency": "aud",
"hash": null,
"id": "urn:authenticateit:transaction_request:a6281812-9a69-46b3-861d-12e0ce712fb5",
"reason": "Can't charge customer. 2019-02-19T08:19:00Z",
"status": "failure",
"sub_type": "charge",
"ts": "2019-02-19T08:19:00Z",
"type": "topup"
}
],
"id": "urn:authenticateit:transaction_request:a6281812-9a69-46b3-861d-12e0ce712fb5",
"status": "failure",
"ts": "2019-02-19T08:19:00Z"
},
{
"amount": 5.1,
"history": [
{
"amount": 510,
"charge_id": null,
"currency": "aud",
"hash": null,
"id": "urn:authenticateit:transaction_request:26819ece-5d6f-4f4e-9a64-9f3176956830",
"reason": "Can't charge customer. 2019-02-18T08:18:00Z",
"status": "failure",
"sub_type": "charge",
"ts": "2019-02-18T08:18:00Z",
"type": "topup"
}
],
"id": "urn:authenticateit:transaction_request:26819ece-5d6f-4f4e-9a64-9f3176956830",
"status": "failure",
"ts": "2019-02-18T08:18:00Z"
},
{
"amount": 5.1,
"history": [
{
"amount": 510,
"charge_id": "ch_1E57IDEFVOePY2EFzWCnzEgW",
"coins": "10631000000000000000000",
"currency": "aud",
"hash": "082c32930eb493f481fe686d8b03f683",
"id": "urn:authenticateit:transaction_request:eaf3a0f7-a970-49b0-88c4-1a1b0198b93c",
"status": "success",
"sub_type": "topup",
"ts": "2019-02-18T08:16:00Z",
"type": "topup"
},
{
"amount": 510,
"charge_id": "ch_1E57IDEFVOePY2EFzWCnzEgW",
"currency": "aud",
"hash": null,
"id": "urn:authenticateit:transaction_request:eaf3a0f7-a970-49b0-88c4-1a1b0198b93c",
"status": "success",
"sub_type": "charge",
"ts": "2019-02-18T08:16:00Z",
"type": "topup"
}
],
"id": "urn:authenticateit:transaction_request:eaf3a0f7-a970-49b0-88c4-1a1b0198b93c",
"status": "success",
"ts": "2019-02-18T08:16:00Z"
},
{
"amount": 13,
"history": [
{
"amount": 1300,
"charge_id": "ch_1E5217EFVOePY2EFqlmatmqm",
"coins": "27505000000000000000000",
"currency": "aud",
"hash": "082c32930eb493f481fe686d8b03e91e",
"id": "urn:authenticateit:transaction_request:fc8e8c52-14d3-4d8f-bd6d-35e9d845304e",
"status": "success",
"sub_type": "topup",
"ts": "2019-02-18T02:38:00Z",
"type": "topup"
},
{
"amount": 1300,
"charge_id": "ch_1E5217EFVOePY2EFqlmatmqm",
"currency": "aud",
"hash": null,
"id": "urn:authenticateit:transaction_request:fc8e8c52-14d3-4d8f-bd6d-35e9d845304e",
"status": "success",
"sub_type": "charge",
"ts": "2019-02-18T02:38:00Z",
"type": "topup"
}
],
"id": "urn:authenticateit:transaction_request:fc8e8c52-14d3-4d8f-bd6d-35e9d845304e",
"status": "success",
"ts": "2019-02-18T02:38:00Z"
},
{
"amount": 10,
"history": [
{
"amount": 1000,
"charge_id": null,
"currency": "aud",
"hash": null,
"id": "urn:authenticateit:transaction_request:b13d0cb8-7160-43e3-8ea9-9ca3ac96687f",
"reason": "Can't charge customer. 2019-02-18T02:36:00Z",
"status": "failure",
"sub_type": "charge",
"ts": "2019-02-18T02:36:00Z",
"type": "topup"
}
],
"id": "urn:authenticateit:transaction_request:b13d0cb8-7160-43e3-8ea9-9ca3ac96687f",
"status": "failure",
"ts": "2019-02-18T02:36:00Z"
},
{
"amount": 6,
"history": [
{
"amount": 600,
"charge_id": "ch_1E51wGEFVOePY2EF4iq8Mo4i",
"coins": "12700000000000000000000",
"currency": "aud",
"hash": "082c32930eb493f481fe686d8b03e8f5",
"id": "urn:authenticateit:transaction_request:9fe8a80e-0454-438c-ad58-172411ec23a7",
"status": "success",
"sub_type": "topup",
"ts": "2019-02-18T02:33:00Z",
"type": "topup"
},
{
"amount": 600,
"charge_id": "ch_1E51wGEFVOePY2EF4iq8Mo4i",
"currency": "aud",
"hash": null,
"id": "urn:authenticateit:transaction_request:9fe8a80e-0454-438c-ad58-172411ec23a7",
"status": "success",
"sub_type": "charge",
"ts": "2019-02-18T02:33:00Z",
"type": "topup"
}
],
"id": "urn:authenticateit:transaction_request:9fe8a80e-0454-438c-ad58-172411ec23a7",
"status": "success",
"ts": "2019-02-18T02:33:00Z"
},
{
"amount": 5.1,
"history": [
{
"amount": 510,
"charge_id": "ch_1E4nuHEFVOePY2EFqX3sJopS",
"coins": "12477000000000000000000",
"currency": "aud",
"hash": "082c32930eb493f481fe686d8b03dce2",
"id": "urn:authenticateit:transaction_request:9b13cdb3-4a35-426d-8c59-2e8fe41883cf",
"status": "success",
"sub_type": "topup",
"ts": "2019-02-17T11:34:00Z",
"type": "topup"
},
{
"amount": 510,
"charge_id": "ch_1E4nuHEFVOePY2EFqX3sJopS",
"currency": "aud",
"hash": null,
"id": "urn:authenticateit:transaction_request:9b13cdb3-4a35-426d-8c59-2e8fe41883cf",
"status": "success",
"sub_type": "charge",
"ts": "2019-02-17T11:34:00Z",
"type": "topup"
}
],
"id": "urn:authenticateit:transaction_request:9b13cdb3-4a35-426d-8c59-2e8fe41883cf",
"status": "success",
"ts": "2019-02-17T11:34:00Z"
},
{
"amount": 5.1,
"history": [
{
"amount": 510,
"charge_id": "ch_1E4noTEFVOePY2EFRC9k6SlN",
"coins": "12484000000000000000000",
"currency": "aud",
"hash": "082c32930eb493f481fe686d8b03dbc9",
"id": "urn:authenticateit:transaction_request:d617971a-dafe-48ef-aeec-f3027c56cf3c",
"status": "success",
"sub_type": "topup",
"ts": "2019-02-17T11:28:00Z",
"type": "topup"
},
{
"amount": 510,
"charge_id": "ch_1E4noTEFVOePY2EFRC9k6SlN",
"currency": "aud",
"hash": null,
"id": "urn:authenticateit:transaction_request:d617971a-dafe-48ef-aeec-f3027c56cf3c",
"status": "success",
"sub_type": "charge",
"ts": "2019-02-17T11:28:00Z",
"type": "topup"
}
],
"id": "urn:authenticateit:transaction_request:d617971a-dafe-48ef-aeec-f3027c56cf3c",
"status": "success",
"ts": "2019-02-17T11:28:00Z"
},
{
"amount": 5.1,
"history": [
{
"amount": 510,
"charge_id": "ch_1E4nV7EFVOePY2EFezKLiZXj",
"coins": "12499000000000000000000",
"currency": "aud",
"hash": "082c32930eb493f481fe686d8b03d0fd",
"id": "urn:authenticateit:transaction_request:7b61db41-dd9e-4f1a-ad92-a49c5e924b03",
"status": "success",
"sub_type": "topup",
"ts": "2019-02-17T11:08:00Z",
"type": "topup"
},
{
"amount": 510,
"charge_id": "ch_1E4nV7EFVOePY2EFezKLiZXj",
"currency": "aud",
"hash": null,
"id": "urn:authenticateit:transaction_request:7b61db41-dd9e-4f1a-ad92-a49c5e924b03",
"status": "success",
"sub_type": "charge",
"ts": "2019-02-17T11:08:00Z",
"type": "topup"
}
],
"id": "urn:authenticateit:transaction_request:7b61db41-dd9e-4f1a-ad92-a49c5e924b03",
"status": "success",
"ts": "2019-02-17T11:08:00Z"
},
{
"amount": 5.1,
"history": [
{
"amount": 510,
"charge_id": "ch_1E4mVBEFVOePY2EFbezg6KIf",
"coins": "12698000000000000000000",
"currency": "aud",
"hash": "082c32930eb493f481fe686d8b03c64f",
"id": "urn:authenticateit:transaction_request:0003b162-c8d7-4f8f-bee5-75fb21f571a7",
"status": "success",
"sub_type": "topup",
"ts": "2019-02-17T10:04:00Z",
"type": "topup"
},
{
"amount": 510,
"charge_id": "ch_1E4mVBEFVOePY2EFbezg6KIf",
"currency": "aud",
"hash": null,
"id": "urn:authenticateit:transaction_request:0003b162-c8d7-4f8f-bee5-75fb21f571a7",
"status": "success",
"sub_type": "charge",
"ts": "2019-02-17T10:04:00Z",
"type": "topup"
}
],
"id": "urn:authenticateit:transaction_request:0003b162-c8d7-4f8f-bee5-75fb21f571a7",
"status": "success",
"ts": "2019-02-17T10:04:00Z"
},
{
"amount": 5.1,
"history": [
{
"amount": 510,
"charge_id": "ch_1E4fcPEFVOePY2EFLpjkalnW",
"coins": "12314000000000000000000",
"currency": "aud",
"hash": "082c32930eb493f481fe686d8b03be79",
"id": "urn:authenticateit:transaction_request:88eb2ea7-f804-4f7e-b34d-8c2664d46e33",
"status": "success",
"sub_type": "topup",
"ts": "2019-02-17T02:43:00Z",
"type": "topup"
},
{
"amount": 510,
"charge_id": "ch_1E4fcPEFVOePY2EFLpjkalnW",
"currency": "aud",
"hash": null,
"id": "urn:authenticateit:transaction_request:88eb2ea7-f804-4f7e-b34d-8c2664d46e33",
"status": "success",
"sub_type": "charge",
"ts": "2019-02-17T02:43:00Z",
"type": "topup"
}
],
"id": "urn:authenticateit:transaction_request:88eb2ea7-f804-4f7e-b34d-8c2664d46e33",
"status": "success",
"ts": "2019-02-17T02:43:00Z"
}
]
Create manual TopUp request
POST /participants/topup/manual
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| amount | body | Required: TopUp amount (510 = $5.10). Non negative integer |
Example Request
{
"amount":2000
}
Rate cards
Read rate card
system participant can set id and read card by any account. If id=default method will return the default rate card.
Non system participant can read only self rate card (default card if system participant hadn't preconfigured card for account)
GET /payments-service/participants/rate_card
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| id | string | Required for system. default or participant id |
Example Response
{
"adjustment": {
"approved_reviews": "19256000000000000000000",
"clicks": "14442000000000000000000",
"completed_video": "16849000000000000000000",
"impressions_revenue": "144000000000000000000",
"transactional_data": "28884000000000000000000"
},
"id": "urn:authenticateit:rate_card",
"rate_card": {
"billable": true,
"budget": {
"day": 20,
"month": 40,
"week": 30
},
"gst": 10,
"items": [
{
"events": [
"follow_fb",
"visit_link",
"visit_social_networks_link"
],
"id": "clicks",
"name": "Clicks",
"value": 0.3
},
{
"events": [
"watch_video"
],
"id": "completed_video",
"name": "Completed Video",
"value": 0.35
},
{
"events": [
"send_review"
],
"id": "approved_reviews",
"name": "Approved Reviews",
"value": 0.4
},
{
"events": [
"scan",
"send_scan_location",
"view_certificates",
"view_image",
"view_nutrition_info",
"view_popup",
"view_status",
"view_text"
],
"id": "impressions_revenue",
"name": "Impressions Revenue",
"value": 0.003
},
{
"events": [],
"id": "transactional_data",
"name": "Transactional Data",
"value": 0.6
}
],
"user_rewards": {
"percents": 0.25
}
},
"type": "rate_card"
}
Set rate card
Method alowed only for system participant
POST /payments-service/participants/rate_card:id
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| id | string | Required: default or participant id |
| billable | boolean | Required: Billable flag |
| user_rewards | object | Required: User rewards options |
| gst | non_neg_integer | GST |
| items | array | required rate_card items |
| budget | object | Budget limits |
id = default - default card will be changedid = <participant_id> - Participant card will be changed
items list should contains items.id and items.value keys.items.id should be filled acording Settings.items.value should be non_negative number.
user_rewards is an object. This element should contains user_rewards.percents, user_rewards.coins or user_rewards.value
user_rewards.percents - should be non_negative number.user_rewards.value - should be non_negative number.user_rewards.coins - should be in coins format
Example Request
{
"billable": true,
"budget": {
"day": 20,
"week": 30,
"month": 40
},
"gst": 10,
"items": [
{
"id": "clicks",
"value": 0.1
},
{
"id": "completed_video",
"value": 0.1
},
{
"id": "approved_reviews",
"value": 0.1
},
{
"id": "impressions_revenue",
"value": 0.2
},
{
"id": "transactional_data",
"value": 0.3
}
],
"user_rewards": {
"percents": 0.25
}
}
Example Response
{
"adjustment": {
"approved_reviews": "4811000000000000000000",
"clicks": "4811000000000000000000",
"completed_video": "4811000000000000000000",
"impressions_revenue": "9622000000000000000000",
"transactional_data": "14433000000000000000000"
},
"id": "urn:authenticateit:participant:735879621218609@rate_card",
"rate_card": {
"billable": true,
"budget": {
"day": 20,
"month": 40,
"week": 30
},
"gst": 10,
"items": [
{
"events": [
"follow_fb",
"visit_link",
"visit_social_networks_link"
],
"id": "clicks",
"name": "Clicks",
"value": 0.1
},
{
"events": [
"watch_video"
],
"id": "completed_video",
"name": "Completed Video",
"value": 0.1
},
{
"events": [
"send_review"
],
"id": "approved_reviews",
"name": "Approved Reviews",
"value": 0.1
},
{
"events": [
"scan",
"send_scan_location",
"view_certificates",
"view_image",
"view_nutrition_info",
"view_popup",
"view_status",
"view_text"
],
"id": "impressions_revenue",
"name": "Impressions Revenue",
"value": 0.2
},
{
"events": [],
"id": "transactional_data",
"name": "Transactional Data",
"value": 0.3
}
],
"user_rewards": {
"percents": 0.25
}
},
"type": "rate_card"
}
Delete custom rate card
Method allowed only for system participant. system participants can set id and delete participant's card
DELETE /payments-service/participants/rate_card/:id
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| id | string | Required: participant id |
Coinbase transfers
Coinbase errors:
{
"error": "Can't get tokens by refresh token.",
"error_data": [],
"error_id": "payments-coinbase_no_tokens_by_refresh_token",
"error_object": null
}
{
"error": "Coinbase tokens has not been found.",
"error_data": [],
"error_id": "payments-coinbase_no_stored_tokens",
"error_object": null
}
{
"error": "Can't read user profile by access token.",
"error_data": [],
"error_id": "payments-coinbase_no_user_by_access_token",
"error_object": null
}
{
"error": "Can't get tokens by code.",
"error_data": [],
"error_id": "payments-coinbase_no_tokens_by_code",
"error_object": null
}
Read connected Coinbase accounts
GET /payments-service/coinbase/account
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Session's ticket |
Example Response
{
"accounts": [
{
"avatar_url": "https://images.coinbase.com/avatar?h=61f710805a65551207c9d7byjafcxQzYPjMprN0R71t%2BVpkJP2t60hwR92vM%0Ah7X%2F&s=128",
"email": "email@gmail.com",
"id": "80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"name": "user surname",
"profile_bio": null,
"profile_location": null,
"profile_url": null,
"resource": "user",
"resource_path": "/v2/users/80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"ts": "2022-04-29T02:11:35Z",
"username": null
}
]
}
Read withdrawal accounts
GET /payments-service/withdrawal/account
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Session's ticket |
Example Response
{
"accounts": [
{
"avatar_url": "https://images.coinbase.com/avatar?h=61f710805a65551207c9d7byjafcxQzYPjMprN0R71t%2BVpkJP2t60hwR92vM%0Ah7X%2F&s=128",
"email": "foo@gmail.com",
"id": "80bc50eb-1111-2222-91f1-33dd27d6e519",
"name": "user surname",
"profile_bio": null,
"profile_location": null,
"profile_url": null,
"resource": "user",
"currency": "AUD",
"resource_path": "/v2/users/80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"ts": "2022-04-29T07:10:31Z",
"type": "coinbase_account",
"username": null
},
{
"account": "999999999",
"bank": "Fffff",
"bsb": "222222",
"country": "036",
"currency": "AUD",
"id": "3ae78d2c-8395-4440-9bf0-5205befb4c13",
"name": "Hhh",
"postcode": "4444",
"type": "cashout_account"
},
{
"address": "0x189050cCB230595ce8376A9606319cD906B29A0f",
"description": "tttt11",
"currency": "AUD",
"id": "0x189050cCB230595ce8376A9606319cD906B29A0f",
"ts": "2019-03-05T04:07:36Z",
"type": "ethereum_account"
},
{
"address": "0x3cA5F489cC1fd1CeC24747B64E8de0f4A6A850e3",
"currency": "AUD",
"description": "Test desc",
"id": "1a8d8468d1ae2ec10c5233481d2b66ca233eb938",
"status": "pending",
"ts": "2022-12-30T06:12:30Z",
"type": "poloniex_account"
}
],
"allowed_transfer_types": [
"coinbase",
"cashout",
"poloniex"
]
}
Read withdrawal history
POST /payments-service/withdrawal/history/get
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| chunk_id | string | Chunk id |
next = null in response means that is the last chunk
Example Request
{
"chunk_id" : "urn:authenticateit:transactions_history_chunk:2222222-4785-4bf9-b55d-30d4f1d86c7b"
}
Example Response
{
"history": [
{
"coins": "158000000000000000000",
"currency": "aud",
"hash": null,
"id": "urn:authenticateit:transaction_request:01edf3af-2a91-4f57-95cf-48753ad15cdc",
"status": "success",
"ts": "2023-05-02T03:10:00Z",
"type": "retail_connect"
},
{
"account": {
"address": "0xC306c35423c6EB246C545B9F3F4B6a18cE29290d",
"description": "11111 ",
"id": "9f8e166a35a20dff1c2e92f506b1d76f95ab48cf",
"status": "success",
"ts": "2023-02-12T23:54:18Z"
},
"coins": "6476600000000000000",
"converted_aud_value": 0.04707192880000001,
"fee_summary": {
"coins": "6476680000000000000",
"coins_with_fee": "6476680000000000000",
"coins_without_fee": "6476680000000000000",
"fee_coins": 0,
"fee_value": 0.0,
"gas_coins": "18000000000000000000",
"gas_fee_coins": 0,
"gas_fee_precent": 0,
"gas_fee_value": 0.0,
"pay_fee_with_coins": false,
"transaction_fee": 0,
"transaction_fee_coins": 0,
"transaction_fee_value": 0.0,
"value": 0.04,
"value_with_fee": 0.04,
"value_without_fee": 0.04
},
"hash": "16705382",
"id": "urn:authenticateit:transaction_request:1fe053e1-8cf4-4371-a8bc-312c0d65a00b",
"status": "failure",
"ts": "2023-02-14T01:13:24Z",
"type": "poloniex"
},
{
"account": {
"avatar_url": "https://images.coinbase.com/avatar?h=61f710805a65551207c9d7byjafcxQzYPjMprN0R71t%2BVpkJP2t60hwR92vM%0Ah7X%2F&s=128",
"email": "email@gmail.com",
"id": "80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"name": "user surname",
"profile_bio": null,
"profile_location": null,
"profile_url": null,
"resource": "user",
"resource_path": "/v2/users/80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"username": null
},
"coins": "11000000000000000000",
"converted_aud_value": 0.003064066852367688,
"fee_summary": {
"coins": "11000000000000000000",
"coins_with_fee": "11000000000000000000",
"coins_without_fee": "11000000000000000000",
"fee_coins": 0,
"fee_value": 0.0,
"gas_coins": "68000000000000000000",
"gas_fee_coins": 0,
"gas_fee_precent": 0,
"gas_fee_value": 0.0,
"pay_fee_with_coins": false,
"transaction_fee": 0,
"transaction_fee_coins": 0,
"transaction_fee_value": 0.0,
"value": 0.0,
"value_with_fee": 0.0,
"value_without_fee": 0.0
},
"hash": null,
"id": "urn:authenticateit:transaction_request:65defded-285b-489c-a56a-38aebd5c4639",
"status": "failure",
"ts": "2022-05-05T05:46:00Z",
"type": "coinbase"
}
],
"next": "urn:authenticateit:transactions_history_chunk:b5bdd04d-4785-4bf9-b55d-30d4f1d86c7b"
}
Read withdrawal limits
GET /payments-service/withdrawal/limits
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
current_rest_type may be one of values:rest_based_earnings or rest_based_limits
Example Response
{
"currency": "AUD",
"currency_low": "aud",
"currency_symbol": "$",
"current_limit": {
"coins_limit_based_on_earnings": "1660000000000000000000",
"coins_transfered": "1661882809999999995904",
"coins_transfered_wo_boosters": "1620000000000000000000",
"current_booster": 0.5,
"current_coins_price": 1.1855364552459988e-20,
"current_level": "basic",
"current_level_max_value": 20,
"current_level_max_value_earnings": 20,
"current_rest": 0.4742145820983995,
"current_rest_coins": "40000000000000000000",
"current_rest_type": "rest_based_earnings",
"current_value": 19.889999999999997,
"ts_from": "2022-09-01T00:00:00Z",
"ts_to": "2022-10-01T00:00:00Z"
},
"levels_limits": [
{
"level": "basic",
"level_max_booster": 50,
"level_max_value": 20,
"level_max_value_with_booster": 70
},
{
"level": "bronze",
"level_max_booster": 70,
"level_max_value": 30,
"level_max_value_with_booster": 100
},
{
"level": "silver",
"level_max_booster": 100,
"level_max_value": 40,
"level_max_value_with_booster": 140
},
{
"level": "gold",
"level_max_booster": 150,
"level_max_value": 45,
"level_max_value_with_booster": 195
},
{
"level": "platinum",
"level_max_booster": 300,
"level_max_value": 50,
"level_max_value_with_booster": 350
},
{
"level": "ambassador",
"level_max_booster": 425,
"level_max_value": 75,
"level_max_value_with_booster": 500
}
],
"start_ts": "2022-06-01T14:00:00Z"
}
Read earnings statement
GET /payments-service/withdrawal/earnings/statement
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
{
"result": [
{
"balance": 0,
"balance_ts": "0000-01-01T00:00:00Z",
"balance_type": "transfers",
"earn_coins": "830000000000000000000",
"month": 8,
"period": "2022-08",
"transfer_coins": 0,
"year": 2022
},
{
"balance": "2592141309999999889411",
"balance_ts": "2022-09-21T02:08:43Z",
"balance_type": "transfers",
"earn_coins": "4444000000000000000000",
"month": 9,
"period": "2022-09",
"transfer_coins": "4849623999999999995904",
"year": 2022
},
{
"balance": "-119088159031979250176",
"balance_ts": "2022-12-29T01:09:57Z",
"balance_type": "earnings",
"earn_coins": "-119088159031979250176",
"month": 11,
"period": "2022-11",
"transfer_coins": 0,
"year": 2022
}
]
}
Convert coins
POST /payments-service/withdrawal/convert_coins
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| coins | coins | Coins value |
| value | number | Fiat value |
| type | string | Target account type |
| id | string | Target account id |
| negative_values | string | Flag to show negative values (true/false). false is dafault. |
| rule_karma_value_include | boolean | Include karma validation result check |
coins or value parameter is requiredtype should be one of ethereum_account, cashout_account, coinbase_account, poloniex_account
Example Request (poloniex_account)
{
"id": "74848b0833808eeb326b5c210440d4a9512b5996",
"value": 1.00,
"negative_values": true,
"type": "poloniex_account",
"rule_karma_value_include": true
}
Example Response (poloniex_account)
{
"coins": "166195778627222863872",
"coins_with_fee": "166195778627222863872",
"coins_without_fee": "166195778627222863872",
"currency": "AUD",
"fee_coins": 0,
"fee_value": 0.0,
"gas_coins": "19000000000000000000",
"gas_fee_coins": 0,
"gas_fee_precent": 0,
"gas_fee_value": 0.0,
"karma_value": 60,
"karma_value_lock_before": 50,
"karma_value_unlock": 70,
"karma_value_withdrawal_enabled": true,
"min_transfer_coins_value": "1000000000000000000",
"transaction_fee": 0,
"transaction_fee_coins": 0,
"transaction_fee_value": 0.0,
"value": 1.0,
"value_with_fee": 1.0,
"value_without_fee": 1.0
}
Example Request (coinbase_account)
{
"id": "808c8461-590c-4686-9214-b3f90bc6f912",
"value": 1.00,
"negative_values": true,
"type": "coinbase_account",
"rule_karma_value_include": true
}
Example Response (coinbase_account)
{
"coins": "3830000000000000000000",
"coins_with_fee": "9640490000000000000000",
"coins_without_fee": -1980490000000000000000,
"currency": "AUD",
"fee_coins": "5810490000000000000000",
"fee_value": 1.51,
"gas_coins": "111000000000000000000",
"gas_fee_coins": "65490000000000000000",
"gas_fee_precent": 59,
"gas_fee_value": 0.01,
"min_transfer_coins_value": "1000000000000000000",
"transaction_fee": 1.5,
"transaction_fee_coins": "5745000000000000000000",
"transaction_fee_value": 1.5,
"value": -0.51,
"value_with_fee": 1.0,
"value_without_fee": -0.51,
"karma_value": 80.0,
"karma_value_lock_before": 50,
"karma_value_unlock": 70,
"karma_value_withdrawal_enabled": true
}
Example Request (coinbase_account)
{
"id": "80bc50eb-1111-2222-91f1-33dd27d6e519",
"coins": "10000000000000000000",
"type": "coinbase_account",
"rule_karma_value_include": true
}
Example Response (coinbase_account)
{
"coins": "10000000000000000000",
"coins_with_fee": "10000000000000000000",
"coins_without_fee": "10000000000000000000",
"currency": "AUD",
"fee_coins": 0,
"fee_value": 0.0,
"gas_coins": "426000000000000000000",
"gas_fee_coins": 0,
"gas_fee_precent": 0,
"gas_fee_value": 0.0,
"min_transfer_coins_value": "1000000000000000000",
"transaction_fee": 0,
"transaction_fee_coins": 0,
"transaction_fee_value": 0.0,
"value": 0.0,
"value_with_fee": 0.0,
"value_without_fee": 0.0,
"karma_value": 80.0,
"karma_value_lock_before": 50,
"karma_value_unlock": 70,
"karma_value_withdrawal_enabled": true
}
Example Request (cashout_account)
{
"id": "3ae78d2c-8395-4440-9bf0-5205befb4c13",
"coins": "10000000000000000000",
"type": "cashout_account"
}
Example Response (cashout_account)
{
"coins": "10000000000000000000",
"coins_with_fee": "5674380000000000000000",
"coins_without_fee": 0,
"currency": "AUD",
"fee_coins": "5664380000000000000000",
"fee_value": 1.52,
"gas_coins": "182000000000000000000",
"gas_fee_coins": "107380000000000000000",
"gas_fee_precent": 59,
"gas_fee_value": 0.02,
"transaction_fee": 1.5,
"transaction_fee_coins": "5557000000000000000000",
"transaction_fee_value": 1.5,
"value": 0,
"value_with_fee": 0.0,
"value_without_fee": 0
}
Example Request
{
"coins": "10000000000000000000"
}
Example Response
{
"coins": "10000000000000000000",
"coins_with_fee": "10000000000000000000",
"coins_without_fee": "10000000000000000000",
"currency": "AUD",
"fee_coins": 0,
"fee_value": 0.0,
"gas_coins": "10000000000000000000",
"gas_fee_coins": 0,
"gas_fee_precent": 0,
"gas_fee_value": 0.0,
"min_transfer_coins_value": "1000000000000000000",
"transaction_fee": 0,
"transaction_fee_coins": 0,
"transaction_fee_value": 0.0,
"value": 0.23,
"value_with_fee": 0.23,
"value_without_fee": 0.23
}
Disconnect coinbase accounts
POST /payments-service/coinbase/account/remove
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| accounts | body | Required: List of ids |
Example Request
{
"accounts": [ "80bc50eb-246a-5f8c-91f1-33dd27d6e519" ]
}
Example Response
{
"accounts": [
{
"avatar_url": "https://images.coinbase.com/avatar?h=61f710805a65551207c9d7byjafcxQzYPjMprN0R71t%2BVpkJP2t60hwR92vM%0Ah7X%2F&s=128",
"email": "email@gmail.com",
"id": "80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"name": "user surname",
"profile_bio": null,
"profile_location": null,
"profile_url": null,
"resource": "user",
"resource_path": "/v2/users/80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"ts": "2022-04-29T02:11:35Z",
"type": "coinbase_account",
"username": null,
"inactive": true
}
]
}
Convert coinbase coins
GET /payments-service/coinbase/convert_coins
Request parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| coins | body | Required: Coins value |
| negative_values | body | Flag to show negative values (true/false). false is dafault. |
Example Response
{
"coins": "100000000000000000000000",
"coins_with_fee": "100000000000000000000000",
"coins_without_fee": "100000000000000000000000",
"currency": "AUD",
"fee_coins": 0,
"fee_value": 0.0,
"gas_coins": "150000000000000000000",
"gas_fee_coins": 0,
"gas_fee_precent": 0,
"gas_fee_value": 0.0,
"min_transfer_coins_value": "100000000000000000",
"transaction_fee": 0,
"transaction_fee_coins": 0,
"transaction_fee_value": 0.0,
"value": 27.13,
"value_with_fee": 27.13,
"value_without_fee": 27.13
}
Transfer coins to coinbase account
POST /payments-service/coinbase/transfer
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Session's ticket |
| coins | coins | Required: Coins to transfer |
| id | string | Required: Coinbase account id |
| pay_fee_with_coins | boolean | Flag that indicates how amount will be calculated |
Example Request
{
"coins" : "100000000000000000",
"id": "80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"pay_fee_with_coins": true
}
Example Response
{
"account": {
"avatar_url": "https://images.coinbase.com/avatar?h=61f710805a65551207c9d7byjafcxQzYPjMprN0R71t%2BVpkJP2t60hwR92vM%0Ah7X%2F&s=128",
"email": "email@gmail.com",
"id": "80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"name": "user surname",
"profile_bio": null,
"profile_location": null,
"profile_url": null,
"resource": "user",
"resource_path": "/v2/users/80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"username": null
},
"coins": "100000000000000000",
"fee": {
"coins": "100000000000000000",
"coins_with_fee": "100000000000000000",
"coins_without_fee": "100000000000000000",
"fee_coins": 0,
"fee_value": 0.0,
"gas_coins": "137000000000000000000",
"gas_fee_coins": 0,
"gas_fee_precent": 0,
"gas_fee_value": 0.0,
"pay_fee_with_coins": true,
"transaction_fee": 0,
"transaction_fee_coins": 0,
"transaction_fee_value": 0.0,
"value": 0.0,
"value_with_fee": 0.0,
"value_without_fee": 0.0
},
"hash": null,
"id": "urn:authenticateit:transaction_request:58ae8e28-72ae-4152-b0e0-358d486ae88e",
"status": "pending",
"ts": "2022-05-02T06:02:14Z"
}
Coinbase/Poloniex transfers validation
Methods are only available for system participant
Get coinbase transfer settings
GET /payments-service/coinbase/options
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
{
"manual_approve": "inactive"
}
Set coinbase transfer settings
POST /payments-service/coinbase/options
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| manual_approve | body | Required: Manual approve mode (active/inactive) |
Example Request
{
"manual_approve": "active"
}
Example Response
{
"manual_approve": "active"
}
Get poloniex transfer settings
GET /payments-service/poloniex/options
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
{
"manual_approve": "inactive"
}
Set poloniex transfer settings
POST /payments-service/poloniex/options
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| manual_approve | body | Required: Manual approve mode (active/inactive) |
Example Request
{
"manual_approve": "inactive"
}
Example Response
{
"manual_approve": "inactive"
}
Read list of Coinbase/Poloniex transfers
POST /payments-service/transfer/get
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| user_id | string | User id filter |
| account_email | string | Account email filter |
| ts_from | string | Datetime from filter |
| ts_to | string | Datetime to filter |
| status | list | Statuses filter |
| type | list | Types filter |
| order_type | string | asc or desc |
| order_by | string | ts |
| limit | pos_integer | Limit |
| offset | non_neg_integer | Offset |
Valid status filter values: pending,manual_rejected,manual_approved,auto_approved
Valid type filter values: coinbase,poloniex
Example Request
{
"user_id" : "urn:authenticateit:user:email:email@gmail.com",
"ts_from": "2022-05-01T04:23:56Z",
"status": ["pending","manual_rejected","manual_approved", "auto_approved"],
"order_type": "asc",
"order_by": "ts",
"type": ["coinbase", "poloniex"],
"limit": 1,
"offset": 1
}
Example Response
{
"count": 5,
"data": [
{
"account_address": "0xC306c35423c6EB246C545B9F3F4B6a18cE29290d",
"account_email": null,
"account_number": "9f8e166a35a20dff1c2e92f506b1d76f95ab48cf",
"aud_amount": 0.0470719288,
"aud_fee_amount": 0.0,
"coins_amount": "6476600000000000000",
"coins_fee": "0",
"first_name": "Iii",
"id": "urn:authenticateit:transaction_request:1fe053e1-8cf4-4371-a8bc-312c0d65a00b:manual",
"last_name": null,
"request_id": "urn:authenticateit:transaction_request:1fe053e1-8cf4-4371-a8bc-312c0d65a00b",
"request_service_response": null,
"request_status": "pending",
"status": "auto_approved",
"ts": "2023-02-14T01:13:24Z",
"type": "poloniex",
"user_email": "ikleeen+813@gmail.com",
"user_id": "urn:authenticateit:user:email:shping:505948c8-a993-40f2-b941-30fb2d95afb5"
},
{
"account_address": "0xC306c35423c6EB246C545B9F3F4B6a18cE29290d",
"account_email": null,
"account_number": "9f8e166a35a20dff1c2e92f506b1d76f95ab48cf",
"aud_amount": 0.0477066356,
"aud_fee_amount": 0.0,
"coins_amount": "6476600000000000000",
"coins_fee": "0",
"first_name": "Iii",
"id": "urn:authenticateit:transaction_request:695dea5b-d3cf-4538-b18c-8ff10a6b1e62:manual",
"last_name": null,
"request_id": "urn:authenticateit:transaction_request:695dea5b-d3cf-4538-b18c-8ff10a6b1e62",
"request_service_response": {
"errors": {
"errors": [
{
"id": "internal_error",
"message": "ERROR_1"
}
],
"httpStatus": 500
},
"status": "failure"
},
"request_status": "failure",
"status": "manual_approved",
"ts": "2023-02-13T23:47:38Z",
"type": "poloniex",
"user_email": "ikleeen+813@gmail.com",
"user_id": "urn:authenticateit:user:email:shping:505948c8-a993-40f2-b941-30fb2d95afb5"
},
{
"account_email": "v@gmail.com",
"account_number": "80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"aud_amount": 0.015576,
"aud_fee_amount": 0.0,
"coins_amount": "2000000000000000000",
"coins_fee": "0",
"first_name": "user1",
"id": "urn:authenticateit:transaction_request:e335f0d0-2da2-4c10-a848-1853d9bcc7ec:manual",
"last_name": "surname1",
"request_id": "urn:authenticateit:transaction_request:e335f0d0-2da2-4c10-a848-1853d9bcc7ec",
"request_service_response": null,
"request_status": "failure",
"status": "manual_rejected",
"ts": "2022-11-14T01:55:13Z",
"type": "coinbase",
"user_email": "email+811@gmail.com",
"user_id": "urn:authenticateit:user:email:shping:9cf92a52-e708-4d45-a7f5-53ed475c1c3c"
},
{
"account_email": "email@gmail.com",
"account_number": "80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"aud_amount": 0.015576,
"aud_fee_amount": 0.0,
"coins_amount": "2000000000000000000",
"coins_fee": "0",
"first_name": "user1",
"id": "urn:authenticateit:transaction_request:411991a7-965f-4532-bb68-f0aba52aa825:manual",
"last_name": "surname1",
"request_id": "urn:authenticateit:transaction_request:411991a7-965f-4532-bb68-f0aba52aa825",
"request_service_response": {
"errors": {
"errors": [
{
"id": "internal_shping_error",
"message": "unexpected status: failure"
}
],
"httpStatus": 500
},
"status": "failure"
},
"request_status": "failure",
"status": "auto_approved",
"ts": "2022-11-14T01:31:30Z",
"type": "coinbase",
"user_email": "email+811@gmail.com",
"user_id": "urn:authenticateit:user:email:shping:9cf92a52-e708-4d45-a7f5-53ed475c1c3c"
},
{
"account_email": "email@gmail.com",
"account_number": "80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"aud_amount": 0.015576,
"aud_fee_amount": 0.0,
"coins_amount": "2000000000000000000",
"coins_fee": "0",
"first_name": "user1",
"id": "urn:authenticateit:transaction_request:232184e3-3cbd-437e-a701-8ef2150d2419:manual",
"last_name": "surname1",
"request_id": "urn:authenticateit:transaction_request:232184e3-3cbd-437e-a701-8ef2150d2419",
"request_service_response": {
"status": "completed"
},
"request_status": "success",
"status": "auto_approved",
"ts": "2022-11-14T01:01:42Z",
"type": "coinbase",
"user_email": "email+811@gmail.com",
"user_id": "urn:authenticateit:user:email:shping:9cf92a52-e708-4d45-a7f5-53ed475c1c3c"
},
{
"account_email": "email@gmail.com",
"account_number": "80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"aud_amount": 2.7027e-5,
"aud_fee_amount": 0.0,
"coins_amount": "100000000000000000",
"coins_fee": "0",
"first_name": "user1",
"id": "urn:authenticateit:transaction_request:d31b278c-ea2a-4a0e-94a6-6d7cb78c6472:manual",
"last_name": "surname1",
"request_id": "urn:authenticateit:transaction_request:d31b278c-ea2a-4a0e-94a6-6d7cb78c6472",
"status": "manual_approved",
"request_status": "success",
"ts": "2022-05-02T04:39:27Z",
"type": "coinbase",
"user_email": "email@gmail.com",
"user_id": "urn:authenticateit:user:email:email@gmail.com"
},
{
"account_email": "email@gmail.com",
"account_number": "80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"aud_amount": 2.7027e-5,
"aud_fee_amount": 0.0,
"coins_amount": "100000000000000000",
"coins_fee": "0",
"first_name": "user1",
"id": "urn:authenticateit:transaction_request:d31b278c-ea2a-4a0e-9999-6d7cb78c6472:manual",
"last_name": "surname1",
"request_id": "urn:authenticateit:transaction_request:d31b278c-ea2a-9999-94a6-6d7cb78c6472",
"status": "auto_approved",
"request_status": "failure",
"ts": "2022-05-02T04:39:27Z",
"type": "coinbase",
"user_email": "email@gmail.com",
"user_id": "urn:authenticateit:user:email:email@gmail.com"
}
]
}
Approve Coinbase/Poloniex transfer
POST /payments-service/transfer/approve
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| id | string | Required: Coinbase transfer id |
Example Request
{
"id" : "urn:authenticateit:transaction_request:d31b278c-ea2a-4a0e-94a6-6d7cb78c6472:manual"
}
Reject Coinbase/Poloniex transfer
POST /payments-service/transfer/reject
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| id | string | Required: Coinbase transfer id |
Example Request
{
"id" : "urn:authenticateit:transaction_request:d31b278c-ea2a-4a0e-94a6-6d7cb78c6472:manual"
}
Read transfer limits
POST /payments-service/transfer/limits
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| id | string | Required: Coinbase transfer id |
Example Request
{
"id" : "urn:authenticateit:transaction_request:d31b278c-ea2a-4a0e-94a6-6d7cb78c6472:manual"
}
Example Response
{
"history": [
{
"account": {
"address": "0xC306c35423c6EB246C545B9F3F4B6a18cE29290d",
"description": "11111 ",
"id": "9f8e166a35a20dff1c2e92f506b1d76f95ab48cf",
"status": "success",
"ts": "2023-02-12T23:54:18Z"
},
"coins": "6476600000000000000",
"coins_prices": {
"aud": 7.268000000000001e-21,
"sgd": 6.691e-21,
"usd": 5.021e-21
},
"fee": {
"coins": "6476680000000000000",
"coins_with_fee": "6476680000000000000",
"coins_without_fee": "6476680000000000000",
"fee_coins": 0,
"fee_value": 0.0,
"gas_coins": "18000000000000000000",
"gas_fee_coins": 0,
"gas_fee_precent": 0,
"gas_fee_value": 0.0,
"pay_fee_with_coins": false,
"transaction_fee": 0,
"transaction_fee_coins": 0,
"transaction_fee_value": 0.0,
"value": 0.04,
"value_with_fee": 0.04,
"value_without_fee": 0.04
},
"hash": "16705382",
"id": "urn:authenticateit:transaction_request:1fe053e1-8cf4-4371-a8bc-312c0d65a00b",
"nonce": 1676337241022,
"profile_coins": "1222798400000000000000",
"service_response": {
"errors": {
"errors": {
"withdrawals": [
{
"status": "COMPLETE ERROR",
"withdrawalRequestId": 16705382
}
]
},
"httpStatus": 200
},
"status": "failure"
},
"status": "failure",
"timezone_min": 660,
"ts": "2023-02-14T01:13:24Z",
"type": "poloniex"
},
{
"account": {
"avatar_url": "https://images.coinbase.com/avatar?h=61f710805a65551207c9d7byjafcxQzYPjMprN0R71t%2BVpkJP2t60hwR92vM%0Ah7X%2F&s=128",
"email": "email@gmail.com",
"id": "80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"name": "user surname",
"profile_bio": null,
"profile_location": null,
"profile_url": null,
"resource": "user",
"resource_path": "/v2/users/80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"username": null
},
"coins": "1000000000000000000",
"coins_prices": {
"aud": 2.280501710376283e-22,
"sgd": 2.2086659064994296e-22,
"usd": 1.5906499429874572e-22
},
"fee": {
"coins": "1000000000000000000",
"coins_with_fee": "1000000000000000000",
"coins_without_fee": "1000000000000000000",
"fee_coins": 0,
"fee_value": 0.0,
"gas_coins": "51000000000000000000",
"gas_fee_coins": 0,
"gas_fee_precent": 0,
"gas_fee_value": 0.0,
"pay_fee_with_coins": false,
"transaction_fee": 0,
"transaction_fee_coins": 0,
"transaction_fee_value": 0.0,
"value": 0.0,
"value_with_fee": 0.0,
"value_without_fee": 0.0
},
"hash": null,
"id": "urn:authenticateit:transaction_request:a15e7461-374c-4cab-93a4-d8aa4b83b2e2",
"manual_code": "urn:authenticateit:transaction_request:a15e7461-374c-4cab-93a4-d8aa4b83b2e2:manual",
"owner": "urn:authenticateit:user:email:email@gmail.com",
"profile_coins": "466694263600000000000000",
"status": "pending",
"ts": "2022-05-11T05:26:05Z",
"type": "coinbase"
},
{
"account": {
"account": "677742225595",
"bank": "SomeBank",
"bsb": "355896",
"country": "036",
"description": "My account",
"name": "User's account",
"postcode": "6646"
},
"coins": "10000000000000000000000",
"coins_prices": {
"aud": 2.2522522522522525e-22,
"sgd": 2.1813063063063063e-22,
"usd": 1.570945945945946e-22
},
"converted_aud_value": 0.7,
"converted_usd_value": 0.02,
"converted_value": 0.7,
"currency": "aud",
"fee": {
"coins": "10000000000000000000000",
"coins_with_fee": "17000610000000000000000",
"coins_without_fee": "2999390000000000000000",
"fee_coins": "7000610000000000000000",
"fee_value": 1.57,
"gas_coins": "579000000000000000000",
"gas_fee_coins": "341610000000000000000",
"gas_fee_precent": 59,
"gas_fee_value": 0.07,
"pay_fee_with_coins": false,
"transaction_fee": 1.5,
"transaction_fee_coins": "6659000000000000000000",
"transaction_fee_value": 1.5,
"value": 0.68,
"value_with_fee": 2.25,
"value_without_fee": 0.68
},
"hash": "de873d2451523b745d6b14a4e610ab1e",
"id": "urn:authenticateit:transaction_request:9b0bb5c6-6158-40e1-a17c-15ce17ed7709",
"profile_coins": "516695263600000000000000",
"status": "success",
"ts": "2022-05-11T00:48:00Z",
"type": "cashout"
}
],
"limits": {
"boosted_value": 0,
"currency": "aud",
"history_value": 14.38771953735535,
"level": "basic",
"max_level_value": 20,
"record_value": 2.7173913043478e-5,
"total_max_level_value": 70,
"ts_from": "2022-04-30T14:00:00Z",
"ts_to": "2022-05-31T14:00:00Z"
},
"request": {
"account": {
"avatar_url": "https://images.coinbase.com/avatar?h=61f710805a65551207c9d7byjafcxQzYPjMprN0R71t%2BVpkJP2t60hwR92vM%0Ah7X%2F&s=128",
"email": "email@gmail.com",
"id": "80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"name": "user surname",
"profile_bio": null,
"profile_location": null,
"profile_url": null,
"resource": "user",
"resource_path": "/v2/users/80bc50eb-246a-5f8c-91f1-33dd27d6e519",
"username": null
},
"action": "user_coinbase",
"coins": "100000000000000000",
"coins_prices": {
"aud": 2.717391304347826e-22,
"sgd": 2.684510869565217e-22,
"usd": 1.942391304347826e-22
},
"fee": {
"coins": "100000000000000000",
"coins_with_fee": "100000000000000000",
"coins_without_fee": "100000000000000000",
"fee_coins": 0,
"fee_value": 0.0,
"gas_coins": "137000000000000000000",
"gas_fee_coins": 0,
"gas_fee_precent": 0,
"gas_fee_value": 0.0,
"pay_fee_with_coins": true,
"transaction_fee": 0,
"transaction_fee_coins": 0,
"transaction_fee_value": 0.0,
"value": 0.0,
"value_with_fee": 0.0,
"value_without_fee": 0.0
},
"id": "urn:authenticateit:transaction_request:58ae8e28-72ae-4152-b0e0-358d486ae88e:manual",
"moderator_id": "urn:authenticateit:user:email:system@authenticateit.com",
"owner": "urn:authenticateit:user:email:email@gmail.com",
"profile_coins": "578806463600000000000000",
"status": "manual_rejected",
"status_ts": "2022-05-02T08:01:53Z",
"transfer_uuid": "urn:authenticateit:transaction_request:58ae8e28-72ae-4152-b0e0-358d486ae88e",
"ts": "2022-05-02T06:02:14Z"
},
"user": {
"country": "036",
"email": "email@gmail.com",
"first_name": "user1",
"id": "urn:authenticateit:user:email:email@gmail.com",
"last_name": "surname1",
"level": "basic",
"phone": "+6111111111",
"photo": "https://dev-cdn.shping.com/2019/3/6/c5809b6f-3b0d-4d7c-8b43-14ff20edbffa"
}
}
Poloniex transfers
Add new Poloniex account
POST /payments-service/poloniex/account
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| address | string | Required: Address |
| description | string | Description |
Example Request
{
"address": "0x4ca5f489cc1fd1cec24747b64e8de0f4a6a850e3",
"description": "Test desc"
}
Example Response
{
"accounts": [
{
"address": "0x4ca5F489CC1fD1cEc24747b64E8dE0F4A6A850e3",
"description": "Test desc",
"id": "69b83263fbdbaa4ebf49d59ea98540a3ce77be96",
"is_new": true,
"status": "pending",
"ts": "2022-12-30T06:23:35Z"
},
{
"address": "0x3cA5F489cC1fd1CeC24747B64E8de0f4A6A850e3",
"description": "Test desc2",
"id": "1a8d8468d1ae2ec10c5233481d2b66ca233eb938",
"is_new": false,
"status": "pending",
"ts": "2022-12-30T06:12:30Z"
}
]
}
Read Poloniex addresses
GET /payments-service/poloniex/account
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
{
"accounts": [
{
"address": "0x8ca5F489Cc1fd1ceC24747b64e8DE0f4A6a850E3",
"description": "Test desc",
"id": "48d8909fbf42cc6bbed4dd47eeaf203cb2a65634",
"status": "pending",
"ts": "2022-12-30T06:34:58Z"
},
{
"address": "0x4ca5F489CC1fD1cEc24747b64E8dE0F4A6A850e3",
"description": "Test desc",
"id": "69b83263fbdbaa4ebf49d59ea98540a3ce77be96",
"is_new": true,
"status": "success",
"ts": "2022-12-30T06:23:35Z"
},
{
"address": "0x3cA5F489cC1fd1CeC24747B64E8de0f4A6A850e3",
"description": "Test desc2",
"id": "1a8d8468d1ae2ec10c5233481d2b66ca233eb938",
"is_new": false,
"status": "failure",
"ts": "2022-12-30T06:12:30Z"
}
]
}
Update Poloniex account
PUT /payments-service/poloniex/account
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| id | string | Required: Account id |
| description | string | Description |
Example Request
{
"id": "48d8909fbf42cc6bbed4dd47eeaf203cb2a65634",
"description": "Updated test desc"
}
Example Response
{
"accounts": [
{
"address": "0x8ca5F489Cc1fd1ceC24747b64e8DE0f4A6a850E3",
"description": "Updated test desc",
"id": "48d8909fbf42cc6bbed4dd47eeaf203cb2a65634",
"status": "pending",
"ts": "2022-12-30T06:34:58Z"
},
{
"address": "0x4ca5F489CC1fD1cEc24747b64E8dE0F4A6A850e3",
"description": "Test desc",
"id": "69b83263fbdbaa4ebf49d59ea98540a3ce77be96",
"is_new": true,
"status": "success",
"ts": "2022-12-30T06:23:35Z"
},
{
"address": "0x3cA5F489cC1fd1CeC24747B64E8de0f4A6A850e3",
"description": "Test desc2",
"id": "1a8d8468d1ae2ec10c5233481d2b66ca233eb938",
"is_new": false,
"status": "failure",
"ts": "2022-12-30T06:12:30Z"
}
]
}
Delete Poloniex accounts
POST /payments-service/poloniex/account/remove
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| ids | list | Required: Account ids |
Example Request
{
"ids": ["d379e3d9b0f2d3f92db92dfbe070a2bc73554cdc"]
}
Example Response
{
"accounts": [
{
"address": "0x8ca5F489Cc1fd1ceC24747b64e8DE0f4A6a850E3",
"description": "Updated test desc",
"id": "48d8909fbf42cc6bbed4dd47eeaf203cb2a65634",
"status": "pending",
"ts": "2022-12-30T06:34:58Z"
},
{
"address": "0x4ca5F489CC1fD1cEc24747b64E8dE0F4A6A850e3",
"description": "Test desc",
"id": "69b83263fbdbaa4ebf49d59ea98540a3ce77be96",
"is_new": true,
"status": "success",
"ts": "2022-12-30T06:23:35Z"
},
{
"address": "0x3cA5F489cC1fd1CeC24747B64E8de0f4A6A850e3",
"description": "Test desc2",
"id": "1a8d8468d1ae2ec10c5233481d2b66ca233eb938",
"is_new": false,
"status": "failure",
"ts": "2022-12-30T06:12:30Z"
}
]
}
Transfer coins to Poloniex account
POST /payments-service/poloniex/transfer
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Session's ticket |
| coins | coins | Required: Coins to transfer |
| id | string | Required: Poloniex account id |
| pay_fee_with_coins | boolean | Flag that indicates how amount will be calculated |
Example Request
{
"coins" : "6476680000000000000",
"id": "9f8e166a35a20dff1c2e92f506b1d76f95ab48cf",
"pay_fee_with_coins": false
}
Example Response
{
"account": {
"address": "0xC306c35423c6EB246C545B9F3F4B6a18cE29290d",
"description": "11111 ",
"id": "9f8e166a35a20dff1c2e92f506b1d76f95ab48cf",
"status": "success",
"ts": "2023-02-12T23:54:18Z"
},
"coins": "6476600000000000000",
"fee": {
"coins": "6476680000000000000",
"coins_with_fee": "6476680000000000000",
"coins_without_fee": "6476680000000000000",
"fee_coins": 0,
"fee_value": 0.0,
"gas_coins": "18000000000000000000",
"gas_fee_coins": 0,
"gas_fee_precent": 0,
"gas_fee_value": 0.0,
"pay_fee_with_coins": false,
"transaction_fee": 0,
"transaction_fee_coins": 0,
"transaction_fee_value": 0.0,
"value": 0.04,
"value_with_fee": 0.04,
"value_without_fee": 0.04
},
"hash": null,
"id": "urn:authenticateit:transaction_request:27b0801a-9eb9-4cf0-a5e6-8242b8ff8aee",
"status": "pending",
"ts": "2023-02-14T01:45:03Z"
}
Retail connect
Retail connect. Get user level info
GET /payments-service/retail_connect/v1/code
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| card_id | string | Storecard id |
| code | string | Deeplink code |
| participant_id | string | Participant id |
participant_id or code or card_id must be provided
Example Response
{
"activity_from_date": "2023-05-01",
"activity_from_utc_ts": "2023-04-30T14:00:00Z",
"activity_to_date": "2023-05-31",
"activity_to_utc_ts": "2023-05-31T13:59:59Z",
"calculated_ts": "2023-05-08T11:13:41Z",
"counters": {
"purchases_count": 1,
"sessions": [
"urn:authenticateit:retail_connect:session:bee67223-1278-4ceb-b299-c579d85ee9e5"
],
"spends": 1000
},
"id": "urn:authenticateit:user:email:shping:9cc2a816-2897-4858-be3d-71abd8d6c1b8@retail_connect@urn:authenticateit:participant:735879621218609@level",
"loyalty_program": {
"bgcolor": "#ED1010",
"coin_payments_rule": {
"currency_value": 2000,
"type": "currency_value"
},
"country": "036",
"created_at": "2023-05-09T03:04:44Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "The loyalty card list will be updated to include the <b>NovaStore</b> card, which enables payment with shping coins and offers a personalized discount of up to 33% at affiliated stores.",
"id": "87f9db8b-9aec-47a0-aaca-1ff140b3ba0a",
"image_big": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"image_small": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"level_up": [
{
"level_id": "casual",
"rules": []
},
{
"level_id": "regular",
"rules": [
{
"purchases_count": 5,
"type": "purchases_count"
},
{
"spends": 2000,
"type": "spends"
}
]
},
{
"level_id": "vip",
"rules": [
{
"purchases_count": 10,
"type": "purchases_count"
},
{
"spends": 2500,
"type": "spends"
}
]
}
],
"name": "NovaStore",
"rebate": [
{
"level_id": "casual",
"rebate_percents": 15
},
{
"level_id": "regular",
"rebate_percents": 25
},
{
"level_id": "vip",
"rebate_percents": 33
}
],
"status": "active",
"type": "custom"
},
"next_date": "2023-07-01",
"next_ts_utc": "2023-06-30T14:00:00Z",
"participant_id": "urn:authenticateit:participant:735879621218609",
"rules": [
{
"pass": false,
"purchases_count": 5,
"type": "purchases_count",
"user_value": 1
},
{
"pass": false,
"spends": 2000,
"type": "spends",
"user_value": 1000
}
],
"timezone_min": 600,
"type": "retail_connect_level",
"user_id": "urn:authenticateit:user:email:shping:9cc2a816-2897-4858-be3d-71abd8d6c1b8",
"user_level": "casual",
"user_level_next": "regular",
"user_level_rebate_percents": 15
}
Retail connect. Generate code
card_id is the user's storecard identifier (read more in the storecards service section).
Generated code should be used for initializing the session from the terminal.
GET /payments-service/retail_connect/v1/code
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| card_id | string | Required: Storecard id |
Example Response
{
"code": "1ad9f5c6a06d5847c79dd2110d759e131d23bdeb7de1562fc27a3e0608428f55737adb56b4789efedcf6e4a98ca962e810a9782161cc65ee7255e72d0332330c686e9393f44e9b4673da0736ed441b591cc97650a408d318794578c474d991408099c87fdee9b654f5e7def740c4d4cf59af7ec1ac632684cd25ea21764d282e8a6bfb7a39f8d84ef92b51b5c71199845168c7f65dde49dd696c9963c7e12dcbe"
}
Retail connect. Initialize session
The method allows initializing session from the terminal side.
POST /payments-service/retail_connect/v1/sessions/session/init
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| authenticateit_terminal_device | header | Required: Device ticket |
| code | string | Required: Code |
Example Request
{
"code": "1ad9f5c6a06d5847c79dd2110d759e131d23bdeb7de1562fc27a3e0608428f55737adb56b4789efedcf6e4a98ca962e810a9782161cc65ee7255e72d0332330c686e9393f44e9b4673da0736ed441b591cc97650a408d318794578c474d991408099c87fdee9b654f5e7def740c4d4cf59af7ec1ac632684cd25ea21764d282e8a6bfb7a39f8d84ef92b51b5c71199845168c7f65dde49dd696c9963c7e12dcbe"
}
Example Response
{
"code": "1ad9f5c6a06d5847c79dd2110d759e131d23bdeb7de1562fc27a3e0608428f55737adb56b4789efedcf6e4a98ca962e810a9782161cc65ee7255e72d0332330c686e9393f44e9b4673da0736ed441b591cc97650a408d318794578c474d991408099c87fdee9b654f5e7def740c4d4cf59af7ec1ac632684cd25ea21764d282e8a6bfb7a39f8d84ef92b51b5c71199845168c7f65dde49dd696c9963c7e12dcbe",
"code_hash": "70cc0f0bbf898990af974a98eb44668732cd0cc2",
"coin_price": {
"price": 6.15e-21,
"timeout_sec": 120,
"ts": "2023-05-02T02:17:21Z"
},
"create_ts": "2023-05-02T02:17:21Z",
"currency": "aud",
"device_id": "735879621218609:a5ed8e8f-98bc-4c6a-a00a-2222db146808",
"id": "urn:authenticateit:retail_connect:session:71bbcb8e-05de-49d4-bd09-ec335b535f4b",
"is_expired": false,
"loyalty_program": {
"bgcolor": "#ED1010",
"coin_payments_rule": {
"currency_value": 2,
"type": "currency_value"
},
"country": "036",
"created_at": "2023-05-01T08:49:48Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"id": "14abbf9c-7883-4aef-89b9-7310c320ef8d",
"image_big": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"image_small": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"level_up": [
{
"level_id": "casual",
"rules": []
},
{
"level_id": "regular",
"rules": [
{
"period_days": 9,
"purchases": 22,
"type": "purchases_count"
},
{
"period_days": 21,
"type": "spends",
"value_aud": 60
}
]
},
{
"level_id": "vip",
"rules": [
{
"period_days": 2,
"purchases": 10,
"type": "purchases_count"
},
{
"period_days": 2,
"type": "spends",
"value_aud": 10
}
]
}
],
"name": "NovaStore",
"rebate": [
{
"level_id": "casual",
"rebate_percents": 15
},
{
"level_id": "regular",
"rebate_percents": 25
},
{
"level_id": "vip",
"rebate_percents": 33
}
],
"type": "custom",
"user_level": "casual"
},
"operator_id": "urn:authenticateit:user:email:ethertest3@mailinator.com",
"participant_id": "urn:authenticateit:participant:735879621218609",
"status": "init",
"status_side": "terminal",
"timeout": 1800,
"type": "retail_connect_session",
"update_ts": "2023-05-02T02:17:21Z",
"user_id": "urn:authenticateit:user:email:shping:9cc2a816-2897-4858-be3d-71abd8d6c1b8"
}
Retail connect. Read sessions
The method allow users to read active sessions with different filters.
GET /payments-service/retail_connect/v1/sessions
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| code | string | Filter by code |
| participant_id | string | Filter by retail connect participant_id |
| card_id | string | Filter by retail connect card_id |
Example Response
[
{
"code": "1ad9f5c6a06d5847c79dd2110d759e131d23bdeb7de1562fc27a3e0608428f55737adb56b4789efedcf6e4a98ca962e810a9782161cc65ee7255e72d0332330c686e9393f44e9b4673da0736ed441b591cc97650a408d318794578c474d991408099c87fdee9b654f5e7def740c4d4cf59af7ec1ac632684cd25ea21764d282e8a6bfb7a39f8d84ef92b51b5c71199845168c7f65dde49dd696c9963c7e12dcbe",
"code_hash": "70cc0f0bbf898990af974a98eb44668732cd0cc2",
"coin_price":
{
"price": 6.15E-21,
"timeout_sec": 120,
"ts": "2023-05-02T02:17:21Z"
},
"create_ts": "2023-05-02T02:17:21Z",
"currency": "aud",
"device_id": "735879621218609:a5ed8e8f-98bc-4c6a-a00a-2222db146808",
"id": "urn:authenticateit:retail_connect:session:71bbcb8e-05de-49d4-bd09-ec335b535f4b",
"is_expired": false,
"loyalty_program":
{
"bgcolor": "#ED1010",
"coin_payments_rule":
{
"currency_value": 2,
"type": "currency_value"
},
"country": "036",
"created_at": "2023-05-01T08:49:48Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"id": "14abbf9c-7883-4aef-89b9-7310c320ef8d",
"image_big": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"image_small": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"level_up":
[
{
"level_id": "casual",
"rules":
[]
},
{
"level_id": "regular",
"rules":
[
{
"period_days": 9,
"purchases": 22,
"type": "purchases_count"
},
{
"period_days": 21,
"type": "spends",
"value_aud": 60
}
]
},
{
"level_id": "vip",
"rules":
[
{
"period_days": 2,
"purchases": 10,
"type": "purchases_count"
},
{
"period_days": 2,
"type": "spends",
"value_aud": 10
}
]
}
],
"name": "NovaStore",
"rebate":
[
{
"level_id": "casual",
"rebate_percents": 15
},
{
"level_id": "regular",
"rebate_percents": 25
},
{
"level_id": "vip",
"rebate_percents": 33
}
],
"type": "custom",
"user_level": "casual"
},
"operator_id": "urn:authenticateit:user:email:ethertest3@mailinator.com",
"participant_id": "urn:authenticateit:participant:735879621218609",
"status": "init",
"status_side": "terminal",
"timeout": 1800,
"type": "retail_connect_session",
"update_ts": "2023-05-02T02:17:21Z",
"user_id": "urn:authenticateit:user:email:shping:9cc2a816-2897-4858-be3d-71abd8d6c1b8"
}
]
Retail connect. Read session by the session identifier
GET /payments-service/retail_connect/v1/sessions/session
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| authenticateit_terminal_device | header | Device ticket |
| session_id | string | Required: Session id |
Example Response. init status
{
"code": "16c164bb56e2d2a9696fa052f5e9d19aee311ab5baf0efbf3484034ce52ea1e6726fd7a0f95607782764e62d322095837b9a4dcedb7e2405046cfc944dae3ce1dd06b8869a6f44eeaee09468388e31b8e0ace71dcb73664605cb29a5dfe3865764191b72c61f373e3a8b7a2412ab58284f188b20dd13522a6b4177175eef7e06c293d5ca9cd64f264d4fcea55e9fde016aff90b12653612c875fd7870913dcef5",
"code_hash": "f2a9f545f3159eb4f1ead3df8a2c1e984628ebe2",
"coin_price": {
"price": 6.1479999999999994e-21,
"timeout_sec": 120,
"ts": "2023-05-02T03:00:32Z"
},
"create_ts": "2023-05-02T02:57:29Z",
"currency": "aud",
"device_id": "735879621218609:a5ed8e8f-98bc-4c6a-a00a-2222db146808",
"id": "urn:authenticateit:retail_connect:session:a84a4c8a-de3c-4dfd-bc62-8a563af97e38",
"is_expired": false,
"loyalty_program": {
"bgcolor": "#ED1010",
"coin_payments_rule": {
"currency_value": 2,
"type": "currency_value"
},
"country": "036",
"created_at": "2023-05-01T08:49:48Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"id": "14abbf9c-7883-4aef-89b9-7310c320ef8d",
"image_big": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"image_small": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"level_up": [
{
"level_id": "casual",
"rules": []
},
{
"level_id": "regular",
"rules": [
{
"period_days": 9,
"purchases": 22,
"type": "purchases_count"
},
{
"period_days": 21,
"type": "spends",
"value_aud": 60
}
]
},
{
"level_id": "vip",
"rules": [
{
"period_days": 2,
"purchases": 10,
"type": "purchases_count"
},
{
"period_days": 2,
"type": "spends",
"value_aud": 10
}
]
}
],
"name": "NovaStore",
"rebate": [
{
"level_id": "casual",
"rebate_percents": 15
},
{
"level_id": "regular",
"rebate_percents": 25
},
{
"level_id": "vip",
"rebate_percents": 33
}
],
"type": "custom",
"user_level": "casual"
},
"operator_id": "urn:authenticateit:user:email:ethertest3@mailinator.com",
"participant_id": "urn:authenticateit:participant:735879621218609",
"status": "init",
"status_side": "terminal",
"timeout": 1800,
"type": "retail_connect_session",
"update_ts": "2023-05-02T02:57:29Z",
"user_id": "urn:authenticateit:user:email:shping:9cc2a816-2897-4858-be3d-71abd8d6c1b8"
}
Example Response. rebate_set status
{
"code": "16c164bb56e2d2a9696fa052f5e9d19aee311ab5baf0efbf3484034ce52ea1e6726fd7a0f95607782764e62d322095837b9a4dcedb7e2405046cfc944dae3ce1dd06b8869a6f44eeaee09468388e31b8e0ace71dcb73664605cb29a5dfe3865764191b72c61f373e3a8b7a2412ab58284f188b20dd13522a6b4177175eef7e06c293d5ca9cd64f264d4fcea55e9fde016aff90b12653612c875fd7870913dcef5",
"code_hash": "f2a9f545f3159eb4f1ead3df8a2c1e984628ebe2",
"coin_price": {
"price": 6.145e-21,
"timeout_sec": 120,
"ts": "2023-05-02T03:07:31Z"
},
"create_ts": "2023-05-02T02:57:29Z",
"currency": "aud",
"device_id": "735879621218609:a5ed8e8f-98bc-4c6a-a00a-2222db146808",
"id": "urn:authenticateit:retail_connect:session:a84a4c8a-de3c-4dfd-bc62-8a563af97e38",
"is_expired": false,
"loyalty_program": {
"bgcolor": "#ED1010",
"coin_payments_rule": {
"currency_value": 200,
"type": "currency_value"
},
"country": "036",
"created_at": "2023-05-01T08:49:48Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"id": "14abbf9c-7883-4aef-89b9-7310c320ef8d",
"image_big": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"image_small": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"level_up": [
{
"level_id": "casual",
"rules": []
},
{
"level_id": "regular",
"rules": [
{
"period_days": 9,
"purchases": 22,
"type": "purchases_count"
},
{
"period_days": 21,
"type": "spends",
"value_aud": 60
}
]
},
{
"level_id": "vip",
"rules": [
{
"period_days": 2,
"purchases": 10,
"type": "purchases_count"
},
{
"period_days": 2,
"type": "spends",
"value_aud": 10
}
]
}
],
"name": "NovaStore",
"rebate": [
{
"level_id": "casual",
"rebate_percents": 15
},
{
"level_id": "regular",
"rebate_percents": 25
},
{
"level_id": "vip",
"rebate_percents": 33
}
],
"type": "custom",
"user_level": "casual"
},
"operator_id": "urn:authenticateit:user:email:ethertest3@mailinator.com",
"participant_id": "urn:authenticateit:participant:735879621218609",
"status": "rebate_set",
"status_side": "terminal",
"statuses": {
"amount_set": {
"amount_value": 1000,
"payment_method": "cash",
"status": "amount_set",
"ts": "2023-05-02T03:04:58.413407298Z"
},
"payment_confirm": {
"status": "payment_confirm",
"ts": "2023-05-02T03:16:14.467349388Z"
},
"payment_set": {
"payment_coins": "158000000000000000000",
"payment_reference": null,
"payment_result": {
"charge_id": null,
"status": "success"
},
"payment_value": 934,
"status": "payment_set",
"transaction": {
"action": "retail_connect",
"coins": "158000000000000000000",
"coins_prices": {
"aud": 6.145e-21
},
"currency": "aud",
"id": "urn:authenticateit:transaction_request:01edf3af-2a91-4f57-95cf-48753ad15cdc",
"owner": "urn:authenticateit:user:email:shping:9cc2a816-2897-4858-be3d-71abd8d6c1b8",
"profile_coins": "4327000000000000000000",
"session_id": "urn:authenticateit:retail_connect:session:a84a4c8a-de3c-4dfd-bc62-8a563af97e38",
"ts": "2023-05-02T03:09:17Z",
"type": "transaction_request"
},
"ts": "2023-05-02T03:09:17.296505840Z"
},
"rebate_set": {
"coins_rebate": "244100800000000000000",
"status": "rebate_set",
"ts": "2023-05-02T03:16:14.467381530Z"
}
},
"timeout": 1800,
"type": "retail_connect_session",
"update_ts": "2023-05-02T02:57:29Z",
"user_id": "urn:authenticateit:user:email:shping:9cc2a816-2897-4858-be3d-71abd8d6c1b8"
}
Retail connect. Update session from user
The method allows user to update active session
PUT /payments-service/retail_connect/v1/sessions/session/update/user
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| session_id | string | Required: Session id |
| status_metadata | object | Required: Update status data |
If payment_method is cash then payment_reference should be null.
If payment_method is cashless then payment_reference value will be validated.
Example Request. Set payment
{
"session_id": "urn:authenticateit:retail_connect:session:a84a4c8a-de3c-4dfd-bc62-8a563af97e38",
"status_metadata": {
"status": "payment_set",
"payment_reference": null,
"payment_value": 934,
"payment_coins": "158000000000000000000"
}
}
Example Response. Set payment
{
"code": "16c164bb56e2d2a9696fa052f5e9d19aee311ab5baf0efbf3484034ce52ea1e6726fd7a0f95607782764e62d322095837b9a4dcedb7e2405046cfc944dae3ce1dd06b8869a6f44eeaee09468388e31b8e0ace71dcb73664605cb29a5dfe3865764191b72c61f373e3a8b7a2412ab58284f188b20dd13522a6b4177175eef7e06c293d5ca9cd64f264d4fcea55e9fde016aff90b12653612c875fd7870913dcef5",
"code_hash": "f2a9f545f3159eb4f1ead3df8a2c1e984628ebe2",
"coin_price": {
"price": 6.145e-21,
"timeout_sec": 120,
"ts": "2023-05-02T03:07:31Z"
},
"create_ts": "2023-05-02T02:57:29Z",
"currency": "aud",
"device_id": "735879621218609:a5ed8e8f-98bc-4c6a-a00a-2222db146808",
"id": "urn:authenticateit:retail_connect:session:a84a4c8a-de3c-4dfd-bc62-8a563af97e38",
"is_expired": false,
"loyalty_program": {
"bgcolor": "#ED1010",
"coin_payments_rule": {
"currency_value": 200,
"type": "currency_value"
},
"country": "036",
"created_at": "2023-05-01T08:49:48Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"id": "14abbf9c-7883-4aef-89b9-7310c320ef8d",
"image_big": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"image_small": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"level_up": [
{
"level_id": "casual",
"rules": []
},
{
"level_id": "regular",
"rules": [
{
"period_days": 9,
"purchases": 22,
"type": "purchases_count"
},
{
"period_days": 21,
"type": "spends",
"value_aud": 60
}
]
},
{
"level_id": "vip",
"rules": [
{
"period_days": 2,
"purchases": 10,
"type": "purchases_count"
},
{
"period_days": 2,
"type": "spends",
"value_aud": 10
}
]
}
],
"name": "NovaStore",
"rebate": [
{
"level_id": "casual",
"rebate_percents": 15
},
{
"level_id": "regular",
"rebate_percents": 25
},
{
"level_id": "vip",
"rebate_percents": 33
}
],
"type": "custom",
"user_level": "casual"
},
"operator_id": "urn:authenticateit:user:email:ethertest3@mailinator.com",
"participant_id": "urn:authenticateit:participant:735879621218609",
"status": "payment_set",
"status_side": "user",
"statuses": {
"amount_set": {
"amount_value": 1000,
"payment_method": "cash",
"status": "amount_set",
"ts": "2023-05-02T03:04:58.413407298Z"
},
"payment_set": {
"payment_coins": "158000000000000000000",
"payment_reference": null,
"payment_result": {
"charge_id": null,
"status": "success"
},
"payment_value": 934,
"status": "payment_set",
"transaction": {
"action": "retail_connect",
"coins": "158000000000000000000",
"coins_prices": {
"aud": 6.145e-21
},
"currency": "aud",
"id": "urn:authenticateit:transaction_request:01edf3af-2a91-4f57-95cf-48753ad15cdc",
"owner": "urn:authenticateit:user:email:shping:9cc2a816-2897-4858-be3d-71abd8d6c1b8",
"profile_coins": "4327000000000000000000",
"session_id": "urn:authenticateit:retail_connect:session:a84a4c8a-de3c-4dfd-bc62-8a563af97e38",
"ts": "2023-05-02T03:09:17Z",
"type": "transaction_request"
},
"ts": "2023-05-02T03:09:17.296505840Z"
}
},
"timeout": 1800,
"type": "retail_connect_session",
"update_ts": "2023-05-02T02:57:29Z",
"user_id": "urn:authenticateit:user:email:shping:9cc2a816-2897-4858-be3d-71abd8d6c1b8"
}
Example Request. Terminate session
{
"session_id": "urn:authenticateit:retail_connect:session:da9130c0-ceb4-4a6d-891a-f844588cc5fe",
"status_metadata": {
"status": "terminate"
}
}
Example Response. Terminate session
{
"code": "188890a18017db9e1f8daf2ad08be13f316fa5e0bdf59f15b90e2b0a945359ac746e2762db86af213e387357c050c67b24a051d68e8ae53ef7479c12bf76563d4a371134d684ca0634ccc045edf56589417fef4a76a5b053483322c7361d3b4d7e0b5487357fe3ebbc865c25f2acaf9131bb8c9a720172d453ef9970f25a3b35e16722622dd7cba767e96b6e4a49ac66e9db1bf388b802c2193c092c8fb395199",
"code_hash": "04d15508e2a33a4726e379280f894176cdec4fd8",
"coin_price": {
"price": 4.85e-21,
"timeout_sec": 120,
"ts": "2023-04-12T06:40:07Z"
},
"create_ts": "2023-04-12T06:35:24Z",
"currency": "usd",
"device_id": "735879621218609:a5ed8e8f-98bc-4c6a-a00a-2222db146808",
"id": "urn:authenticateit:retail_connect:session:63b25c75-5244-4a7f-8f7c-7e3d88c7a30e",
"is_expired": false,
"loyalty_program": {
"bgcolor": "#FFFFFF",
"country": "643",
"created_at": "2023-04-03T06:57:06Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"id": "e300d398-19b5-4918-8d1a-88426e7a026f",
"image_big": "https://dev-cdn.shping.com/2023/4/6/d3fb8c0a-d272-4716-a0c9-ca6caccd5ec9.png",
"image_small": "https://dev-cdn.shping.com/2023/4/6/d3fb8c0a-d272-4716-a0c9-ca6caccd5ec9.png",
"level_up": [
{
"level_id": "casual",
"rules": []
},
{
"level_id": "regular",
"rules": [
{
"period_days": 9,
"purchases": 22,
"type": "purchases_count"
},
{
"period_days": 21,
"type": "spends",
"value_aud": 60
}
]
},
{
"level_id": "vip",
"rules": [
{
"period_days": 2,
"purchases": 10,
"type": "purchases_count"
},
{
"period_days": 2,
"type": "spends",
"value_aud": 10
}
]
}
],
"name": "Custom loyalty program 1",
"rebate": [
{
"level_id": "casual",
"rebate_percents": 0
},
{
"level_id": "regular",
"rebate_percents": 5
},
{
"level_id": "vip",
"rebate_percents": 6
}
],
"type": "custom"
},
"operator_id": "urn:authenticateit:user:email:ethertest3@mailinator.com",
"participant_id": "urn:authenticateit:participant:735879621218609",
"status": "terminate",
"status_side": "user",
"statuses": {
"terminate": {
"status": "terminate",
"ts": "2023-04-12T06:40:07.540435609Z"
}
},
"timeout": 1800,
"type": "retail_connect_session",
"update_ts": "2023-04-12T06:35:24Z",
"user_id": "urn:authenticateit:user:email:shping:9cc2a816-2897-4858-be3d-71abd8d6c1b8"
}
Retail connect. Update session from terminal
The method allows terminal to update active session
PUT /payments-service/retail_connect/v1/sessions/session/update/terminal
Parameters
| Name | Type | Description |
|---|---|---|
| authenticateit_identity_ticket | header | Required: Session's ticket |
| authenticateit_terminal_device | header | Required: Device ticket |
| session_id | string | Required: Session id |
| status_metadata | object | Required: Update status data |
Example Request. Set payment_confirm
{
"session_id": "urn:authenticateit:retail_connect:session:a84a4c8a-de3c-4dfd-bc62-8a563af97e38",
"status_metadata": {
"status": "payment_confirm"
}
}
Example Response. Set payment_confirm
{
"code": "16c164bb56e2d2a9696fa052f5e9d19aee311ab5baf0efbf3484034ce52ea1e6726fd7a0f95607782764e62d322095837b9a4dcedb7e2405046cfc944dae3ce1dd06b8869a6f44eeaee09468388e31b8e0ace71dcb73664605cb29a5dfe3865764191b72c61f373e3a8b7a2412ab58284f188b20dd13522a6b4177175eef7e06c293d5ca9cd64f264d4fcea55e9fde016aff90b12653612c875fd7870913dcef5",
"code_hash": "f2a9f545f3159eb4f1ead3df8a2c1e984628ebe2",
"coin_price": {
"price": 6.145e-21,
"timeout_sec": 120,
"ts": "2023-05-02T03:07:31Z"
},
"create_ts": "2023-05-02T02:57:29Z",
"currency": "aud",
"device_id": "735879621218609:a5ed8e8f-98bc-4c6a-a00a-2222db146808",
"id": "urn:authenticateit:retail_connect:session:a84a4c8a-de3c-4dfd-bc62-8a563af97e38",
"is_expired": false,
"loyalty_program": {
"bgcolor": "#ED1010",
"coin_payments_rule": {
"currency_value": 200,
"type": "currency_value"
},
"country": "036",
"created_at": "2023-05-01T08:49:48Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"id": "14abbf9c-7883-4aef-89b9-7310c320ef8d",
"image_big": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"image_small": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"level_up": [
{
"level_id": "casual",
"rules": []
},
{
"level_id": "regular",
"rules": [
{
"period_days": 9,
"purchases": 22,
"type": "purchases_count"
},
{
"period_days": 21,
"type": "spends",
"value_aud": 60
}
]
},
{
"level_id": "vip",
"rules": [
{
"period_days": 2,
"purchases": 10,
"type": "purchases_count"
},
{
"period_days": 2,
"type": "spends",
"value_aud": 10
}
]
}
],
"name": "NovaStore",
"rebate": [
{
"level_id": "casual",
"rebate_percents": 15
},
{
"level_id": "regular",
"rebate_percents": 25
},
{
"level_id": "vip",
"rebate_percents": 33
}
],
"type": "custom",
"user_level": "casual"
},
"operator_id": "urn:authenticateit:user:email:ethertest3@mailinator.com",
"participant_id": "urn:authenticateit:participant:735879621218609",
"status": "rebate_set",
"status_side": "terminal",
"statuses": {
"amount_set": {
"amount_value": 1000,
"payment_method": "cash",
"status": "amount_set",
"ts": "2023-05-02T03:04:58.413407298Z"
},
"payment_confirm": {
"status": "payment_confirm",
"ts": "2023-05-02T03:16:14.467349388Z"
},
"payment_set": {
"payment_coins": "158000000000000000000",
"payment_reference": null,
"payment_result": {
"charge_id": null,
"status": "success"
},
"payment_value": 934,
"status": "payment_set",
"transaction": {
"action": "retail_connect",
"coins": "158000000000000000000",
"coins_prices": {
"aud": 6.145e-21
},
"currency": "aud",
"id": "urn:authenticateit:transaction_request:01edf3af-2a91-4f57-95cf-48753ad15cdc",
"owner": "urn:authenticateit:user:email:shping:9cc2a816-2897-4858-be3d-71abd8d6c1b8",
"profile_coins": "4327000000000000000000",
"session_id": "urn:authenticateit:retail_connect:session:a84a4c8a-de3c-4dfd-bc62-8a563af97e38",
"ts": "2023-05-02T03:09:17Z",
"type": "transaction_request"
},
"ts": "2023-05-02T03:09:17.296505840Z"
},
"rebate_set": {
"coins_rebate": "244100800000000000000",
"status": "rebate_set",
"ts": "2023-05-02T03:16:14.467381530Z"
}
},
"timeout": 1800,
"type": "retail_connect_session",
"update_ts": "2023-05-02T02:57:29Z",
"user_id": "urn:authenticateit:user:email:shping:9cc2a816-2897-4858-be3d-71abd8d6c1b8"
}
Example Request. Set amount_value and cash payment_method
{
"session_id": "urn:authenticateit:retail_connect:session:a84a4c8a-de3c-4dfd-bc62-8a563af97e38",
"status_metadata": {
"status": "amount_set",
"payment_method": "cash",
"amount_value": 1000
}
}
Example Request. Set amount_value and cashless payment_method
{
"session_id": "urn:authenticateit:retail_connect:session:a84a4c8a-de3c-4dfd-bc62-8a563af97e38",
"status_metadata": {
"status": "amount_set",
"payment_method": "cashless",
"amount_value": 1000
}
}
Example Response. Set amount_value and cash payment_method
{
"code": "16c164bb56e2d2a9696fa052f5e9d19aee311ab5baf0efbf3484034ce52ea1e6726fd7a0f95607782764e62d322095837b9a4dcedb7e2405046cfc944dae3ce1dd06b8869a6f44eeaee09468388e31b8e0ace71dcb73664605cb29a5dfe3865764191b72c61f373e3a8b7a2412ab58284f188b20dd13522a6b4177175eef7e06c293d5ca9cd64f264d4fcea55e9fde016aff90b12653612c875fd7870913dcef5",
"code_hash": "f2a9f545f3159eb4f1ead3df8a2c1e984628ebe2",
"coin_price": {
"price": 6.145e-21,
"timeout_sec": 120,
"ts": "2023-05-02T03:04:58Z"
},
"create_ts": "2023-05-02T02:57:29Z",
"currency": "aud",
"device_id": "735879621218609:a5ed8e8f-98bc-4c6a-a00a-2222db146808",
"id": "urn:authenticateit:retail_connect:session:a84a4c8a-de3c-4dfd-bc62-8a563af97e38",
"is_expired": false,
"loyalty_program": {
"bgcolor": "#ED1010",
"coin_payments_rule": {
"currency_value": 200,
"type": "currency_value"
},
"country": "036",
"created_at": "2023-05-01T08:49:48Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"id": "14abbf9c-7883-4aef-89b9-7310c320ef8d",
"image_big": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"image_small": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"level_up": [
{
"level_id": "casual",
"rules": []
},
{
"level_id": "regular",
"rules": [
{
"period_days": 9,
"purchases": 22,
"type": "purchases_count"
},
{
"period_days": 21,
"type": "spends",
"value_aud": 60
}
]
},
{
"level_id": "vip",
"rules": [
{
"period_days": 2,
"purchases": 10,
"type": "purchases_count"
},
{
"period_days": 2,
"type": "spends",
"value_aud": 10
}
]
}
],
"name": "NovaStore",
"rebate": [
{
"level_id": "casual",
"rebate_percents": 15
},
{
"level_id": "regular",
"rebate_percents": 25
},
{
"level_id": "vip",
"rebate_percents": 33
}
],
"type": "custom",
"user_level": "casual"
},
"operator_id": "urn:authenticateit:user:email:ethertest3@mailinator.com",
"participant_id": "urn:authenticateit:participant:735879621218609",
"status": "amount_set",
"status_side": "terminal",
"statuses": {
"amount_set": {
"amount_value": 1000,
"payment_method": "cash",
"status": "amount_set",
"ts": "2023-05-02T03:04:58.413407298Z"
}
},
"timeout": 1800,
"type": "retail_connect_session",
"update_ts": "2023-05-02T02:57:29Z",
"user_id": "urn:authenticateit:user:email:shping:9cc2a816-2897-4858-be3d-71abd8d6c1b8"
}
Example Request. Terminate session
{
"session_id": "urn:authenticateit:retail_connect:session:da9130c0-ceb4-4a6d-891a-f844588cc5fe",
"status_metadata": {
"status": "terminate"
}
}
Example Response. Terminate session
{
"code": "1634d32d0d742de3009fabd40e58db08a81666165e199c194979244e1d3e18a7856e9ff27bfab1e47ac73c80dff8d4f25d340b58554f4d975ace82eafc0618dacf006161f7592fbdc3ea5bc823546fe133ad98d58d431558c4c88287633e44179a6394603de4a04fb2699edf61092b444a1fde92a3fb464a172a2c20b36a7cd3fdd2fc2b9f027e893f6fa80adb0ba610112c1708107a4483e642b97d300830a1c",
"code_hash": "bc07fed57474f2dd096d1088799a164f6aa5818a",
"coin_price": {
"price": 4.85e-21,
"timeout_sec": 120,
"ts": "2023-04-12T06:44:48Z"
},
"create_ts": "2023-04-12T06:44:48Z",
"currency": "usd",
"device_id": "735879621218609:a5ed8e8f-98bc-4c6a-a00a-2222db146808",
"id": "urn:authenticateit:retail_connect:session:bbe5a966-0e6c-4e79-bff1-dbab0183d2d4",
"is_expired": false,
"loyalty_program": {
"bgcolor": "#FFFFFF",
"country": "643",
"created_at": "2023-04-03T06:57:06Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"id": "e300d398-19b5-4918-8d1a-88426e7a026f",
"image_big": "https://dev-cdn.shping.com/2023/4/6/d3fb8c0a-d272-4716-a0c9-ca6caccd5ec9.png",
"image_small": "https://dev-cdn.shping.com/2023/4/6/d3fb8c0a-d272-4716-a0c9-ca6caccd5ec9.png",
"level_up": [
{
"level_id": "casual",
"rules": []
},
{
"level_id": "regular",
"rules": [
{
"period_days": 9,
"purchases": 22,
"type": "purchases_count"
},
{
"period_days": 21,
"type": "spends",
"value_aud": 60
}
]
},
{
"level_id": "vip",
"rules": [
{
"period_days": 2,
"purchases": 10,
"type": "purchases_count"
},
{
"period_days": 2,
"type": "spends",
"value_aud": 10
}
]
}
],
"name": "Custom loyalty program 1",
"rebate": [
{
"level_id": "casual",
"rebate_percents": 0
},
{
"level_id": "regular",
"rebate_percents": 5
},
{
"level_id": "vip",
"rebate_percents": 6
}
],
"type": "custom"
},
"operator_id": "urn:authenticateit:user:email:ethertest3@mailinator.com",
"participant_id": "urn:authenticateit:participant:735879621218609",
"status": "terminate",
"status_side": "terminal",
"statuses": {
"terminate": {
"status": "terminate",
"ts": "2023-04-12T06:45:51.859931409Z"
}
},
"timeout": 1800,
"type": "retail_connect_session",
"update_ts": "2023-04-12T06:44:48Z",
"user_id": "urn:authenticateit:user:email:shping:9cc2a816-2897-4858-be3d-71abd8d6c1b8"
}