The function of the Top Up Voucher service is used at the time of the purchase of the voucher used for the top up process on the application. Here is a detailed description of the two actions that are available in the Service Top Up vouchers, such as :

Get User Voucher
Send Top Up Voucher
Share Voucher Top Up
Claim Voucher Top Up

Here's the detail of service action in Voucher Top Up :

Get User Voucher

Payload Data

Name	Data Type
Current	String
Size	String

Example Request

{
   "Subject":"ewallet",
   "SubjectType":"voucher",
   "SubjectIdentifier":"voucher-topup",
   "Action":"get-user-voucher",
   "ResourceType":"data",
   "Resource":"none",
   "ResourceId":"none",
   "Data":{
      "Current": 1,
      "Size" : 10
   }
}

{
  "Result": {
    "Data": {
      "Data": [
        {
          "Id": 816,
          "VoucherNo": "TUP-rfTHquZTdspqkucPzTYv",
          "QrCode": "Voucher Topup 100K;100000;TUP;
https://qoinvoucher.s3.ap-southeast-1.amazonaws.com/product/image/YCM0KFK10P-1715567027.jpeg"
,
          "MerchantCode": "",
          "CustomerId": "2599",
          "CustomerName": "Test",
          "Date": "05/22/2024 16:12:25",
          "Signature": "TUP-wBlnyogNWAQfqhVMfaQC",
          "Status": 1,
          "ChainSign": "",
          "ExpiredDate": "2034-05-20T16:12:20",
          "IsTopupVoucher": false,
          "GreetingCard": null
        },
        {
          "Id": 814,
          "VoucherNo": "TUP-wRrHAJpsHEEFcMRquQIh",
          "QrCode": "Voucher Topup 100K;100000;TUP;
https://qoinvoucher.s3.ap-southeast-1.amazonaws.com/product/image/YCM0KFK10P-1715567027.jpeg"
,
          "MerchantCode": "",
          "CustomerId": "2599",
          "CustomerName": "Test",
          "Date": "05/22/2024 15:16:37",
          "Signature": "TUP-lfhlubMjCFeAqvBJVdzU",
          "Status": 1,
          "ChainSign": "",
          "ExpiredDate": "2034-05-20T15:16:33",
          "IsTopupVoucher": false,
          "GreetingCard": {
            "sender": "6281212235198",
            "receiver": "081387997511",
            "message": "Test Share voucher topup wildan"
          }
        }
      ],
      "Page": {
        "Size": 5,
        "Pages": 1,
        "Rows": 5,
        "Current": 1
      }
    },
    "Code": 200,
    "Status": "Ok",
    "Message": "Success"
  },
  "TicketId": "3433382d31-a01d0dd3-db60-4400-8e73-c1812c3a95e5",
  "Subject": "ewallet",
  "SubjectType": "voucher",
  "SubjectIdentifier": "voucher-topup",
  "Action": "get-user-voucher",
  "ResourceType": "data",
  "Resource": "none",
  "ResourceId": "none",
  "ClientId": 438,
  "UserId": 80224,
  "ScopePlatform": "public",
  "Platform": "",
  "PlatformKey": "343307427818d49b78fd286399ab452083adb4a10634ab5dcbeb57161cf23fe487b607ceff36e67f9fb3c48bc94ab9fbca8413ceeb87547e78b7f1e83065932f5ddc0445b46f3f781ea700017dc2f452f185e1bb7cdb1587e74a983b6dc91d3ea89f253c79da6fd6f25751655720deaced9ad7a41a8da3311ac67e6e33a61fb9d40e0cfbb03b7c7accf2d2d3b6deb1cfd0a195d8402e9b8e7a94b10903855caf54a94a657d54c786d51bf6232e209ee0f521e0bc81fee9d0ccdcafe3751e926874e20702a191e905547abf89ee364345a6b92bd78245dcd57dc77b1e5a5e41eebdc5629fdd9f6d483ddb4ea76f5b949d9e1ddf3f570fbc54d5ea747bc4a66bdd360f809d81c7bbdc5a6683ffe99a9c1f6d3e790102b6837a3e3e6e9ae9a420c1f54dd34a0ed444363fad83bbe417bf61ab270f5d79e112e1623f26b001944cdf204f64a4ceb9ecfdf8a5d1c3be948e991a670ec1639bee842f6a3d4ce2849b0c20d0521e02774eb5745b357a9359dde139fbb475b63e9965f1933724e7a078ba28dcc4c04db1526f3068c14440e755b4a396486755ef9efb14d64efef32a484fe5dd65699b6efe9753b5da211dcb931c732d4d54dbcf42156034885c64796c7149883fed4699c4c281a8fe0120b0181f24bbaef5c776928520e4b636c07881aa9626e b81f163b7e651cbfb89",
  "Date": "2024-05-22 16:23:34.797 WIB"
}

