Remuneration/reward transactions

Use Sumsub API to send and receive remuneration/reward data.

Remuneration transactions are usually initiated by payment systems, banks or forex platforms. These transactions are mostly cashbacks, rewards, and leadership bonuses for your users.

Initiate remuneration/reward transaction

Use the type of transaction below to document promotion or cashbacks to specific applicants. The required fields include the following:

{
    "applicant": {
      "externalUserId": "shol1mq8xipghssepfhdht",  //Unique ID number for the applicant in your system
      "fullName": "John Smith",  //If you don't have an applicant you can still put some human-readable info here
      "dob": "1983-02-02"  //Applicant’s date of birth
    },
    "counterparty": {
      "externalUserId": "yzg2lkp7ajqrfb3vem6cd"  //Your company’s fixed ID used to make cashback
    },
    "info": {
      "direction": "in",  //'in' for a deposit, 'out' for withdrawal
      "amount": 2.3, 
      "currencyCode": "USDT",
      "cryptoChain": "BTC",  //We will automatically convert BTC or other currency into your default currency such as USD (there will be amountInDefaultCurrency field)
      "paymentTxnId": "84bf83c10dfddc9d1f0ea6a1a131c638488fb161e819dae25fd8128c671d2d5a",  //Crypto transaction ID from the blockchain. Required for crypto check requests only
      "paymentDetails": "You are the first one in the leaderboard! Congrats!",  //The text added by the user within the payment can be utilized to identify fraudulent/risky guidelines during funds transfer
      "currencyType": "crypto",
      "type": "payroll"  //This is a string, you can use to define the type of your transaction, for these remunerations could be cashback, payroll, bonus
    },
    "props": {
      "category": "e1cf5ce0-5878-4dfd-80ff-24474016e200;WITHDRAW",  //Custom value that can be used in rules
      "partner": "60ee4585-af5c-416b-974e-3a789bc5c8bf",
      "customType": "ADMIN_SEND "
    },
    "txnId": "kkw5mbtuozdwn13qrf9fj",  //Internal transaction ID
    "txnDate": "2023-09-19 14:19:06+0300"   //Transaction date. If the date is not provided, the current date will be used
  }

Check out response

The response contains the info from the created transaction (all attributes) above with additional objects that contain the current review and scoring info of the requested transaction:

{
    "id": "65a920b3c181c8380fc1d96f",
    "applicantId": "65a906b659df1414adf1107b",
    "scope": "events",
    "externalUserId": "dash-2385a803-1cce-46f6-a9f8-675957c0da32",
    "clientId": "clientId",
    "data": {
      "txnId": "kkw5mbtuozdwn13qrf9fj",
      "txnDate": "2023-09-19 11:19:06+0000",
      "applicant": {
        "externalUserId": "dash-2385a803-1cce-46f6-a9f8-675957c0da32",
        "fullName": "John Smith",
        "dob": "1983-02-02",
        "type": "individual"
      },
      "counterparty": {
        "externalUserId": "yzg2lkp7ajqrfb3vem6cd",
        "device": {}
      },
      "type": "finance",
      "info": {
        "paymentTxnId": "84bf83c10dfddc9d1f0ea6a1a131c638488fb161e819dae25fd8128c671d2d5a",
        "type": "payroll",
        "direction": "in",
        "amount": 2.3,
        "currencyCode": "USDT",
        "cryptoChain": "BTC",
        "currencyType": "crypto",
        "amountInDefaultCurrency": 90551.1811023622,
        "defaultCurrencyCode": "EUR",
        "paymentDetails": "You are the first one in the leaderboard! Congrats!"
      },
      "sourceKey": "123",
      "props": {
        "category": "e1cf5ce0-5878-4dfd-80ff-24474016e200;WITHDRAW",
        "partner": "60ee4585-af5c-416b-974e-3a789bc5c8bf",
        "customType": "ADMIN_SEND "
      }
    },
    "score": 0,  //Transaction risk score
    "review": {
      "reviewId": "sssse",
      "attemptId": "WjAkp",
      "attemptCnt": 0,
      "elapsedSincePendingMs": 124,
      "elapsedSinceQueuedMs": 124,
      "createDate": "2024-01-18 12:59:31+0000",
      "reviewResult": {
        "reviewAnswer": "GREEN"  //Transaction status: GREEN (approved), RED (rejected)
      },
      "reviewStatus": "completed"
    },
    "createdAt": "2024-01-18 12:59:31+0000",
    "scoringResult": {
      "score": 0,
      "dryScore": 0,  //The risk score of the transaction with regard to the matched rules in the “dry run” mode
      "matchedRules": [],
      "unmatchedRules": [],
      "action": "score",
      "ruleCnt": 2,  //Matched rules total
      "dryRunRuleCnt": 0,  //Matched rules in the “dry run” mode total
      "tagScores": []
    },
    "typedTags": [],
    "txnInactive": false
  }