TransferWallet API

TransferWallet API is an optional API for implementing Transfer Wallet logic, which is available by request. The API provides a way for the Operator to deposit money to the user's account, withdraw money from the user's account and get the user's balance. Availability of TransferWallet API is per request.

TransferWallet API Reference

Withdraw money from user's wallet


POST /operator/generic/v2/transfer_wallet/withdraw HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "user": "text",
  "transaction_uuid": "16d2dcfe-b89e-11e7-854a-58404eea6d16",
  "sub_partner_id": "my-platform-id",
  "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af",
  "product": "OneTouch",
  "operator_id": 1,
  "currency": "EUR",
  "amount": 100500
}
								

Withdraw money from the user's wallet.

Header parameters
  • uX-Nirova-Signature - any · required

    • RSA-SHA256 is used to sign the request body using the private key. The signature is validated using the public key associated with the provided operator_id.

Body
  • user - string · required

  • transaction_uuid - string · required

    • The unique transaction identifier. Must be stored for at least 4 months for reconciliation purposes. Should not be processed more than once.

    • Example: 16d2dcfe-b89e-11e7-854a-58404eea6d16

  • sub_partner_id - string · optional

    • ID of Operator's sub-partner (brand, whitelabel, site, etc.) using the same integration and credentials. A single site (sub_partner_id) cannot use both TransferWallet and SeamlessWallet simultaneously.

    • Example: my-platform-id

  • request_uuid - string · required

    • ID generated for each call to the Operator, used for debugging and synchronization. Must be responded with the same ID.

    • Example: 583c985f-fee6-4c0e-bbf5-308aad6265af

  • product - string · required

    • Name of the Game Provider.

    • Example: OneTouch

  • operator_id - integer · required

    • Unique identifier for the Operator in the Nirova system. Used for authorization of incoming requests. Obtainable from the Nirova BackOffice.

    • Example: 1

  • currency - string · enum · required

    • ISO 4217 currency code. Available options vary by Provider. Contact us for details.

    • Example: EUR

    • Available options: BSD, TTD, ZMW, BMD, USD, BYR, UGX, HKD, MGA, GIP, UZS, MKD, PTS, mLTC, EGP, AWG, CZK, ILS, MZN, TND, XPF, SOS, DOP, RUB, KRW, BTN, KGS, BAM, AOA, SOC, AMS, BND, RSD, FKP, PEN, EOS, GHS, JPY, TRY, SBD, UAH, LTL, FJD, GNF, MDL, AFN, ZAR, MOP, TJS, BOB, JMD, QAR, IRR, SYP, XXX, NAD, MYR, CUP, NOK, BGN, KPW, MNT, NZD, uETH, SGD, PYG, OMR, DZD, EUR, TMT, MMK, PTQ, ANG, TZS, CRC, CVE, SET, BTH, BZD, LYD, CHF, MVR, KES, CVE, LSL, KMF, SZL, KYD, BRL, AED, WST, YER, ALL, TRX, HUF, GTQ, uBTC, IDR, MWK, CUC, DKK, TWD, XCD, BBD, LRD, KZT, JOD, BYN, BIF, PLN, SDG, VUV, SEK, BDT, HNL, BWP, VND, ISK, SLL, BHD, HTG, USDt, ADA, MUR, ERN, uLTC, LKR, COP, GEL, AUD, GBP, CAD, PHP, PAB, DJF, GMD, PKR, NIO, AMD, RWF, RON, NGN, TOP, UYU, AZN, SRD, KWD, PGK, CDF, SAR, IQD, XRP, SCR, mETH, MAD, GYD, INR, LBP, ARS, MXN, CLP, BNB, CNY, KHR, LAK, HRK, BZD, SSP, XOF, XAF, MRU, NPR, mBTC

  • amount - integer · required

    • The amount of money in integer (Int64) format. Real value multiplied by 100000.

    • Example: 100500 (represents 1.005)

  • Available options: BSD, TTD, ZMW, BMD, USD, BYR, UGX, HKD, MGA, GIP, UZS, MKD, PTS, mLTC, EGP, AWG, CZK, ILS, MZN, TND, XPF, SOS, DOP, RUB, KRW, BTN, KGS, BAM, AOA, SOC, AMS, BND, RSD, FKP, PEN, EOS, GHS, JPY, TRY, SBD, UAH, LTL, FJD, GNF, MDL, AFN, ZAR, MOP, TJS, BOB, JMD, QAR, IRR, SYP, XXX, NAD, MYR, CUP, NOK, BGN, KPW, MNT, NZD, uETH, SGD, PYG, OMR, DZD, EUR, TMT, MMK, PTQ, ANG, TZS, CRC, CVE, SET, BTH, BZD, LYD, CHF, MVR, KES, CVE, LSL, KMF, SZL, KYD, BRL, AED, WST, YER, ALL, TRX, HUF, GTQ, uBTC, IDR, MWK, CUC, DKK, TWD, XCD, BBD, LRD, KZT, JOD, BYN, BIF, PLN, SDG, VUV, SEK, BDT, HNL, BWP, VND, ISK, SLL, BHD, HTG, USDt, ADA, MUR, ERN, uLTC, LKR, COP, GEL, AUD, GBP, CAD, PHP, PAB, DJF, GMD, PKR, NIO, AMD, RWF, RON, NGN, TOP, UYU, AZN, SRD, KWD, PGK, CDF, SAR, IQD, XRP, SCR, mETH, MAD, GYD, INR, LBP, ARS, MXN, CLP, BNB, CNY, KHR, LAK, HRK, BZD, SSP, XOF, XAF, MRU, NPR, mBTC

  • Responses
    {
      "user": "Jimm123",
      "status": "RS_OK",
      "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af",
      "currency": "USD",
      "balance": 100500
    }

    Deposit money to user's wallet

    
    POST /operator/generic/v2/transfer_wallet/deposit HTTP/1.1
    Host: 
    Content-Type: application/json
    Accept: */*
    Content-Length: 229
    
    {
      "user": "text",
      "transaction_uuid": "16d2dcfe-b89e-11e7-854a-58404eea6d16",
      "sub_partner_id": "my-platform-id",
      "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af",
      "product": "OneTouch",
      "operator_id": 1,
      "currency": "EUR",
      "amount": 100500
    }
    								

    Add and deposit money to the user's wallet.

    Header parameters
    • uX-Nirova-Signature - any · required

      • RSA-SHA256 is used to sign the request body using the private key. The signature is validated using the public key associated with the provided operator_id.

    Body
    • user - string · required

    • transaction_uuid - string · required

      • The unique transaction identifier. Must be stored for at least 4 months for reconciliation purposes. Each transaction_uuid must be processed only once.

      • Example: 16d2dcfe-b89e-11e7-854a-58404eea6d16

    • sub_partner_id - string · optional

      • ID of Operator’s sub-partner (brand, whitelabel, site, etc.) that uses the same integration and credentials. A site cannot mix TransferWallet and SeamlessWallet types simultaneously.

      • Example: my-platform-id

    • request_uuid - string · required

      • ID generated for each call to the Operator for debugging and synchronization. Must respond with the same request_uuid received.

      • Example: 583c985f-fee6-4c0e-bbf5-308aad6265af

    • product - string · required

      • Name of the Game Provider.

      • Example: OneTouch

    • operator_id - integer · required

      • Unique identifier for the Operator in the Nirova system. Available in the Nirova BackOffice after setup.

      • Example: 1

    • currency - string · enum · required

      • ISO 4217 currency code. Supported currencies may vary by Provider. Contact us for more information.

      • Example: EUR

    • amount - integer · required

      • The amount is displayed in integer (Int64) format. Real value is multiplied by 100000. For example, $3.56 is represented as 356000.

      • Example: 100500

    Responses
    {
      "user": "Jimm123",
      "status": "RS_OK",
      "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af",
      "currency": "USD",
      "balance": 100500
    }

    Create a wallet

    
    POST /operator/generic/v2/transfer_wallet/create_wallet HTTP/1.1
    Host: 
    Content-Type: application/json
    Accept: */*
    Content-Length: 155
    
    {
      "user": "text",
      "sub_partner_id": "my-platform-id",
      "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af",
      "product": "OneTouch",
      "operator_id": 1,
      "currency": "EUR"
    }
    								

    Create a wallet. A TransferWallet can be either a Universal type or a Product type. Universal Wallet means that the user will have only one wallet for all Providers/Suppliers. Product Wallet means that the User will have several wallets, one per each product (Provider/Supplier).

    Header parameters
    • uX-Nirova-Signature - any · required

      • RSA-SHA256 is used to sign the request body using the private key. The signature is validated using the public key associated with the provided operator_id.

    Body
    • user - string · required

    • sub_partner_id - string · optional

      • ID of Operator’s sub-partner (brand, whitelabel, site, etc.) using the same integration and credentials. A site cannot use both TransferWallet and SeamlessWallet types simultaneously.

      • Example: my-platform-id

    • request_uuid - string · required

      • An ID generated for each call to the Operator for debugging and synchronization. Must respond with the same request_uuid received.

      • Example: 583c985f-fee6-4c0e-bbf5-308aad6265af

    • product - string · required

      • Name of the Game Provider.

      • Example: OneTouch

    • operator_id - integer · required

      • Unique identifier for the Operator in the Nirova system. Available after registration and setup by Nirova teams.

      • Example: 1

    • currency - string · enum · required

      • ISO 4217 currency code. Supported currencies may vary by Provider. Contact us for specific support details.

      • Example: EUR

      • Available options: BSD, TTD, ZMW, BMD, USD, BYR, UGX, HKD, MGA, GIP, UZS, MKD, PTS, mLTC, EGP, AWG, CZK, ILS, MZN, TND, XPF, SOS, DOP, RUB, KRW, BTN, KGS, BAM, AOA, SOC, AMS, BND, RSD, FKP, PEN, EOS, GHS, JPY, TRY, SBD, UAH, LTL, FJD, GNF, MDL, AFN, ZAR, MOP, TJS, BOB, JMD, QAR, IRR, SYP, XXX, NAD, MYR, CUP, NOK, BGN, KPW, MNT, NZD, uETH, SGD, PYG, OMR, DZD, EUR, TMT, MMK, PTQ, ANG, TZS, CRC, CVE, SET, BTH, BZD, LYD, CHF, MVR, KES, CVE, LSL, KMF, SZL, KYD, BRL, AED, WST, YER, ALL, TRX, HUF, GTQ, uBTC, IDR, MWK, CUC, DKK, TWD, XCD, BBD, LRD, KZT, JOD, BYN, BIF, PLN, SDG, VUV, SEK, BDT, HNL, BWP, VND, ISK, SLL, BHD, HTG, USDt, ADA, MUR, ERN, uLTC, LKR, COP, GEL, AUD, GBP, CAD, PHP, PAB, DJF, GMD, PKR, NIO, AMD, RWF, RON, NGN, TOP, UYU, AZN, SRD, KWD, PGK, CDF, SAR, IQD, XRP, SCR, mETH, MAD, GYD, INR, LBP, ARS, MXN, CLP, BNB, CNY, KHR, LAK, HRK, BZD, SSP, XOF, XAF, MRU, NPR, mBTC

    Responses
    {
      "user": "Jimm123",
      "status": "RS_OK",
      "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af",
      "currency": "USD",
      "balance": 100500
    }

    Get wallet status

    
    POST /operator/generic/v2/transfer_wallet/check_transfer HTTP/1.1
    Host: 
    Content-Type: application/json
    Accept: */*
    Content-Length: 213
    
    {
      "user": "text",
      "transaction_uuid": "16d2dcfe-b89e-11e7-854a-58404eea6d16",
      "sub_partner_id": "my-platform-id",
      "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af",
      "product": "OneTouch",
      "operator_id": 1,
      "currency": "EUR"
    }
    								

    The endpoint to check the status of the TransferWallet transactions(deposit/withdraw). If a transaction doesn't exist in the Nirova system a RS_ERROR_TRANSACTION_DOES_NOT_EXIST status will be returned.

    Header parameters
    • uX-Nirova-Signature - any · required

      • RSA-SHA256 is used to sign the request body using the private key. The signature is validated using the public key associated with the provided operator_id.

    Body
    • user - string · required

    • transaction_uuid - string · required

      • Unique transaction identifier. Must be stored on both sides for at least 4 months for reconciliation. Must not process the same transaction_uuid more than once.

      • Example: 16d2dcfe-b89e-11e7-854a-58404eea6d16

    • sub_partner_id - string · required

      • ID of the Operator’s sub-partner (brand, whitelabel, site, etc.). Cannot use both TransferWallet and SeamlessWallet integration types at the same time.

      • Example: my-platform-id

    • request_uuid - string · required

      • An ID generated for each call to the Operator for synchronization and debugging. Must respond with the same request_uuid received.

      • Example: 583c985f-fee6-4c0e-bbf5-308aad6265af

    • product - string · optional

      • Name of the Game Provider.

      • Example: OneTouch

    • operator_id - integer · required

      • Unique identifier for the Operator in the Nirova system. Provided upon registration and setup.

      • Example: 1

    • currency - string · enum · required

      • ISO 4217 currency code. Supported currencies may vary by Provider. Contact support for details.

      • Example: EUR

      • Available options: BSD, TTD, ZMW, BMD, USD, BYR, UGX, HKD, MGA, GIP, UZS, MKD, PTS, mLTC, EGP, AWG, CZK, ILS, MZN, TND, XPF, SOS, DOP, RUB, KRW, BTN, KGS, BAM, AOA, SOC, AMS, BND, RSD, FKP, PEN, EOS, GHS, JPY, TRY, SBD, UAH, LTL, FJD, GNF, MDL, AFN, ZAR, MOP, TJS, BOB, JMD, QAR, IRR, SYP, XXX, NAD, MYR, CUP, NOK, BGN, KPW, MNT, NZD, uETH, SGD, PYG, OMR, DZD, EUR, TMT, MMK, PTQ, ANG, TZS, CRC, CVE, SET, BTH, BZD, LYD, CHF, MVR, KES, CVE, LSL, KMF, SZL, KYD, BRL, AED, WST, YER, ALL, TRX, HUF, GTQ, uBTC, IDR, MWK, CUC, DKK, TWD, XCD, BBD, LRD, KZT, JOD, BYN, BIF, PLN, SDG, VUV, SEK, BDT, HNL, BWP, VND, ISK, SLL, BHD, HTG, USDt, ADA, MUR, ERN, uLTC, LKR, COP, GEL, AUD, GBP, CAD, PHP, PAB, DJF, GMD, PKR, NIO, AMD, RWF, RON, NGN, TOP, UYU, AZN, SRD, KWD, PGK, CDF, SAR, IQD, XRP, SCR, mETH, MAD, GYD, INR, LBP, ARS, MXN, CLP, BNB, CNY, KHR, LAK, HRK, BZD, SSP, XOF, XAF, MRU, NPR, mBTC

    Responses
    {
      "transaction": {
        "user": "john12345",
        "type": "CTT_WITHDRAW",
        "transaction_uuid": "c3da3b5a-cd7f-4957-86cb-993f56f81f26",
        "status": "CTS_SUCCESS",
        "cuurency": "USD",
        "balance": 0,
        "amount": 1000000
      },
      "status": "RS_OK"
    }

    Get wallet balance

    
    POST /operator/generic/v2/transfer_wallet/balance HTTP/1.1
    Host: 
    Content-Type: application/json
    Accept: */*
    Content-Length: 155
    
    {
      "user": "text",
      "sub_partner_id": "my-platform-id",
      "request_uuid": "583c985f-fee6-4c0e-bbf5-308aad6265af",
      "product": "OneTouch",
      "operator_id": 1,
      "currency": "EUR"
    }
    								

    Get a user's wallet balance.

    Header parameters
    • uX-Nirova-Signature - any · required

      • RSA-SHA256 is used to sign the request body using the private key. The signature is validated using the public key associated with the provided operator_id.

    Body
    • user - string · required

    • sub_partner_id - string · optional

      • ID of Operator's sub-partner (brand, whitelabel, site, etc.). Used for detailed reporting and integration type switching. A single site (sub_partner_id) cannot have both TransferWallet and SeamlessWallet integrations simultaneously.

      • Example: my-platform-id

    • request_uuid - string · required

      • An ID generated for each call to the Operator, used to synchronize Nirova and Operator systems for debugging purposes. Must respond with the same request_uuid received.

      • Example: 583c985f-fee6-4c0e-bbf5-308aad6265af

    • product - string · required

      • Name of the Game Provider.

      • Example: OneTouch

    • operator_id - integer · required

      • Unique identifier for the Operator in Nirova system. Obtained after registration and setup in the Nirova BackOffice.

      • Example: 1

    • currency - string · enum · required

      • The ISO 4217 currency code. Native gameplay support may vary by Provider. Contact support for compatibility details.

      • Example: EUR

      • Available options: BSD, TTD, ZMW, BMD, USD, BYR, UGX, HKD, MGA, GIP, UZS, MKD, PTS, mLTC, EGP, AWG, CZK, ILS, MZN, TND, XPF, SOS, DOP, RUB, KRW, BTN, KGS, BAM, AOA, SOC, AMS, BND, RSD, FKP, PEN, EOS, GHS, JPY, TRY, SBD, UAH, LTL, FJD, GNF, MDL, AFN, ZAR, MOP, TJS, BOB, JMD, QAR, IRR, SYP, XXX, NAD, MYR, CUP, NOK, BGN, KPW, MNT, NZD, uETH, SGD, PYG, OMR, DZD, EUR, TMT, MMK, PTQ, ANG, TZS, CRC, CVE, SET, BTH, BZD, LYD, CHF, MVR, KES, CVE, LSL, KMF, SZL, KYD, BRL, AED, WST, YER, ALL, TRX, HUF, GTQ, uBTC, IDR, MWK, CUC, DKK, TWD, XCD, BBD, LRD, KZT, JOD, BYN, BIF, PLN, SDG, VUV, SEK, BDT, HNL, BWP, VND, ISK, SLL, BHD, HTG, USDt, ADA, MUR, ERN, uLTC, LKR, COP, GEL, AUD, GBP, CAD, PHP, PAB, DJF, GMD, PKR, NIO, AMD, RWF, RON, NGN, TOP, UYU, AZN, SRD, KWD, PGK, CDF, SAR, IQD, XRP, SCR, mETH, MAD, GYD, INR, LBP, ARS, MXN, CLP, BNB, CNY, KHR, LAK, HRK, BZD, SSP, XOF, XAF, MRU, NPR, mBTC

    Responses
    {
      "transaction": {
        "user": "john12345",
        "type": "CTT_WITHDRAW",
        "transaction_uuid": "c3da3b5a-cd7f-4957-86cb-993f56f81f26",
        "status": "CTS_SUCCESS",
        "cuurency": "USD",
        "balance": 0,
        "amount": 1000000
      },
    }