Send Top Up Voucher

Used to send a voucher to other users who are already registered in the Qoin application.

Payload Data

Name	Data Type
PhoneNumber	String
Voucher	String

Example Request

{
  "Subject": "ewallet",
  "SubjectType": "voucher",
  "SubjectIdentifier": "voucher-topup",
  "Action": "send-topup-voucher",
  "ResourceType": "data",
  "Resource": "none",
  "ResourceId": "none",
  "Data": {
    "PhoneNumber": "6281212235198",
    "Voucher": "test-voucher"
  }
}

{
  "TicketId": "34352d31-72929f3a-ebcb-42b3-a8ed-d49e51da1b35",
  "Subject": "ewallet",
  "SubjectType": "voucher",
  "SubjectIdentifier": "voucher-topup",
  "Action": "send-topup-voucher",
  "ResourceType": "data",
  "Resource": "none",
  "ResourceId": "none",
  "Result": {
    "Code": 200,
    "Status": "Ok",
    "Message": "Success"
  }
}

Share Voucher Top Up

Used for the process of sharing vouchers to users who are already or not registered, where in the process there is a validation to check whether users are already registered or not.

Payload Data

Name	Data Type
PhoneNumber	String
VoucherNo	String
Message	String

Example Request

{
    "Subject":"ewallet",
    "SubjectType":"voucher",
    "SubjectIdentifier":"voucher-topup",
    "Action":"share-voucher",
    "ResourceType":"data",
    "Resource":"none",
    "ResourceId":"none",
    "Data":{
       "PhoneNumber": "6281212235198",
       "VoucherNo" : "TUP-C6BLY-zbQXOqcZxMVtmRc",
       "Message"  : "Sample Message"
    }
}

{
    "TicketId": "34352d31-69bb2a81-cb51-4595-b621-bfdd34b0841a",
    "Subject": "ewallet",
    "SubjectType": "voucher",
    "SubjectIdentifier": "redeemvoucher-v2",
    "Action": "share-voucher",
    "ResourceType": "data",
    "Resource": "none",
    "ResourceId": "none",
    "Result": null,
    "Status": "success",
    "Message": "Success process data(Success)",
    "StatusCode": 200
}

Claim Voucher Top Up

Used for claiming registered or unregistered user voucher.

Payload Data

Name	Data Type
SenderPhoneNumber	String
VoucherNo	String

Example Request

{
    "Subject": "ewallet",
    "SubjectType": "voucher",
    "SubjectIdentifier": "voucher-topup",
    "Action": "claim-voucher-topup",
    "ResourceType": "data",
    "Resource": "none",
    "ResourceId": "none",
    "Data": {
      "SenderPhoneNumber": "6281212235198",
      "VoucherNo": "TUP-ArrwcTVCtFqqUNKBpeSP"
    }
}

{
    "TicketId": "34352d31-69bb2a81-cb51-4595-b621-bfdd34b0841a",
    "Subject": "ewallet",
    "SubjectType": "voucher",
    "SubjectIdentifier": "redeemvoucher-v2",
    "Action": "claim-voucher-topup",
    "ResourceType": "data",
    "Resource": "none",
    "ResourceId": "none",
    "Result": null,
    "Status": "success",
    "Message": "Success process data(Success)",
    "StatusCode": 200
}