White API
curlNodePythonJavaRubyphpGo
White

White consumer api requires X-API-KEY to be sent as one of the header values in all the API request. Include X-API-KEY value in the request header.

  • Sample Header
    • X-API-KEY : 7TTOP-WVZ4DPS-GD76K7W-67AY2XF
User - OnBoarding
Generate OTP
Generate OTP

This API request would generate and send the 6-digit one-time password (OTP) to the user’s registered mobile number. The generated OTP is valid for 1 hour.

The API uses the following attributes:

Attributes
  • mobile_no
    stringRequired
    Mobile Number to be registered
Definition
POST https://test-consumer-api.flexm.com/user/generate-otp
Request
Request Headers
Content-Type: application/json
Request Body
{           
    "mobile_no":"89405680"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/generate-otp \ --header 'content-type: application/json'
Response 200
Response Headers
Content-Type: application/json
Response Body
{                
    "success": true,
    "status_code": 200,
    "message": "OTP sent successfully."       
}
Verify OTP
Verify OTP

This API is used to verify the OTP that was sent to the user mobile. On sending the valid OTP the response will have data with custom token and if the user already exists the user details will be sent along with the custom token.

Verify OTP API has the following attributes:

Attributes
  • mobile_no
    stringRequired
    Registered Mobile Number
  • otp
    stringRequired
    One Time Password sent to user mobile
  • device_type
    stringRequired
    User Device Type like (Android/iOS)
  • device_signature
    stringRequired
    User Device Signature
Definition
POST https://test-consumer-api.flexm.com/user/verify-otp
Request
Request Headers
Content-Type: application/json
Request Body
{
    "mobile_no":"89405680",
    "otp":"123456",
    "device_type":"Android",
    "device_signature": "<DEVICE SIGNATURE>"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/verify-otp \ --header 'content-type: application/json'
Response 200
Response Headers
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Verified OTP successfully.",
    "data": {
        "custom_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJodHRwczovL2lkZW50aXR5dG9vbGtpdC5nb29nbGVhcGlzLmNvbS9nb29nbGUuaWRlbnRpdHkuaWRlbnRpdHl0b29sa2l0LnYxLklkZW50aXR5VG9vbGtpdCIsImlhdCI6MTU3OTc2MTU0MiwiZXhwIjoxNTc5NzY1MTQyLCJpc3MiOiJmaXJlYmFzZS1hZG1pbnNkay04anNhcUB3aGl0ZS1kZXYyLTY5YTM3LmlhbS5nc2VydmljZWFjY291bnQuY29tIiwic3ViIjoiZmlyZWJhc2UtYWRtaW5zZGstOGpzYXFAd2hpdGUtZGV2Mi02OWEzNy5pYW0uZ3NlcnZpY2VhY2NvdW50LmNvbSIsInVpZCI6IkZuc1NvYnRsdU9hYnRuMlUwdkZWVU4zenZyODIifQ.jL1pOTLQ9Fq7j33ywIwqNYUlIptpwAcqKy3Q_qlLivnDVNlLGoU6uW1YKZdRifJF0vszoLDXZufai2FPaNpTPs6wY9XUkkObiRGX0WCx1gSBMFnj2o3eL5R5AImiK6Dqu9gEmlnxLLyyW6AzX5_rO-RMQp3b_uFBJex4qrOlMMB0xYmco1SfBpOSZgxFRhHyPVhE5Sk2FNGVzIyGCWqN7tt8fgCC0o1xNGZNZk_P7MMHg2i887zFzdlrs3f6md8vVzKSRh-87yGSICjp6djtOwcvHE8A4f-sk6NxwWfvHmPnLxjPwrF0baUFky3-TraN2E_NweK5novOhKt2AIQWvA",
        "is_new_user": true
    }
}
Wallet Create
Wallet Create

This API is used to create a wallet for the user in White.

A wallet create API has the following attributes:

Attributes
  • display_name
    string
    Preferred name of the user for display purpose
  • first_name
    stringRequired
    First Name of User
  • last_name
    stringRequired
    Last Name of User
  • nationality
    string
    User's Nationality
  • occupation
    string
    User's Occupation
  • gender
    string
    Gender (Male/Female)
  • birth_date
    string
    Birth Date of User
  • email_id
    string
    Email address of User
  • message_id
    string
    User device FCM
  • device_type
    stringRequired
    User Device Type like (Android/iOS)
  • referred_by
    string
    Referral code of referred user
Definition
POST https://test-consumer-api.flexm.com/user/wallet/create
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJodHRwczovL2lkZW50aXR5dG9vbGtpdC5nb29nbGVhcGlzLmNvbS9nb29nbGUuaWRlbnRpdHkuaWRlbnRpdHl0b29sa2l0LnYxLklkZW50aXR5VG9vbGtpdCIsImlhdCI6MTU4MTYwMzAzOCwiZXhwIjoxNTgxNjA2NjM4LCJpc3MiOiJmaXJlYmFzZS1hZG1pbnNkay04anNhcUB3aGl0ZS1kZXYyLTY5YTM3LmlhbS5nc2VydmljZWFjY291bnQuY29tIiwic3ViIjoiZmlyZWJhc2UtYWRtaW5zZGstOGpzYXFAd2hpdGUtZGV2Mi02OWEzNy5pYW0uZ3NlcnZpY2VhY2NvdW50LmNvbSIsInVpZCI6Ikh5STNPOGNWa2ZYV1F1bHY0S2ZWYjc4dDczTzIifQ.rUc8_Y9RflzVr1VhuNxarXA1mblPMD--Dc404a8fKvLZbJ2KpqHi2MJ3Hi1mVdm-Fmg0MztgCZEpjDd4A-6j0rNUEo09TanPYDGVcdsKPkUOc3hlnjh69l6VJkk5bR6fGTaa06Rvvrik1culWZf96mqD135PRLEp8znpx7xpJonqtVrRUdEFVNuLHbuhc8YCnE9RxJirqHRLfVN2yn2mLpWIrWWnscWGYruR5g92xX8wbBTk-JjzPNZzWde-451WhvkXizKhnKxh3rqdmurEmPtRrZ0QlppmfpRK9JXpb5FcyHnKJyHjaHwI2PmSuF8IBdPzvDPS0BhRgYPifyaFNA
Content-Type: application/json
Request Body
{
    "gender": "male",
    "birth_date": "1995-12-24",
    "email_id": "john@flexm.com",
    "first_name": "John",
    "last_name": "Doe",
    "display_name": "John Doe",
    "occupation": "Business",
    "nationality": "Singapore",
    "message_id": "<User Mobile FCM ID>",
    "device_type": "Android",
    "referred_by": ""        
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/create \
--header 'authorization: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJodHRwczovL2lkZW50aXR5dG9vbGtpdC5nb29nbGVhcGlzLmNvbS9nb29nbGUuaWRlbnRpdHkuaWRlbnRpdHl0b29sa2l0LnYxLklkZW50aXR5VG9vbGtpdCIsImlhdCI6MTU4MTYwMzAzOCwiZXhwIjoxNTgxNjA2NjM4LCJpc3MiOiJmaXJlYmFzZS1hZG1pbnNkay04anNhcUB3aGl0ZS1kZXYyLTY5YTM3LmlhbS5nc2VydmljZWFjY291bnQuY29tIiwic3ViIjoiZmlyZWJhc2UtYWRtaW5zZGstOGpzYXFAd2hpdGUtZGV2Mi02OWEzNy5pYW0uZ3NlcnZpY2VhY2NvdW50LmNvbSIsInVpZCI6Ikh5STNPOGNWa2ZYV1F1bHY0S2ZWYjc4dDczTzIifQ.rUc8_Y9RflzVr1VhuNxarXA1mblPMD--Dc404a8fKvLZbJ2KpqHi2MJ3Hi1mVdm-Fmg0MztgCZEpjDd4A-6j0rNUEo09TanPYDGVcdsKPkUOc3hlnjh69l6VJkk5bR6fGTaa06Rvvrik1culWZf96mqD135PRLEp8znpx7xpJonqtVrRUdEFVNuLHbuhc8YCnE9RxJirqHRLfVN2yn2mLpWIrWWnscWGYruR5g92xX8wbBTk-JjzPNZzWde-451WhvkXizKhnKxh3rqdmurEmPtRrZ0QlppmfpRK9JXpb5FcyHnKJyHjaHwI2PmSuF8IBdPzvDPS0BhRgYPifyaFNA' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJodHRwczovL2lkZW50aXR5dG9vbGtpdC5nb29nbGVhcGlzLmNvbS9nb29nbGUuaWRlbnRpdHkuaWRlbnRpdHl0b29sa2l0LnYxLklkZW50aXR5VG9vbGtpdCIsImlhdCI6MTU4MTYwMzAzOCwiZXhwIjoxNTgxNjA2NjM4LCJpc3MiOiJmaXJlYmFzZS1hZG1pbnNkay04anNhcUB3aGl0ZS1kZXYyLTY5YTM3LmlhbS5nc2VydmljZWFjY291bnQuY29tIiwic3ViIjoiZmlyZWJhc2UtYWRtaW5zZGstOGpzYXFAd2hpdGUtZGV2Mi02OWEzNy5pYW0uZ3NlcnZpY2VhY2NvdW50LmNvbSIsInVpZCI6Ikh5STNPOGNWa2ZYV1F1bHY0S2ZWYjc4dDczTzIifQ.rUc8_Y9RflzVr1VhuNxarXA1mblPMD--Dc404a8fKvLZbJ2KpqHi2MJ3Hi1mVdm-Fmg0MztgCZEpjDd4A-6j0rNUEo09TanPYDGVcdsKPkUOc3hlnjh69l6VJkk5bR6fGTaa06Rvvrik1culWZf96mqD135PRLEp8znpx7xpJonqtVrRUdEFVNuLHbuhc8YCnE9RxJirqHRLfVN2yn2mLpWIrWWnscWGYruR5g92xX8wbBTk-JjzPNZzWde-451WhvkXizKhnKxh3rqdmurEmPtRrZ0QlppmfpRK9JXpb5FcyHnKJyHjaHwI2PmSuF8IBdPzvDPS0BhRgYPifyaFNA
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "User Wallet created successfully.",
    "data": {
        "custom_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJodHRwczovL2lkZW50aXR5dG9vbGtpdC5nb29nbGVhcGlzLmNvbS9nb29nbGUuaWRlbnRpdHkuaWRlbnRpdHl0b29sa2l0LnYxLklkZW50aXR5VG9vbGtpdCIsImlhdCI6MTU3OTc3NDk0NiwiZXhwIjoxNTc5Nzc4NTQ2LCJpc3MiOiJmaXJlYmFzZS1hZG1pbnNkay04anNhcUB3aGl0ZS1kZXYyLTY5YTM3LmlhbS5nc2VydmljZWFjY291bnQuY29tIiwic3ViIjoiZmlyZWJhc2UtYWRtaW5zZGstOGpzYXFAd2hpdGUtZGV2Mi02OWEzNy5pYW0uZ3NlcnZpY2VhY2NvdW50LmNvbSIsInVpZCI6IjQyV01KWjVIRVVPYjJBWEFFTnh2R09odVVvZDIifQ.jV4JHV3goJTJ1GlF9SW5vDO-k1geu-n43c5Gi2iEoD4WZXhCNTBPxjQBzXBRQirFBOjF91exWYXMDVZMqbnQKRv-O8kyuDQcEXo0xD8FSSmCJRfhgU_JNQprFeAReKI55FGGZzPsBVCLppv0bp2qDqGiRn6HCbKYEtQWQvgIycRoNZcGrTN-lwXRWy4UMfzQ-kdf1FISdGglIpq3poi59-PNnBS2lYBzpIJtl3KBcYxEADm12LZxBeSCDPuSMIyOHcRaUQEdecTzPRKQ4fyITG5S3tq5Qg-_AC4KUDzu6204jfkpWiV4ysHqfa9mm4DHSzXMmbukjKgfaKITgEC_nA",
        "user_doc_id": "42WMJZ5HEUOb2AXAENxvGOhuUod2",
        "user_account_id": "tvNUDqUFUZN9RpyEr1mb",
        "user": {
            "profile_picture": "",
            "user_id": "USI00120200000103",
            "hash_id": "42WMJZ5HEUOb2AXAENxvGOhuUod2",
            "is_kyc_approved": false,
            "mobile_no": "93667047",
            "kyc_status": "Not Submitted",
            "display_name": "John Doe",
            "gender": "male",
            "birth_date": "1995-12-24",
            "first_name": "John",
            "middle_name": "",
            "last_name": "Doe",
            "country": {
            "currency_code": "SGD",
            "telephone_code": 65,
            "currency_name": "Brunei dollar",
            "created_date": "2221-11-14T08:01:29Z",
            "alpha_3_code": "SGP",
            "language": "English",
            "numeric_code": 702,
            "is_active": true,
            "alpha_2_code": "SG",
            "remittance_enabled": false,
            "name": "Singapore",
            "currency_symbol": "$",
            "flag": "https://restcountries.eu/data/sgp.svg",
            "timestamp": 1573718489859
        },
        "created_date": "2020-01-23T10:22:26Z",
        "timestamp": 1579774946004,
        "email": {
            "email_id": "john@flexm.com",
            "verified": false
        },
        "social_media": "",
        "serial_no": 103,
        "device": {
            "message_id": "<User Mobile FCM ID>",
            "device_type": "Android"
        },
        "loyalty_points": {
            "lifetime_earning": 0,
            "lifetime_burned": 0
        },
        "referral_code": "ZWaUZ7Bq",
        "referred_by": "",
        "plan_code": "tier1",
        "occupation": "Business",
        "nationality": "Singapore"
    }
}
}
User - Refresh Token
Refresh Token
Refresh Token

This API uses the unique user id to retrieve the user refresh token.

The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/user/refresh-token
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    No inputs
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/refresh-token \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Refresh token retrieved successfully.",
    "data": {
        "refresh_token": "AE0u-Nca8cFimUbZqOHBp0c8Zn0MvC6p-oJclDlLUFUg0ZkiZXwkXyz509Phm_1GGYkPYFqpLDZ-jlrIy16C17PSpLFi9nkoOBuD-IMLYvKG0Ai28HZWBoESoNcLQjZe-1OMFxmgwFLbY-DayB5ej7x5qNNgmpHtc2xnlHG5YGz1wNSLxoz5Oa47NNlIroDi93ZuK1qhtBVd"
    }
}
Refresh Custom Token
Refresh Custom Token

This API uses to retrieve the user refresh custom token.

The API has no Attributes

Definition
POST https://test-consumer-api.flexm.com/user/refresh-custom-token
Request
Request Headers
Content-Type: application/json
Request Body
{
    "refreshToken": "AE0u-NcLlR1Hq62ZLENJ2xih_DLa_qlxrBZV1iNp4hoaJwOOHUZKu_MmT9IM21Z3qUi9MLZ5TDIYpc7TrHF1pTCS7OeDxjrzB7iPVAE65s0SyKCBUVMLIABLgmii417jDoiKctHzDuaJegjz-tfyZ1CkydNoXrf8yoO3GZjTY1R9R4Ewnw6l1Q4xDEoIOSS6pK48dKwTruZ-"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/refresh-custom-token \ --header 'content-type: application/json'
Response 200
Response Headers
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Custom token refreshed successfully.",
    "data": {
        "refresh_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJodHRwczovL2lkZW50aXR5dG9vbGtpdC5nb29nbGVhcGlzLmNvbS9nb29nbGUuaWRlbnRpdHkuaWRlbnRpdHl0b29sa2l0LnYxLklkZW50aXR5VG9vbGtpdCIsImlhdCI6MTU4NzcxOTE3MiwiZXhwIjoxNTg3NzIyNzcyLCJpc3MiOiJmaXJlYmFzZS1hZG1pbnNkay04anNhcUB3aGl0ZS1kZXYyLTY5YTM3LmlhbS5nc2VydmljZWFjY291bnQuY29tIiwic3ViIjoiZmlyZWJhc2UtYWRtaW5zZGstOGpzYXFAd2hpdGUtZGV2Mi02OWEzNy5pYW0uZ3NlcnZpY2VhY2NvdW50LmNvbSIsInVpZCI6InNjNlhpSzlRQW9hNmhvMnRWbm1IV2FONmNsZTIifQ.I-_cFbiLn6omGA3YuXbQtMWg7JMvBFdgVmrSwXkMiBp3dSznka7ptPtHv7bNJIK7BplGXE3Iv0HSu5PTAHCOwyRXdMKD2GJeiybrDWMaw1QBVukikh7BrELCaOvsJb0wa3ZGZ--0JC5_8x9K91Dhx2xNzcfeyp92jN-TiFSwGQ1jNBT6ejDmJFnBWkdfvrmK-iSLj8yCFFfDfQStCy7nrDEcbD37QI8QAkAmZvFRPIsO7RGE5ZoeLR5qh70WoVvcdnaRz-r8uQQI69QqBZQsxpSshYnyTMNkBC8AB7mYntDUGpQcpVlGljrG6mqEYRA-BScd7AxadXTJKtX1tNWF9Q"
    }
}
User - Profile Setup
Get User Profile
Get User

This API uses the unique user id to retrieve the user profile information along with the custom token.

The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/user/profile/get
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    No inputs
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/profile/get \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "User profile retrieved successfully.",
    "data": {
        "user_doc_id": "42WMJZ5HEUOb2AXAENxvGOhuUod2",
        "user_account_id": "eisJ9bpaQmL0WbO71H9U",
        "user": {
            "is_kyc_approved": false,
            "kyc_status": "Not Submitted",
            "birth_date": "1995-12-24",
            "occupation": "Business",
            "loyalty_points": {
                "lifetime_burned": 0,
                "lifetime_earning": 20
            },
        "middle_name": "",
        "first_name": "John",
        "created_date": "2020-01-23T07:38:36Z",
        "referred_by": "",
        "plan_code": "tier1",
        "display_name": "John Doe",
        "gender": "male",
        "hash_id": "42WMJZ5HEUOb2AXAENxvGOhuUod2",
        "last_name": "Doe",
        "profile_picture": "",
        "nationality": "Singapore",
        "referral_code": "WhdOXL8h",
        "email": {
            "email_id": "john@flexm.com",
            "verified": false
        },
        "timestamp": 1579765116046,
        "social_media": "",
        "user_id": "USI00120200000103",
        "serial_no": 103,
        "device": {
            "message_id": "<User Mobile FCM ID>",
            "device_type": "Android"
        },
        "country": {
            "language": "English",
            "numeric_code": 702,
            "is_active": true,
            "alpha_2_code": "SG",
            "remittance_enabled": false,
            "name": "Singapore",
            "currency_symbol": "$",
            "flag": "https://restcountries.eu/data/sgp.svg",
            "timestamp": 1573718489859,
            "currency_code": "SGD",
            "telephone_code": 65,
            "currency_name": "Brunei dollar",
            "created_date": "2221-11-14T08:01:29Z",
            "alpha_3_code": "SGP"
        }
        }
    }
}
Profile Update
Profile Update

This API is used to update user profile information.

The API uses the following attributes:

Attributes
  • display_name
    string
    Preferred name of the user for display purpose
  • first_name
    stringRequired
    First Name of User
  • last_name
    stringRequired
    Last Name of User
  • nationality
    string
    User's Nationality
  • occupation
    string
    User's Occupation
  • gender
    string
    Gender (Male/Female)
  • birth_date
    string
    Birth Date of User
  • email_id
    string
    Email address of User
Definition
POST https://test-consumer-api.flexm.com/user/profile/update
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    "display_name": "John Doe",
    "first_name": "John",
    "last_name": "Doe",
    "nationality": "Singapore",
    "occupation": "Business",
    "gender": "Male",
    "birth_date": "1995-12-24",
    "email_id": "john@flexm.com",
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/profile/update \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Updated user details successfully."
}
Address Create
Address Create

This API is used to create user profile address.

The API uses the following attributes:

Attributes
  • city
    stringRequired
    Address of City
  • country
    stringRequired
    Address of Country
  • is_default
    booleanRequired
    Default type
  • line_1
    stringRequired
    Address Line 1
  • line_2
    stringRequired
    Address Line 2
  • state
    stringRequired
    Address of State
  • type
    stringRequired
    Address of Type (Billing, Residential, Others)
  • zipcode
    stringRequired
    Address of Zipcode
  • delivery_location
    stringRequired
    Address of Delivery location
  • landmark
    stringRequired
    Address of Landmark
Definition
POST https://test-consumer-api.flexm.com/user/profile/address
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
    "city": "Pondicherry",
    "country": "India",
    "is_default": true,
    "line_1": "Rainbow nagar",
    "line_2": "Rainbow nagar",
    "state": "Pondicherry",
    "type": "Billing",
    "zipcode": "605001",
    "delivery_location": "Rainbow nagar",
    "landmark": "Rainbow nagar"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/profile/address \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "User address created successfully."
}
Address Get
Address Get

This API uses the unique user id to retrieve the user profile address information along with the custom token.

The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/user/profile/address
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
   No inputs
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/profile/address \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "User profile address retrieved successfully.",
    "data": {
        "user_address": [
            {
                "city": "Pondicherry",
                "country": "India",
                "id": "bcbd71b3fcec436b960e9d81620a575f",
                "is_default": false,
                "line_1": "Rainbow nagar",
                "line_2": "Rainbow nagar",
                "state": "Pondicherry",
                "type": "Billing",
                "zipcode": "605001"
            },
            {
                "city": "Pondicherry",
                "country": "India",
                "id": "0f679b8f74384f6980142a2b0741f236",
                "is_default": false,
                "line_1": "Rainbow nagar",
                "line_2": "Rainbow nagar",
                "state": "Pondicherry",
                "type": "Others",
                "zipcode": "605001"
            },
            {
                "city": "Pondicherry",
                "country": "India",
                "id": "fd05ec32b3c344ee8bf3a8dc30d80905",
                "is_default": false,
                "line_1": "Rainbow nagar",
                "line_2": "Rainbow nagar",
                "state": "Pondicherry",
                "type": "Residential",
                "zipcode": "605001"
            }
        ]
    }
}
Address Update
Address Update

This API is used to update user profile address.

The API uses the following attributes:

Attributes
  • Url Parameters
    object
    Expand attributesClose attributes
    • id
      stringRequired
      Address ID from Get Address API
  • city
    stringRequired
    Address of City
  • country
    stringRequired
    Address of Country
  • is_default
    booleanRequired
    Default type
  • line_1
    stringRequired
    Address Line 1
  • line_2
    stringRequired
    Address Line 2
  • state
    stringRequired
    Address of State
  • type
    stringRequired
    Address of Type (Billing, Residential, Others)
  • zipcode
    stringRequired
    Address of Zipcode
  • delivery_location
    stringRequired
    Address of Delivery location
  • landmark
    stringRequired
    Address of Landmark
Definition
PUT https://test-consumer-api.flexm.com/user/profile/address/{id}
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
    "city": "Pondicherry",
    "country": "India",
    "is_default": true,
    "line_1": "Rainbow nagar",
    "line_2": "Rainbow nagar",
    "state": "Pondicherry",
    "type": "Billing",
    "zipcode": "605001",
    "delivery_location": "Rainbow nagar",
    "landmark": "Rainbow nagar"
}
Example Request
curl --request PUT \
--url https://test-consumer-api.flexm.com/user/profile/address/{id} \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "User address updated successfully."
}
Address Delete
Address Delete

This API is used to delete user profile address.

Attributes
  • Url Parameters
    object
    Expand attributesClose attributes
    • id
      stringRequired
      Address ID from Get Address API
Definition
DELETE https://test-consumer-api.flexm.com/user/profile/address/{id}
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
   No inputs
}
Example Request
curl --request DELETE \
--url https://test-consumer-api.flexm.com/user/profile/address/{id} \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "User address deleted successfully."
}
Profile Picture Upload
Profile Picture Upload

This API is used to upload the user’s profile picture.

The API uses the following attributes:

Attributes
  • image_type
    stringRequired
    The Image Type of the file
  • image_base64
    stringRequired
    Base64 Image
Definition
POST https://test-consumer-api.flexm.com/user/profile/picture/upload
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    "image_type":"image/png",
    "image_base64":"iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAYAAABccqhmAAAgAElEQVR42u2dfXRdVZXAf+8lxqwYs7pirLXGGDuldmqtlVVLxdK5llqR4ftrKN8IiIiIwGJhh6k96EIWwyAWVL4tXwVEFkIXFqy1XDu1lk6ptVOZTgglq2Y6sZPJCjFmYn0+5o99Hn1N85qX5N1zv/ZvrbdSStt73zln77P3Pnvvk0FJJMaYeqCx6DMBqLf/uwaoG+av9QF5YNB+eoGewk9jzICObLLI6BDESqgLv6wHpgCtQDPwYaCl6NNkhbzSDFqFsAfotD9/D+wF2oE2oH/IuyqqAJQxCHsWqLZCPhP4uP05E5gKZCP42nmgA9hlP78DtgM7gZwxJq8zqwpAGX5nzwINwDzg08AC4Mgisz3O9FtFsAV42f7cA+TVUlAFkOYdvtEK+t8BRwOzAjLdo2oprAdeAnygSxWCKoCk7/LVwHTgOODv7W5fq6NDHngVWAc8Zy2EQXUZVAEkQejrgPnAiVbwp0TUf48SXcBaqwzWA32qDFQBxEnoa4C5wBLgFGCyjsyY6QPWAKusq9CvboIqgKia9zOBfwBOI7qR+jizF3gaeALYBuxXZaAKIEzBLwTyTgMuQ6L2KvRuYgY7gJXAk0C3ugiqAFwKfjUwwwr9WcBEHZXQ6LVWwYPANmPMfh0SVQBBmfn1wPHA5cjxXbWOTGTIIacHK4DngQF1D1QBVErwJwBnA1cjx3hKtNkJ3GXdgz5VBKoAxir4TcAFwFVISq4SL3YDdwMP2TiBjogqgLIEfxJwqTX1m3VUYk8HcAfwCNCrikAVQCnBb7A7/g0q+IlkF3ArEjTUfAJVAG8Lfy2SpbcMOcpTks124FvAGmPMoCqA9Ap+NTAHWA4sQqP6aSKHpBsvA3YYY3KqANJl7jcDN1qTv07lIbX0A/cBtwN70+YWVKVQ+Out0D8MHAu8Q2Ug1dQAnwJOB970PK/N9/2/qAWQPMHPArORINBCNGVXOZQ88CISBH41DenFVSkR/gbgK9bU+yga/FRKb4hHIOndec/zdvq+/2e1AOK968+y/p2nu74ySjYC1wNbkmoNVCVY+GuBC5GKsZm66ytjoAU4A8h5nrfD9/3EFRplEij4IBH+m4Fz0KM9pXKxgWuA9iRZA5mECX/Wmvor7K6fNnLDfPJFi3ikhVtQloWW5Nkhv65OuRvViQQIn05K2XEmQcJfjwT6liIpvUkX9AHkDHs30lDzNaRjTjcHbvQZsJ8c0pd/sIwxrEEalRZ+XWd/3VD0swn4AFIz0WJ/1hZ9ksx+JJi83BjTowogGiZ/C1LscUoCd6i8FeIeJIX1FSvwbcBuY0x/BOag1s5BK1Iu/WmkJ2KTVSBJtBrWA1cCu+KcPJSJufBnkdz9e0lODn/e7uxdwGbgV1bwd8bpbj5jTJ11w+Yg9x4kUSHsBq4A1sU1LpCJsfBX2x3/LmuCxt2kL+zwPwM2IPnpiYk6FymEecDJSFLWhAQog17gOuCRONYTZGK6mGqALyGR/voYC/0+pNX1c8AmoDMNuejWcpuKBGxPt9bbBOJ7YjNo1+J34naDciaGi6cBKeL5GvG7Ritvd/rNwI+RarSuNNelW2XQgqRnn4pckRZHyyAHPAAsNcb0qgIIZrE0Ill9F8RsgQwiQbtHgdUk7Cy5wspgGpKKuwS5RSluSv5x4GpjTLcqgMoujknW3z8jRrt9rzXxHwbWRyFiHzNLbzFwcZFVEBeeBy43xuxVBVCZxdCMRPqPj4ngd9md4GFSUlUWsFUwCzgX6cw8OSbWnw9cbIzpUAUwvgXQagVpQQwEfw/SeHIl0KE95wJZC5cB5yHp3lFXBBuAS6zLpwogocKfR86D7wcei4PZF3MlAJJwdAkSC4q6IthqrZe2KCqBjAr/uOgCfgjcbYzpVPEMRRHEwSKIrBLIqPCPiR6ktfQK6+OrRIarCKYgyTjnEN1gYSSVQCaCE9qM3AUfReHfj+SAfwvYrMG9SK2bLHJasMyunVpVAjFTAMaYycgtr8dF1M+/zfr5AypykVUEdUgewfVIYVLU3ILNwJKonA5kIjRxE5HoedSO+vqQI71bo36koxyymVwFfBFojNjrbQDON8bsCftFqiIyWY3IJY4nR2zX/x1Sc/C9JNR+pwnf9//oed5LwMvADOD9EdrwPgR8zPO8n/u+H2pyWCYCwl9vTesvRWj9DCJBvhujoKWViliXS4EvEK1mMc8Cl4WZNlwV8sTUAF8Hro6Qr7YX+Cfgm8aY/1XxSYQ18CfP834B7AQ+hvQliII1MB2Y7HneS77vh3JHYSZE4c/aXf92ohGxzSEluYU20Co5ybQGWoCbkLTiqJwU/AC4PozgclWIwl9o5vGuCExAv52Eq4wxr/m+r5KSXGvgTc/zXkB6Jx5FNO6F/AQw4HneZt/384lWAHZn/SRSGvueCAx+G/BVJNCn1XrpUAJ/9TzvFaQD0yetSxAmhRyGDnsb0VuJdQGsCfYc0hIqTPLIccwVxphdKhapdQmmIxmdCwm/I1E30iFpgysXNOt4sBuQ7r1hC38OicCeq8KfegWwC8nOewA5/QmTJuQ4fEriXAAb8V+GVHGFGYHdj2QbftUY8z8qAorv+wP2lOBNpGlpmMHB9wIf9jxvjYuLSascCX8Wibp+G3hHiIM7APwz8A1jzB916StFSiDned4W5Bj4GMINDh6B3Ee4MeigoCsXYCaS7BOmZu1Bjvhu1lx+pcRGlQceAy63iiAsssC1wIKgYwFZB4PaiARZwuzd34lc4HBPknrtK4EpgWesq9oR4qvUI/GyQOWmKuDBrAa+gQRZwqLdTubzxpi3dIkrZbgDeJ7XjlzDdjThHRO+D6jzPG+d7/t/DeIBmQCFHyTZ54kQTf92pDHjRl3Wb5fKNnPgUs9iP3fA7njdSAXkvjjedBPAmM1BmtPMCOkVBu0G+kwQ7kCQCqAFeAmHRxpD6AAuNMZs0EVsJnGgxfYMYGKJP1poZd5tx++XwBrkXsJcisdvHpK4NjWkV9gNfCaIwrRMQANWg7TxviikAduD9Ipbm/Jbd1qRxplLkAs3xhLz6bVK4DZge1rH0xiz0FoCzSG9wuPAJSNd8R56DMAukNOB5YRTa7DPCv+LKV6s1Z7nnWV3rVMZX/VbLVJBdwbQ4Hneb8KqXAsTz/PeAF4HjiWc+pW/BV73PO+3laxVCeIUoBm5KDGMK536kKO+NSkW/sINSiuRrrmVogn4R+A5Y8zsFI4ryI0/11mryDXVSBVjRS2QqgoPUrU1FReFFCz5JnBfWpt1WpP/J8BJBJPXnkG62Zzged4bnuftSlPlpO/7b3met9MqgIW4T2qbAFTbU4GKrPFsBRcfVvAvCGFucsA9wJ1pDVbZnX8VMMfB45qRdOqzUjjOeaRu4Lt23bnm0krOcSVdgAlIu2zXpn8eKexZXukASYwW5QRr8s9z+NhG4PvGmAUpHO8ccItdd66tzTokm7UiqcpVFRqQLNKB9cIQ5uMVJDq6L6XCnwW+Y3fjbAiL8SjP81b7vt+XpnH3fX+/53kvI3cQTHb8+A8Bb9iAbCQsgGlI8M01nUgXnzQ37lyAXI0VVk/F6cBNVhGlTfnusRuf6/WXRU7ZJlfiHxrvIBSik67TJfuRTq+b0yr51gy8GckbD4tCpaeX0mnYbNehawuoBbjByl+oFsB8JOXXJTmkh9+TKW/eeREwNwLvUYc0tUyjFQDwFHAn7oOCX7AWWDgKwGb8LcV94G8TclNPmtNTa5AKx+qIvNIC3JxARHEucsjxt+/40fXjtQLGq7EXI+ehLumyu03ab+qZR3i56aWsgFNTrJD7gBtw30fgDKTfhlsFYP3PGx3vQPuR45ctKGcSvRtwT0ijG1DENuBWu05dUQssHasVkB2j8INkm7n2P9cAD6T90g77/b0IvlprxKySMOblAbtOXXIKcKRLC6AWuAa3R0+dwDJt5wUcqOePGrXjMUcTogQGkLjYboePrRmrFTBWAV6M24DPfuQKsZ0q+4DU9NdE8L2qCa//Q5SUwC4kK9ZlZuoJjCETNDuGL1cTwu7vq+l/EI1EJ/o/lA/q9ADwJLDOsfId9YnAWIR4AXL274puJM9fr+06QB3RuU15KBN0esDWpdyMdKN2xeLRumDZUX6pauQqb1e7T6FNs0b9K+O6udqJFGEL8AjuCoZqkKvuskEtpGlWy7hiN3BHWuv7D8MA7qvQyqVXp+ftDTOPtPZ2GRA8m1G0Es+O4suANJV0FXzKAStSXuhTin2EU4teDn/Q6TlIbvYgAWxXuQENwEXlxsuyo/yHz3Y4dlut+aQcSldEFUDe8W4XF1y7sZdQZoHYaBTA8bjriDoI3GbTK5XhXaMopkIPAnrb8qFWQD+SIegqh2UKkqhXGQVgg3+XOByzzbjPporTgtoPrI/gq/WguRqlWIcUsbniynKOBMu1AGYgx38uGABuT2t7r1Hw8wi6Aet03koq7UHkjkxXVsA8ykjWy5bx4uA2+LcBWKtLZkTWIsHAqLAf6UisHH7OXDWwyQJLRgoGlmMBuAz+DSDHfnqD78iKuRu5LSYqx4FtuM18i6vrtgJ3KcKncfD9j2NSAAtxd7X3NmsBKOVxP9E4d88Bd2mhVtlWwFZHz2oeyXXPjqCxssDJDk3Ie9WHHPWuuyICVsAW5KhLKS8WcIdDK2DJ4TIDR7IA6pDjPxe0A6t1iYxqMYG0BA+zMWoPcJ3u/qPiReBVR886ybrxY1IA8yl9lXQlyQMr9dx/TEqgH2lN3RmS6b+cFHdmHuOcDSAXt7qw3CYcbhPPjrC7nO5oTPYBT+vSGPOC2oZcyrLPsfB/F7mLUSdh9DyDZHSG6gYczgKoRZoMuDKJOnRNjIv1yLXo+xwJ/3eQDk16YjM29uAu2W0R0kNiVApgHm6i/wPAKt1FKhIPWI105m0L8FF9SEn4Mg3Yjnu+HkUuuAmaWkp0784e5uXOdDQWbcBGXRKVWVTGmE3AZ61LVWkfcydyKnSP7vwVYROw3dGzPjfcJlvKAqjGTd1/HnhUd5KKK4I9NiZwPpUpzukGvg0ca4zxtT9DxeYph9zq7CKlezHDNGspVSwwBTfNHXuB53UpBLK4BoDHjTFrkVjOycAspHV3OQlgPcAO4CXkjL9DBT8Q1lgFG7S73Wznf1s5CmABbtpObUXO/5XgFEE38JAx5nHkSKgV6SH/AeR8uMHOdb/9/Le1GnYAvXq+Hzhd1gU+w5EVcJACyAyzYLLAKoLP/88hJYv36RpQUq6kz7OuQND9FDcAnym25Ibb5bO4Kf3tQY7/FCXt+Lhp8DKPIV2bh1MA04HJDl5mE3IWqihppxM32ZQ1Qzf34RSA5+BF8sBP9exfUd4+dn8ON6cBnyqpAOyLHOvgJXrRs39FKWYdbkq75xZvvNlh/H8Xt/60E2y2mqLEjT0MidAHxGyKunsNVQAtQJODl1irZ8qKcoj1/UsHj5qAXPAzrAKY5eAFBpDkEkVRDmYzbpqGzi2lAGY7eHifI1NHUeLGNkdxgKMOUQDWBPm4g4fvQO+PU5Th3IBeKx+BWwCFQGCxBZB15AL8qx7/KUpJXLjHM7DdgosVQAPBFwANold9K8rh2OQgDlBTkPViBTCL4AuA+nFX/6wocWS7Ixd56nAKIGjaiNZtNooStThAv6M4wPShCuAIF9pN/X9FGREXp2RHDFUALQE/MA/8VudWUUbkdwRfF3DABbC7ctAKYBBt/qEo5dBO8DcHTYODGxC0BvzA/Wj5byV9xRbgXqTjaxTIA7faFmTK+Oi0CqA+wGdMMsY0FBRAAyX6hlfYAtirc1sx6pDCrfoIKYCHdVoqQhduUoKnZh35/wD92l9OUcqy7vJIo9CgmZx1ZP6Dm5ZHipIUXMjLRJcKQPP/FSVa8tJYUADvd+EC6JwqStm4uCm7rqAAXASS9PYfRSkfJ1evFRRAg4NnaQBQUSImLy4VgF4mqSgptgAURYkYLmMA6gIoSvn8KWkKQF0ARYmoC1Cv460o6XUBJuhQKEp6FYCiKKoAFEVJowLQNF1FSbECyOlQKIq6AIqiqAJQFEUVgKIoqVAAeQfPqtHhVpSyqXapAFy0H6rTOVWUsnm3SwXQreOtKOl1AVxYAOoCKEpEXQAXFoC6AIpSPvUuFcAf1AJQFLUAYq/RFCUhuOjSlXOpABp1ThWlbFyU6HeqAlCUaOJCXjoKCqDLhQtgjKnVeVWUw2OMyQJNDh61p6AAOgi+B1kt0KzTqygjMpHgY2a5Yhdgv1UCQVIDTNa5VZQRabYbZqD+vzFGgoDGGIB2BxbAFJ1bRRmRKQ4UwB44uBqwLeAHZoFP6Nwqyoh8lODzADqGKoDXHHyxI3VuFWVE5jh4xmuuLQCAacYYPQ5UlBIYY+qBWQ4etXOoAmh38NB6YLZOs6KUZBZukoC2D1UAnQTfHbjOkXmjKHE2/4MunOthmCBgrqAVAuYYnWNFKcnfEXyrvp3YLmDZIt8DYIuDLzjbGKPXkSvK8P6/Cwt5u5X3QzTNyw4e3qhxAEUZfnPETQ3Abwq/GKoAtjp4eB2wQOdaUQ5hLm7K5neUUgAdwF4HL/B5W/CgKMoBF/wzDh41CLxaSgHkHVkB09G0YEUpZpIj/38LRYV/2WG00L85eIkGYJ7OuaK8jYebEmDfGJMvZQEAbHbwEtXAiYVIpKKo+c+puOkD+FLxf2RLmAgurgtfYM0eRUk7E4H5Dp7Tx5Cj/uEUQD+w0cHLNAELde4VhQWOzP/NSBCwtAKw/sELjtyAM9UNUBROxU3b/JeK/f9SFgDAWtxcGDoPbROmpNv/n4i7vJj1Q3+jlAJox011YBOwWJeBkmIW2RhA0HQzTK1PKQWQs1aACzfgQmNMta4DJYW7fxa42JH5v97K9cgKwPrlLzgah9loibCSTo5E0n9d8OOh/v/hLACQk4A+By/WACzRtaCkkHNxcwVYP7BuuP+RHeEvrXU0EKfYYIiipMX8nwSc5uhx60pt5tnDvGAeWOXoBSc7HAxFiQIn4O6ejGHN/5EsgILm2OfgBauBy4wxdboulBTs/jVI8M9F8HvgcJZ8toy//KyjcZkBHK/LQ0kBHu6a4qxHegCOXgFYs+EJRy9aC1yhR4JKwnf/auAagm/8WeC5UuZ/ORYASP5wu6OXnYt2C1KSzQLcFP6ABP6eP9wfKEcBDAJPO3rheuAqtQKUBO/+V+Gm7RfAakaI4WXLeGmsG5Bz9NKLrI+kKEljPu4qYPPAg4cz/8u1AEB6iG1waAVcYyOlipKk3f9q3CT+gDT+3DTSH8qW+fI54PuO/SS1AhTd/cfOSop6/43XAgB4Edjl0Aq4XvMClITs/rXA9Q53/17gqXJ6bYxGAQwA9zu2As7Q5aMkgNMc7/7PUmYCX9kKwGqTxzhMUkGFqQFusDnTihLX3X8isBTJc3FBHlg5UvBvLBYASFOBxx2O33TgSm0bpsRU+AGuRLJcXbGVUXT2zo7yC+WBuxnSWDBAssClyJ3pihI3ZgFfJPjbfotZQRnBv7FaAABtwBqHX2gScJMGBJWY7f411vR36cK+CqwejcWcHcMXywG3jUbLVIDjgHN0WSkx4iSk5NclKxjlnR5jNU22ImmGrqgFlhpjpum6UmKw+7cC38Jdym/BMn9ytPGy7Bi/YA642WEsAOQy0eWaIajEwPS/CXC9Wd3OGFr4jSc4sRN3RUIFTgMu0FMBJcKcB5yF28Df9rHs/uNSANYKuBU39wgWuwLLcNdMQVFGIxMz7PqsdfjYnHU3xtTAd7xaahfwlONxbgFuM8ZM0CWnREj466xb3Or40euA58dqFWfH+aULJwJ9jr+0h9QKaN8AJQrCnwW+jPuWdgPIEfmYT+Qq4ae0Afc5/uLVwFeQduK6ApWwOR4583cdoH4MOZEjNAVgswNvB3Y7/vIN1vo4UtefEuLuP9Ou/0bHj+4GbrVWeHgKwNKFHH3kHQ9CK3CXFgwpIQn/ROAu3B/5YZVOx3j/kWyFBgLkSHBdCAMxz2pCTRVWXAp/LXAL4TSx3QrcU27FnwsLAGPMAHIE0u94MLLA2UimoCYJKS6EP4vEoM7D7Xk/SPLdUqTpB5FRAJZtuA8IggRfrgUutZOjKEEJP3bDuRH3QT+AhwC/UsHv6goPTs4YcxtSCDHV8cDUIQkRXcaYZ1JwOpCzPmBUXJ98CNZfGMJ/EnAHEEYeSgdw83gDf4EpAEshILgSN3efFdOIVET1AH7CFUAH8PmIvVNPwsd8EdIcN4ybrPPAcqCzkv9oJiBNWYv0DzwvpIlqBy42xmxUo1Wp0JqeBzwagmVbYDWwxMbaKkZVEG/q+37O87xXgBNxfz5asAQWeJ73iu/7v9flq4xT+Gdbi3Z6SK/QBVxkjPmvSv/DQQbM9gDX4bZkuJipwP3GmDm6hJVxCP9M4EFgZkivkLOm/6tB/ONVQb217/t4nvc60AQcFdLgvReY73nedrUElDEI/xy7838ixNd4BvjmePL9nccAhgziROAFwk3Z3Q1cDqzT2gGljDULkuBzP+Fk+RXoAI41xgSWZu/izHyfdQX6QhzIKVaTn6QKQClD+I8DHg5Z+AeBawi4xqYq6G9hXYE99lmeC6ujBA3AsUCX53mv+r6f1+WuDBH+LHA60vr+gyG/zp3ADyqR7huqArBK4C3P87YjFyRMD3FQ34Wc5WJPCP6iy16xwl8DXIQk+bwv5NdZB3zVGPOnoB9U5eob+b7/Z8/zfg18DgnOhcU7gWOAyZ7n/dr3/QFd/qkX/gYk0r6McDL8itkNnGOM6XTxMNd583uAK5Ba5jCpAb4ArNJW46kX/lbr71+L2zbew9GLXCXW5uqBmRAGvFC9dz/RyGNvQwo7nq1kjrUSecEHOBqp558dwmY4lEHgauCBoP3+UFyAIfGA/0BuFvpMBAb+PUhLp0bP87apS5AK4a9G0tTvBj5CeIHpAnmkw/adrjehTIiTUGe/9Fcisi5ywCbgemCLHhcmVvgL13VfGgGTv8BDwFXGGOfVlJmQJ2MCUl0VpXv/9iLtnX9ojBlUkUmM4GeRY+hbgDkRsDwLrAYuMcaEEherCvOb+74/6HneBuRo8CMRmZB3I/kCU+1R4ZsqPrEX/gnA14F/QWpEMhF5tfVI1eq+sF4gE5EJmoyUWi6M0LrJIwUYNwBrNUAYS8EHmGtdzfm4709xODYj5b0dYb5EVRRGwvf9P1pL4GjgAxGZoAzS+OFE4IOe5/27WgOxEv5GJJX2DqSSL0qt4nZa4X897BeJkkbsAM4HVlkfLSo0AF8EFhpjbkEuYdTYQHQFvwZp27UUmBWxNf628OPwrD/yLsAQk20a8COieQHoILAWCSRtcXleq4y4drJ2zdyIFPNEsU38LuBMYGdUTpkyEZxIrMn2I6R2IIr0AE9a87JdjwxDXzOTgauQ7M6JEX3Ndrvzb43SeslEdEKx5tsTEVYCeeTI8F4ke6tLRdH5OpkEXABchpR8ZyMs/OcSwfySTIQnF+R48NGIxQSGUmjPfS/wmCoCZ4J/HtLkpTWCfv5Qn/98YHsULcVMxCe6EBNYFXEloIrAzXpoRkp2L4yB4BeEf0mUfP5YKYAhSmAlckxIDBRBp40RPAy0abBwXPOftfO/xJr7LRE29YvZZhXVzijHiDIxWggtSAXh4pi8ch4JFr6IdJXdFFRjx4QKfh2SGHYhksLbGBPBB9iIZPi1R/1FMzFbFJOQ2oHTYrae+5GswlXA88BuPTkoae21AmdYv3kaUBuzr7EGuNxVQ49UKQC7SJqA26w5GLeLQPNIM5R1wI+BDcaYHhV802R3+VPtrj8xhnML8BRS1bcvLi+ciemCaUAyva4lnBtaK8F+5MaX9cBzaVIGdqefZIX+RKQF98QYz2UO+AGw3BjTG6cXz8R4EdUgNd23IOm6caagDDYCP0f6ErQnKXhog3lTkOKck63QNxH9SH457t1NwPfimCKeScCiOsHGBZoTIis55A6Fdmsd/ArYDnTGKW5g56YFuRDmGLvbt1hlXZ2QudqHtPF6Oq7Vopm4z4BdaDOR9k5Hkzz2W4Ww21oGv0JyytuidKpgLbKpSObmp+0O34p03alJ4LxsQxrcbo2zpZZJymzYE4KbkeBgNcklBwwgHWTbkaqy15Hcg15rkvbbP5PjwOWsefv75VJXNI619td19tOAtM+eDPwNkrE51f5+fcLHP48E+64D9sb9NCeTpJkxxtQiKaI3E92ikCAVQ84u0MLPwu8XL95yKY7CVxf9XnXRz+qUjXE3cn/AQ8aYRDSPzSRthorKQu+wZqiiVIL1dtffkaTgbCaps2X7wF0HfI3odH9V4kcfknfyvbgd8ZVDVVJnzTYc/SXSe+3jyLmzooyGrUhM6XFjzP8l8QtWJXn27CUkbwA/Af6K9Bh4p65rZQQGkdt5vwTsMsa8ldQvmknLjNrbYOYgiUMLiGeqqRIseeSodRmwMQ2doDNpm2FjTL0165apW6AUUbgQ5jFjTF9avnRV2mbZ9/39nue9AjyLpKJ+JI3joBxk7j+ENBr5Rdo6PmfSPPM2e20hcrY7V92C1Jn7m5EuwhvTevFLJu2rwGZy1QNnIRWGU1U2Ek8bcDsS3e9P80BkdC0cpAiagC8jBR6NOiqJYzdwF/AI0KNNWVQBDKcIskgRy1Lk1uI6HZXY02kF/4dAtwq+KoByFcF0JJvwbFUEsaQLqRK9B9ingq8KYKyKYBpy88w5SBWcEn1T/0G74+/TrsyqACqlCJqBS5CKwyk6KpGiENX/PtJ4tU93fFUAQSgCkFODRVYZLCJ+nWuTxACw2pr6m7X1uioAl8qgGgkYXmitglYdFWd0IJev3A90qJmvCiAKVsFiqwwWoUHDIOixu/0TwAZgUM18VQBRjBVMQO6oP90qgwYdmXGZ+OuQS1XWWt9ed3tVALFRBg3WMjjZKgVNMBqZPrvD/xSp2c+aIhgAAADWSURBVNBIviqARCiDeqQU+bNIm+wZpK+v3nDkkfTctcALyP0IAyr0qgCSHDPIIuXI861CWIDUIaSlIKkHqb3/mRX8diCvPr0qgDQrhBZrGRyFdC+amZD4wSCwA2mx9Wv7syDwusurAlBKKITCdVqzkb6Gs61imBxRSyGPpN+2289vgS1W+Ad1h1cFoIxfMYAEElvspxX48JD/bgrwNbqLPh3Af1ph34Wk4PYNeVdFFYDiWFHUWSVRuKmn8JlgfzZw4LqufEFohzHbu5H773oKQq8me7L4f5HUrlzHUDW1AAAAAElFTkSuQmCC"
}        
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/profile/picture/upload \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "File uploaded successfully.",
    "data": {
        "file_name": "profile_image.png"
    }
}

Profile Picture Download
Profile Picture Download

This API is used to download the user’s profile picture.

The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/user/profile/picture/download/profile_image.png
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
   No inputs
}        
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/profile/picture/download/profile_image.png \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    Display Images
}        

Email Validate
Email Validate

This API is used for user email verification. The API generates OTP and sends the OTP to the user’s email for verification.

The API uses the following attributes:

Attributes
  • email
    stringRequired
    Email address of User for verification purpose
Definition
POST https://test-consumer-api.flexm.com/user/email/validate
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    "email": "john@flexm.com"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/email/validate \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Mail Sent Successfully."
}

Email Confirm
Email Confirm

This API is used to verify the user’s email address by verifying the OTP sent to the email.

The API uses the following attributes:

Attributes
  • email
    stringRequired
    Email address of App User
  • otp
    stringRequired
    One Time Password sent to user email address
Definition
POST https://test-consumer-api.flexm.com/user/email/confirm
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    "email": "john@flexm.com",
    "otp": "123456"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/email/confirm \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Verified OTP successfully."
}  
Change Mobile
Change Mobile

This API is used to change the user’s new mobile number and sent otp to the new user’s mobile number.

The API uses the following attributes:

Attributes
  • new_mobile_no
    stringRequired
    The User New Mobile Number provided
Definition
POST https://test-consumer-api.flexm.com/user/mobile/change
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    "new_mobile_no": "93667047"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/mobile/change \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "OTP sent to your new mobile number successfully."
}  
Confirm Mobile
Confirm Mobile

This API is used to change the user’s mobile number.

The API uses the following attributes:

Attributes
  • new_mobile_no
    stringRequired
    The User New Mobile Number provided
  • otp
    stringRequired
    OneTime Password sent to user new mobile
Definition
POST https://test-consumer-api.flexm.com/user/mobile/confirm
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    "new_mobile_no": "93667047",
    "otp":"123456"

}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/mobile/confirm \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Mobile number changed successfully."
}  
Account - Closure
Account Closure
Account Closure

This API uses the unique user id to request an account closure.

The API has no Attributes

Definition
POST https://test-consumer-api.flexm.com/user/wallet/close/account
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
    No inputs
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/close/account \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Account Closure request received successfully. Please visit nearby store for confirmation."
}
SGQR
SGQR Scan Code
SGQR Scan Code

This API is used to retrieve the QR merchant user information.

The API uses the following attributes:

Attributes
  • qr_code
    stringRequired
    QR Code
Definition
POST https://test-consumer-api.flexm.com/user/sgqr/scancode
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
   "qr_code":"0002010102112629MERCHANTID0001.LOCATIONID000151800007SG.SGQR011220031201D971020701.00010306238863040202050256060400000708202003125204739953037025802SG5917FLEXM LUCKY PLAZA6009Singapore63042846"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/sgqr/scancode \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "QR retrieved successfully.",
    "data": {
        "Payload Format Indicator": "01",
        "Point of Initiation Method": "11",
        "Merchant Account Information": "MERCHANTID0001.LOCATIONID0001",
        "SG Merchant": {
            "Global Unique Identifier": "SG.SGQR",
            "SGQR ID Number": "20031201D971",
            "Version": "01.0001",
            "Postal Code": "238863",
            "Level Number": "02",
            "Unit Number": "56",
            "Miscellaneous": "0000",
            "New Revision Date": "20200312"
        },
        "Merchant Category Code": "7399",
        "Transaction Currency": "702",
        "Country Code": "SG",
        "Merchant Name": "FLEXM LUCKY PLAZA",
        "Merchant City": "Singapore",
        "CRC": "2846"
    }
}
User - KYC
KYC Validate
KYC Validate

This API is used to submit user’s KYC documents.

The API uses the following attributes:

Attributes
  • full_name
    stringRequired
    User's Full Name
  • birth_year
    stringRequired
    Birth Year of User
Definition
POST https://test-consumer-api.flexm.com/user/kyc/validate
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{       
    "full_name":"John Doe",
    "birth_year":"2003"     
}     
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/kyc/validate \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Documents submitted for KYC successfully."
}
KYC Initialize
KYC Initialize

This API creates an Onfido application ID for the user and store the information from Onfido for KYC process. The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/user/kyc/initialize
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
   No inputs
}        
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/kyc/initialize \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Kyc application created successfully.",
    "data": {
        "id": "f14c1c52-cd3b-43ec-a946-23e991462f0a",
        "createdAt": "2020-09-26T12:43:59Z",
        "sandbox": true,
        "firstName": "John",
        "lastName": "Doe",
        "email": null,
        "dob": null,
        "deleteAt": null,
        "href": "/v3/applicants/f14c1c52-cd3b-43ec-a946-23e991462f0a",
        "address": null,
        "idNumbers": []
    }
}
Info Update
Info Update

This API is used to update user’s KYC information.

The API uses the following attributes:

Attributes
  • nationality
    stringRequired
    User's Nationality
  • birth_date
    stringRequired
    Birth Date of User
  • document_expiry_date
    stringRequired
    Document Expiry Date
  • document_issue_date
    stringRequired
    Document Issue Date
  • document_number
    stringRequired
    Document Number
  • document_type
    stringRequired
    Document Type
  • name_on_document
    stringRequired
    Name on Document
  • scan_reference
    stringOptional
    Scan Reference from jumio / Check ID from Onfido
Definition
POST https://test-consumer-api.flexm.com/user/kyc/info
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{       
    "nationality":"Indian",
    "birth_date":"2003-02-22",
    "document_expiry_date":"2020-02-27",
    "document_issue_date":"2020-02-02",
    "document_number":"51524618181",
    "document_type":"DriverLicense",
    "name_on_document":"John",
    "scan_reference":"QWERTGH5"      
}     
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/kyc/info \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "KYC information updated successfully."
}
Single File Upload
Single File Upload

This API is used to upload the user’s KYC single file

The API uses the following attributes:

Attributes
  • image_key
    stringRequired
    Image Name (face-to-face-image / selfie-photo-url / id-document-images / address-proof-images)
  • image_type
    stringRequired
    Image Type of the file
  • image_base64
    stringRequired
    Base64 Image
Definition
POST https://test-consumer-api.flexm.com/user/kyc/upload
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    "image_key":"face_to_face_image",
    "image_type":"image/png",
    "image_base64":"iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAYAAABccqhmAAAgAElEQVR42u2dfXRdVZXAf+8lxqwYs7pirLXGGDuldmqtlVVLxdK5llqR4ftrKN8IiIiIwGJhh6k96EIWwyAWVL4tXwVEFkIXFqy1XDu1lk6ptVOZTgglq2Y6sZPJCjFmYn0+5o99Hn1N85qX5N1zv/ZvrbdSStt73zln77P3Pnvvk0FJJMaYeqCx6DMBqLf/uwaoG+av9QF5YNB+eoGewk9jzICObLLI6BDESqgLv6wHpgCtQDPwYaCl6NNkhbzSDFqFsAfotD9/D+wF2oE2oH/IuyqqAJQxCHsWqLZCPhP4uP05E5gKZCP42nmgA9hlP78DtgM7gZwxJq8zqwpAGX5nzwINwDzg08AC4Mgisz3O9FtFsAV42f7cA+TVUlAFkOYdvtEK+t8BRwOzAjLdo2oprAdeAnygSxWCKoCk7/LVwHTgOODv7W5fq6NDHngVWAc8Zy2EQXUZVAEkQejrgPnAiVbwp0TUf48SXcBaqwzWA32qDFQBxEnoa4C5wBLgFGCyjsyY6QPWAKusq9CvboIqgKia9zOBfwBOI7qR+jizF3gaeALYBuxXZaAKIEzBLwTyTgMuQ6L2KvRuYgY7gJXAk0C3ugiqAFwKfjUwwwr9WcBEHZXQ6LVWwYPANmPMfh0SVQBBmfn1wPHA5cjxXbWOTGTIIacHK4DngQF1D1QBVErwJwBnA1cjx3hKtNkJ3GXdgz5VBKoAxir4TcAFwFVISq4SL3YDdwMP2TiBjogqgLIEfxJwqTX1m3VUYk8HcAfwCNCrikAVQCnBb7A7/g0q+IlkF3ArEjTUfAJVAG8Lfy2SpbcMOcpTks124FvAGmPMoCqA9Ap+NTAHWA4sQqP6aSKHpBsvA3YYY3KqANJl7jcDN1qTv07lIbX0A/cBtwN70+YWVKVQ+Out0D8MHAu8Q2Ug1dQAnwJOB970PK/N9/2/qAWQPMHPArORINBCNGVXOZQ88CISBH41DenFVSkR/gbgK9bU+yga/FRKb4hHIOndec/zdvq+/2e1AOK968+y/p2nu74ySjYC1wNbkmoNVCVY+GuBC5GKsZm66ytjoAU4A8h5nrfD9/3EFRplEij4IBH+m4Fz0KM9pXKxgWuA9iRZA5mECX/Wmvor7K6fNnLDfPJFi3ikhVtQloWW5Nkhv65OuRvViQQIn05K2XEmQcJfjwT6liIpvUkX9AHkDHs30lDzNaRjTjcHbvQZsJ8c0pd/sIwxrEEalRZ+XWd/3VD0swn4AFIz0WJ/1hZ9ksx+JJi83BjTowogGiZ/C1LscUoCd6i8FeIeJIX1FSvwbcBuY0x/BOag1s5BK1Iu/WmkJ2KTVSBJtBrWA1cCu+KcPJSJufBnkdz9e0lODn/e7uxdwGbgV1bwd8bpbj5jTJ11w+Yg9x4kUSHsBq4A1sU1LpCJsfBX2x3/LmuCxt2kL+zwPwM2IPnpiYk6FymEecDJSFLWhAQog17gOuCRONYTZGK6mGqALyGR/voYC/0+pNX1c8AmoDMNuejWcpuKBGxPt9bbBOJ7YjNo1+J34naDciaGi6cBKeL5GvG7Ritvd/rNwI+RarSuNNelW2XQgqRnn4pckRZHyyAHPAAsNcb0qgIIZrE0Ill9F8RsgQwiQbtHgdUk7Cy5wspgGpKKuwS5RSluSv5x4GpjTLcqgMoujknW3z8jRrt9rzXxHwbWRyFiHzNLbzFwcZFVEBeeBy43xuxVBVCZxdCMRPqPj4ngd9md4GFSUlUWsFUwCzgX6cw8OSbWnw9cbIzpUAUwvgXQagVpQQwEfw/SeHIl0KE95wJZC5cB5yHp3lFXBBuAS6zLpwogocKfR86D7wcei4PZF3MlAJJwdAkSC4q6IthqrZe2KCqBjAr/uOgCfgjcbYzpVPEMRRHEwSKIrBLIqPCPiR6ktfQK6+OrRIarCKYgyTjnEN1gYSSVQCaCE9qM3AUfReHfj+SAfwvYrMG9SK2bLHJasMyunVpVAjFTAMaYycgtr8dF1M+/zfr5AypykVUEdUgewfVIYVLU3ILNwJKonA5kIjRxE5HoedSO+vqQI71bo36koxyymVwFfBFojNjrbQDON8bsCftFqiIyWY3IJY4nR2zX/x1Sc/C9JNR+pwnf9//oed5LwMvADOD9EdrwPgR8zPO8n/u+H2pyWCYCwl9vTesvRWj9DCJBvhujoKWViliXS4EvEK1mMc8Cl4WZNlwV8sTUAF8Hro6Qr7YX+Cfgm8aY/1XxSYQ18CfP834B7AQ+hvQliII1MB2Y7HneS77vh3JHYSZE4c/aXf92ohGxzSEluYU20Co5ybQGWoCbkLTiqJwU/AC4PozgclWIwl9o5vGuCExAv52Eq4wxr/m+r5KSXGvgTc/zXkB6Jx5FNO6F/AQw4HneZt/384lWAHZn/SRSGvueCAx+G/BVJNCn1XrpUAJ/9TzvFaQD0yetSxAmhRyGDnsb0VuJdQGsCfYc0hIqTPLIccwVxphdKhapdQmmIxmdCwm/I1E30iFpgysXNOt4sBuQ7r1hC38OicCeq8KfegWwC8nOewA5/QmTJuQ4fEriXAAb8V+GVHGFGYHdj2QbftUY8z8qAorv+wP2lOBNpGlpmMHB9wIf9jxvjYuLSascCX8Wibp+G3hHiIM7APwz8A1jzB916StFSiDned4W5Bj4GMINDh6B3Ee4MeigoCsXYCaS7BOmZu1Bjvhu1lx+pcRGlQceAy63iiAsssC1wIKgYwFZB4PaiARZwuzd34lc4HBPknrtK4EpgWesq9oR4qvUI/GyQOWmKuDBrAa+gQRZwqLdTubzxpi3dIkrZbgDeJ7XjlzDdjThHRO+D6jzPG+d7/t/DeIBmQCFHyTZ54kQTf92pDHjRl3Wb5fKNnPgUs9iP3fA7njdSAXkvjjedBPAmM1BmtPMCOkVBu0G+kwQ7kCQCqAFeAmHRxpD6AAuNMZs0EVsJnGgxfYMYGKJP1poZd5tx++XwBrkXsJcisdvHpK4NjWkV9gNfCaIwrRMQANWg7TxviikAduD9Ipbm/Jbd1qRxplLkAs3xhLz6bVK4DZge1rH0xiz0FoCzSG9wuPAJSNd8R56DMAukNOB5YRTa7DPCv+LKV6s1Z7nnWV3rVMZX/VbLVJBdwbQ4Hneb8KqXAsTz/PeAF4HjiWc+pW/BV73PO+3laxVCeIUoBm5KDGMK536kKO+NSkW/sINSiuRrrmVogn4R+A5Y8zsFI4ryI0/11mryDXVSBVjRS2QqgoPUrU1FReFFCz5JnBfWpt1WpP/J8BJBJPXnkG62Zzged4bnuftSlPlpO/7b3met9MqgIW4T2qbAFTbU4GKrPFsBRcfVvAvCGFucsA9wJ1pDVbZnX8VMMfB45qRdOqzUjjOeaRu4Lt23bnm0krOcSVdgAlIu2zXpn8eKexZXukASYwW5QRr8s9z+NhG4PvGmAUpHO8ccItdd66tzTokm7UiqcpVFRqQLNKB9cIQ5uMVJDq6L6XCnwW+Y3fjbAiL8SjP81b7vt+XpnH3fX+/53kvI3cQTHb8+A8Bb9iAbCQsgGlI8M01nUgXnzQ37lyAXI0VVk/F6cBNVhGlTfnusRuf6/WXRU7ZJlfiHxrvIBSik67TJfuRTq+b0yr51gy8GckbD4tCpaeX0mnYbNehawuoBbjByl+oFsB8JOXXJTmkh9+TKW/eeREwNwLvUYc0tUyjFQDwFHAn7oOCX7AWWDgKwGb8LcV94G8TclNPmtNTa5AKx+qIvNIC3JxARHEucsjxt+/40fXjtQLGq7EXI+ehLumyu03ab+qZR3i56aWsgFNTrJD7gBtw30fgDKTfhlsFYP3PGx3vQPuR45ctKGcSvRtwT0ijG1DENuBWu05dUQssHasVkB2j8INkm7n2P9cAD6T90g77/b0IvlprxKySMOblAbtOXXIKcKRLC6AWuAa3R0+dwDJt5wUcqOePGrXjMUcTogQGkLjYboePrRmrFTBWAV6M24DPfuQKsZ0q+4DU9NdE8L2qCa//Q5SUwC4kK9ZlZuoJjCETNDuGL1cTwu7vq+l/EI1EJ/o/lA/q9ADwJLDOsfId9YnAWIR4AXL274puJM9fr+06QB3RuU15KBN0esDWpdyMdKN2xeLRumDZUX6pauQqb1e7T6FNs0b9K+O6udqJFGEL8AjuCoZqkKvuskEtpGlWy7hiN3BHWuv7D8MA7qvQyqVXp+ftDTOPtPZ2GRA8m1G0Es+O4suANJV0FXzKAStSXuhTin2EU4teDn/Q6TlIbvYgAWxXuQENwEXlxsuyo/yHz3Y4dlut+aQcSldEFUDe8W4XF1y7sZdQZoHYaBTA8bjriDoI3GbTK5XhXaMopkIPAnrb8qFWQD+SIegqh2UKkqhXGQVgg3+XOByzzbjPporTgtoPrI/gq/WguRqlWIcUsbniynKOBMu1AGYgx38uGABuT2t7r1Hw8wi6Aet03koq7UHkjkxXVsA8ykjWy5bx4uA2+LcBWKtLZkTWIsHAqLAf6UisHH7OXDWwyQJLRgoGlmMBuAz+DSDHfnqD78iKuRu5LSYqx4FtuM18i6vrtgJ3KcKncfD9j2NSAAtxd7X3NmsBKOVxP9E4d88Bd2mhVtlWwFZHz2oeyXXPjqCxssDJDk3Ie9WHHPWuuyICVsAW5KhLKS8WcIdDK2DJ4TIDR7IA6pDjPxe0A6t1iYxqMYG0BA+zMWoPcJ3u/qPiReBVR886ybrxY1IA8yl9lXQlyQMr9dx/TEqgH2lN3RmS6b+cFHdmHuOcDSAXt7qw3CYcbhPPjrC7nO5oTPYBT+vSGPOC2oZcyrLPsfB/F7mLUSdh9DyDZHSG6gYczgKoRZoMuDKJOnRNjIv1yLXo+xwJ/3eQDk16YjM29uAu2W0R0kNiVApgHm6i/wPAKt1FKhIPWI105m0L8FF9SEn4Mg3Yjnu+HkUuuAmaWkp0784e5uXOdDQWbcBGXRKVWVTGmE3AZ61LVWkfcydyKnSP7vwVYROw3dGzPjfcJlvKAqjGTd1/HnhUd5KKK4I9NiZwPpUpzukGvg0ca4zxtT9DxeYph9zq7CKlezHDNGspVSwwBTfNHXuB53UpBLK4BoDHjTFrkVjOycAspHV3OQlgPcAO4CXkjL9DBT8Q1lgFG7S73Wznf1s5CmABbtpObUXO/5XgFEE38JAx5nHkSKgV6SH/AeR8uMHOdb/9/Le1GnYAvXq+Hzhd1gU+w5EVcJACyAyzYLLAKoLP/88hJYv36RpQUq6kz7OuQND9FDcAnym25Ibb5bO4Kf3tQY7/FCXt+Lhp8DKPIV2bh1MA04HJDl5mE3IWqihppxM32ZQ1Qzf34RSA5+BF8sBP9exfUd4+dn8ON6cBnyqpAOyLHOvgJXrRs39FKWYdbkq75xZvvNlh/H8Xt/60E2y2mqLEjT0MidAHxGyKunsNVQAtQJODl1irZ8qKcoj1/UsHj5qAXPAzrAKY5eAFBpDkEkVRDmYzbpqGzi2lAGY7eHifI1NHUeLGNkdxgKMOUQDWBPm4g4fvQO+PU5Th3IBeKx+BWwCFQGCxBZB15AL8qx7/KUpJXLjHM7DdgosVQAPBFwANold9K8rh2OQgDlBTkPViBTCL4AuA+nFX/6wocWS7Ixd56nAKIGjaiNZtNooStThAv6M4wPShCuAIF9pN/X9FGREXp2RHDFUALQE/MA/8VudWUUbkdwRfF3DABbC7ctAKYBBt/qEo5dBO8DcHTYODGxC0BvzA/Wj5byV9xRbgXqTjaxTIA7faFmTK+Oi0CqA+wGdMMsY0FBRAAyX6hlfYAtirc1sx6pDCrfoIKYCHdVoqQhduUoKnZh35/wD92l9OUcqy7vJIo9CgmZx1ZP6Dm5ZHipIUXMjLRJcKQPP/FSVa8tJYUADvd+EC6JwqStm4uCm7rqAAXASS9PYfRSkfJ1evFRRAg4NnaQBQUSImLy4VgF4mqSgptgAURYkYLmMA6gIoSvn8KWkKQF0ARYmoC1Cv460o6XUBJuhQKEp6FYCiKKoAFEVJowLQNF1FSbECyOlQKIq6AIqiqAJQFEUVgKIoqVAAeQfPqtHhVpSyqXapAFy0H6rTOVWUsnm3SwXQreOtKOl1AVxYAOoCKEpEXQAXFoC6AIpSPvUuFcAf1AJQFLUAYq/RFCUhuOjSlXOpABp1ThWlbFyU6HeqAlCUaOJCXjoKCqDLhQtgjKnVeVWUw2OMyQJNDh61p6AAOgi+B1kt0KzTqygjMpHgY2a5Yhdgv1UCQVIDTNa5VZQRabYbZqD+vzFGgoDGGIB2BxbAFJ1bRRmRKQ4UwB44uBqwLeAHZoFP6Nwqyoh8lODzADqGKoDXHHyxI3VuFWVE5jh4xmuuLQCAacYYPQ5UlBIYY+qBWQ4etXOoAmh38NB6YLZOs6KUZBZukoC2D1UAnQTfHbjOkXmjKHE2/4MunOthmCBgrqAVAuYYnWNFKcnfEXyrvp3YLmDZIt8DYIuDLzjbGKPXkSvK8P6/Cwt5u5X3QzTNyw4e3qhxAEUZfnPETQ3Abwq/GKoAtjp4eB2wQOdaUQ5hLm7K5neUUgAdwF4HL/B5W/CgKMoBF/wzDh41CLxaSgHkHVkB09G0YEUpZpIj/38LRYV/2WG00L85eIkGYJ7OuaK8jYebEmDfGJMvZQEAbHbwEtXAiYVIpKKo+c+puOkD+FLxf2RLmAgurgtfYM0eRUk7E4H5Dp7Tx5Cj/uEUQD+w0cHLNAELde4VhQWOzP/NSBCwtAKw/sELjtyAM9UNUBROxU3b/JeK/f9SFgDAWtxcGDoPbROmpNv/n4i7vJj1Q3+jlAJox011YBOwWJeBkmIW2RhA0HQzTK1PKQWQs1aACzfgQmNMta4DJYW7fxa42JH5v97K9cgKwPrlLzgah9loibCSTo5E0n9d8OOh/v/hLACQk4A+By/WACzRtaCkkHNxcwVYP7BuuP+RHeEvrXU0EKfYYIiipMX8nwSc5uhx60pt5tnDvGAeWOXoBSc7HAxFiQIn4O6ejGHN/5EsgILm2OfgBauBy4wxdboulBTs/jVI8M9F8HvgcJZ8toy//KyjcZkBHK/LQ0kBHu6a4qxHegCOXgFYs+EJRy9aC1yhR4JKwnf/auAagm/8WeC5UuZ/ORYASP5wu6OXnYt2C1KSzQLcFP6ABP6eP9wfKEcBDAJPO3rheuAqtQKUBO/+V+Gm7RfAakaI4WXLeGmsG5Bz9NKLrI+kKEljPu4qYPPAg4cz/8u1AEB6iG1waAVcYyOlipKk3f9q3CT+gDT+3DTSH8qW+fI54PuO/SS1AhTd/cfOSop6/43XAgB4Edjl0Aq4XvMClITs/rXA9Q53/17gqXJ6bYxGAQwA9zu2As7Q5aMkgNMc7/7PUmYCX9kKwGqTxzhMUkGFqQFusDnTihLX3X8isBTJc3FBHlg5UvBvLBYASFOBxx2O33TgSm0bpsRU+AGuRLJcXbGVUXT2zo7yC+WBuxnSWDBAssClyJ3pihI3ZgFfJPjbfotZQRnBv7FaAABtwBqHX2gScJMGBJWY7f411vR36cK+CqwejcWcHcMXywG3jUbLVIDjgHN0WSkx4iSk5NclKxjlnR5jNU22ImmGrqgFlhpjpum6UmKw+7cC38Jdym/BMn9ytPGy7Bi/YA642WEsAOQy0eWaIajEwPS/CXC9Wd3OGFr4jSc4sRN3RUIFTgMu0FMBJcKcB5yF28Df9rHs/uNSANYKuBU39wgWuwLLcNdMQVFGIxMz7PqsdfjYnHU3xtTAd7xaahfwlONxbgFuM8ZM0CWnREj466xb3Or40euA58dqFWfH+aULJwJ9jr+0h9QKaN8AJQrCnwW+jPuWdgPIEfmYT+Qq4ae0Afc5/uLVwFeQduK6ApWwOR4583cdoH4MOZEjNAVgswNvB3Y7/vIN1vo4UtefEuLuP9Ou/0bHj+4GbrVWeHgKwNKFHH3kHQ9CK3CXFgwpIQn/ROAu3B/5YZVOx3j/kWyFBgLkSHBdCAMxz2pCTRVWXAp/LXAL4TSx3QrcU27FnwsLAGPMAHIE0u94MLLA2UimoCYJKS6EP4vEoM7D7Xk/SPLdUqTpB5FRAJZtuA8IggRfrgUutZOjKEEJP3bDuRH3QT+AhwC/UsHv6goPTs4YcxtSCDHV8cDUIQkRXcaYZ1JwOpCzPmBUXJ98CNZfGMJ/EnAHEEYeSgdw83gDf4EpAEshILgSN3efFdOIVET1AH7CFUAH8PmIvVNPwsd8EdIcN4ybrPPAcqCzkv9oJiBNWYv0DzwvpIlqBy42xmxUo1Wp0JqeBzwagmVbYDWwxMbaKkZVEG/q+37O87xXgBNxfz5asAQWeJ73iu/7v9flq4xT+Gdbi3Z6SK/QBVxkjPmvSv/DQQbM9gDX4bZkuJipwP3GmDm6hJVxCP9M4EFgZkivkLOm/6tB/ONVQb217/t4nvc60AQcFdLgvReY73nedrUElDEI/xy7838ixNd4BvjmePL9nccAhgziROAFwk3Z3Q1cDqzT2gGljDULkuBzP+Fk+RXoAI41xgSWZu/izHyfdQX6QhzIKVaTn6QKQClD+I8DHg5Z+AeBawi4xqYq6G9hXYE99lmeC6ujBA3AsUCX53mv+r6f1+WuDBH+LHA60vr+gyG/zp3ADyqR7huqArBK4C3P87YjFyRMD3FQ34Wc5WJPCP6iy16xwl8DXIQk+bwv5NdZB3zVGPOnoB9U5eob+b7/Z8/zfg18DgnOhcU7gWOAyZ7n/dr3/QFd/qkX/gYk0r6McDL8itkNnGOM6XTxMNd583uAK5Ba5jCpAb4ArNJW46kX/lbr71+L2zbew9GLXCXW5uqBmRAGvFC9dz/RyGNvQwo7nq1kjrUSecEHOBqp558dwmY4lEHgauCBoP3+UFyAIfGA/0BuFvpMBAb+PUhLp0bP87apS5AK4a9G0tTvBj5CeIHpAnmkw/adrjehTIiTUGe/9Fcisi5ywCbgemCLHhcmVvgL13VfGgGTv8BDwFXGGOfVlJmQJ2MCUl0VpXv/9iLtnX9ojBlUkUmM4GeRY+hbgDkRsDwLrAYuMcaEEherCvOb+74/6HneBuRo8CMRmZB3I/kCU+1R4ZsqPrEX/gnA14F/QWpEMhF5tfVI1eq+sF4gE5EJmoyUWi6M0LrJIwUYNwBrNUAYS8EHmGtdzfm4709xODYj5b0dYb5EVRRGwvf9P1pL4GjgAxGZoAzS+OFE4IOe5/27WgOxEv5GJJX2DqSSL0qt4nZa4X897BeJkkbsAM4HVlkfLSo0AF8EFhpjbkEuYdTYQHQFvwZp27UUmBWxNf628OPwrD/yLsAQk20a8COieQHoILAWCSRtcXleq4y4drJ2zdyIFPNEsU38LuBMYGdUTpkyEZxIrMn2I6R2IIr0AE9a87JdjwxDXzOTgauQ7M6JEX3Ndrvzb43SeslEdEKx5tsTEVYCeeTI8F4ke6tLRdH5OpkEXABchpR8ZyMs/OcSwfySTIQnF+R48NGIxQSGUmjPfS/wmCoCZ4J/HtLkpTWCfv5Qn/98YHsULcVMxCe6EBNYFXEloIrAzXpoRkp2L4yB4BeEf0mUfP5YKYAhSmAlckxIDBRBp40RPAy0abBwXPOftfO/xJr7LRE29YvZZhXVzijHiDIxWggtSAXh4pi8ch4JFr6IdJXdFFRjx4QKfh2SGHYhksLbGBPBB9iIZPi1R/1FMzFbFJOQ2oHTYrae+5GswlXA88BuPTkoae21AmdYv3kaUBuzr7EGuNxVQ49UKQC7SJqA26w5GLeLQPNIM5R1wI+BDcaYHhV802R3+VPtrj8xhnML8BRS1bcvLi+ciemCaUAyva4lnBtaK8F+5MaX9cBzaVIGdqefZIX+RKQF98QYz2UO+AGw3BjTG6cXz8R4EdUgNd23IOm6caagDDYCP0f6ErQnKXhog3lTkOKck63QNxH9SH457t1NwPfimCKeScCiOsHGBZoTIis55A6Fdmsd/ArYDnTGKW5g56YFuRDmGLvbt1hlXZ2QudqHtPF6Oq7Vopm4z4BdaDOR9k5Hkzz2W4Ww21oGv0JyytuidKpgLbKpSObmp+0O34p03alJ4LxsQxrcbo2zpZZJymzYE4KbkeBgNcklBwwgHWTbkaqy15Hcg15rkvbbP5PjwOWsefv75VJXNI619td19tOAtM+eDPwNkrE51f5+fcLHP48E+64D9sb9NCeTpJkxxtQiKaI3E92ikCAVQ84u0MLPwu8XL95yKY7CVxf9XnXRz+qUjXE3cn/AQ8aYRDSPzSRthorKQu+wZqiiVIL1dtffkaTgbCaps2X7wF0HfI3odH9V4kcfknfyvbgd8ZVDVVJnzTYc/SXSe+3jyLmzooyGrUhM6XFjzP8l8QtWJXn27CUkbwA/Af6K9Bh4p65rZQQGkdt5vwTsMsa8ldQvmknLjNrbYOYgiUMLiGeqqRIseeSodRmwMQ2doDNpm2FjTL0165apW6AUUbgQ5jFjTF9avnRV2mbZ9/39nue9AjyLpKJ+JI3joBxk7j+ENBr5Rdo6PmfSPPM2e20hcrY7V92C1Jn7m5EuwhvTevFLJu2rwGZy1QNnIRWGU1U2Ek8bcDsS3e9P80BkdC0cpAiagC8jBR6NOiqJYzdwF/AI0KNNWVQBDKcIskgRy1Lk1uI6HZXY02kF/4dAtwq+KoByFcF0JJvwbFUEsaQLqRK9B9ingq8KYKyKYBpy88w5SBWcEn1T/0G74+/TrsyqACqlCJqBS5CKwyk6KpGiENX/PtJ4tU93fFUAQSgCkFODRVYZLCJ+nWuTxACw2pr6m7X1uioAl8qgGgkYXmitglYdFWd0IJev3A90qJmvCiAKVsFiqwwWoUHDIOixu/0TwAZgUM18VQBRjBVMQO6oP90qgwYdmXGZ+OuQS1XWWt9ed3tVALFRBg3WMjjZKgVNMBqZPrvD/xSp2c+aIhgAAADWSURBVNBIviqARCiDeqQU+bNIm+wZpK+v3nDkkfTctcALyP0IAyr0qgCSHDPIIuXI861CWIDUIaSlIKkHqb3/mRX8diCvPr0qgDQrhBZrGRyFdC+amZD4wSCwA2mx9Wv7syDwusurAlBKKITCdVqzkb6Gs61imBxRSyGPpN+2289vgS1W+Ad1h1cFoIxfMYAEElvspxX48JD/bgrwNbqLPh3Af1ph34Wk4PYNeVdFFYDiWFHUWSVRuKmn8JlgfzZw4LqufEFohzHbu5H773oKQq8me7L4f5HUrlzHUDW1AAAAAElFTkSuQmCC"
}        
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/kyc/upload \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "File uploaded successfully.",
    "data": {
        "file_name": "face_to_face_image.png"
    }
}
Multi File Upload
Multi File Upload

This API is used to upload the user’s KYC multi file.

The API uses the following attributes:

Attributes
  • image_key
    stringRequired
    Image Name (id-document-images, address-proof-images)
  • image_index
    numberRequired
    Image index in which the file has to updated
  • image_type
    stringRequired
    Image Type of the file
  • image_base64
    stringRequired
    Base64 Image
Definition
POST https://test-consumer-api.flexm.com/user/kyc/upload
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    "image_key":"address_proof_images",
    "image_index":0,
    "image_type":"image/png",
    "image_base64":"iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAYAAABccqhmAAAgAElEQVR42u2dfXRdVZXAf+8lxqwYs7pirLXGGDuldmqtlVVLxdK5llqR4ftrKN8IiIiIwGJhh6k96EIWwyAWVL4tXwVEFkIXFqy1XDu1lk6ptVOZTgglq2Y6sZPJCjFmYn0+5o99Hn1N85qX5N1zv/ZvrbdSStt73zln77P3Pnvvk0FJJMaYeqCx6DMBqLf/uwaoG+av9QF5YNB+eoGewk9jzICObLLI6BDESqgLv6wHpgCtQDPwYaCl6NNkhbzSDFqFsAfotD9/D+wF2oE2oH/IuyqqAJQxCHsWqLZCPhP4uP05E5gKZCP42nmgA9hlP78DtgM7gZwxJq8zqwpAGX5nzwINwDzg08AC4Mgisz3O9FtFsAV42f7cA+TVUlAFkOYdvtEK+t8BRwOzAjLdo2oprAdeAnygSxWCKoCk7/LVwHTgOODv7W5fq6NDHngVWAc8Zy2EQXUZVAEkQejrgPnAiVbwp0TUf48SXcBaqwzWA32qDFQBxEnoa4C5wBLgFGCyjsyY6QPWAKusq9CvboIqgKia9zOBfwBOI7qR+jizF3gaeALYBuxXZaAKIEzBLwTyTgMuQ6L2KvRuYgY7gJXAk0C3ugiqAFwKfjUwwwr9WcBEHZXQ6LVWwYPANmPMfh0SVQBBmfn1wPHA5cjxXbWOTGTIIacHK4DngQF1D1QBVErwJwBnA1cjx3hKtNkJ3GXdgz5VBKoAxir4TcAFwFVISq4SL3YDdwMP2TiBjogqgLIEfxJwqTX1m3VUYk8HcAfwCNCrikAVQCnBb7A7/g0q+IlkF3ArEjTUfAJVAG8Lfy2SpbcMOcpTks124FvAGmPMoCqA9Ap+NTAHWA4sQqP6aSKHpBsvA3YYY3KqANJl7jcDN1qTv07lIbX0A/cBtwN70+YWVKVQ+Out0D8MHAu8Q2Ug1dQAnwJOB970PK/N9/2/qAWQPMHPArORINBCNGVXOZQ88CISBH41DenFVSkR/gbgK9bU+yga/FRKb4hHIOndec/zdvq+/2e1AOK968+y/p2nu74ySjYC1wNbkmoNVCVY+GuBC5GKsZm66ytjoAU4A8h5nrfD9/3EFRplEij4IBH+m4Fz0KM9pXKxgWuA9iRZA5mECX/Wmvor7K6fNnLDfPJFi3ikhVtQloWW5Nkhv65OuRvViQQIn05K2XEmQcJfjwT6liIpvUkX9AHkDHs30lDzNaRjTjcHbvQZsJ8c0pd/sIwxrEEalRZ+XWd/3VD0swn4AFIz0WJ/1hZ9ksx+JJi83BjTowogGiZ/C1LscUoCd6i8FeIeJIX1FSvwbcBuY0x/BOag1s5BK1Iu/WmkJ2KTVSBJtBrWA1cCu+KcPJSJufBnkdz9e0lODn/e7uxdwGbgV1bwd8bpbj5jTJ11w+Yg9x4kUSHsBq4A1sU1LpCJsfBX2x3/LmuCxt2kL+zwPwM2IPnpiYk6FymEecDJSFLWhAQog17gOuCRONYTZGK6mGqALyGR/voYC/0+pNX1c8AmoDMNuejWcpuKBGxPt9bbBOJ7YjNo1+J34naDciaGi6cBKeL5GvG7Ritvd/rNwI+RarSuNNelW2XQgqRnn4pckRZHyyAHPAAsNcb0qgIIZrE0Ill9F8RsgQwiQbtHgdUk7Cy5wspgGpKKuwS5RSluSv5x4GpjTLcqgMoujknW3z8jRrt9rzXxHwbWRyFiHzNLbzFwcZFVEBeeBy43xuxVBVCZxdCMRPqPj4ngd9md4GFSUlUWsFUwCzgX6cw8OSbWnw9cbIzpUAUwvgXQagVpQQwEfw/SeHIl0KE95wJZC5cB5yHp3lFXBBuAS6zLpwogocKfR86D7wcei4PZF3MlAJJwdAkSC4q6IthqrZe2KCqBjAr/uOgCfgjcbYzpVPEMRRHEwSKIrBLIqPCPiR6ktfQK6+OrRIarCKYgyTjnEN1gYSSVQCaCE9qM3AUfReHfj+SAfwvYrMG9SK2bLHJasMyunVpVAjFTAMaYycgtr8dF1M+/zfr5AypykVUEdUgewfVIYVLU3ILNwJKonA5kIjRxE5HoedSO+vqQI71bo36koxyymVwFfBFojNjrbQDON8bsCftFqiIyWY3IJY4nR2zX/x1Sc/C9JNR+pwnf9//oed5LwMvADOD9EdrwPgR8zPO8n/u+H2pyWCYCwl9vTesvRWj9DCJBvhujoKWViliXS4EvEK1mMc8Cl4WZNlwV8sTUAF8Hro6Qr7YX+Cfgm8aY/1XxSYQ18CfP834B7AQ+hvQliII1MB2Y7HneS77vh3JHYSZE4c/aXf92ohGxzSEluYU20Co5ybQGWoCbkLTiqJwU/AC4PozgclWIwl9o5vGuCExAv52Eq4wxr/m+r5KSXGvgTc/zXkB6Jx5FNO6F/AQw4HneZt/384lWAHZn/SRSGvueCAx+G/BVJNCn1XrpUAJ/9TzvFaQD0yetSxAmhRyGDnsb0VuJdQGsCfYc0hIqTPLIccwVxphdKhapdQmmIxmdCwm/I1E30iFpgysXNOt4sBuQ7r1hC38OicCeq8KfegWwC8nOewA5/QmTJuQ4fEriXAAb8V+GVHGFGYHdj2QbftUY8z8qAorv+wP2lOBNpGlpmMHB9wIf9jxvjYuLSascCX8Wibp+G3hHiIM7APwz8A1jzB916StFSiDned4W5Bj4GMINDh6B3Ee4MeigoCsXYCaS7BOmZu1Bjvhu1lx+pcRGlQceAy63iiAsssC1wIKgYwFZB4PaiARZwuzd34lc4HBPknrtK4EpgWesq9oR4qvUI/GyQOWmKuDBrAa+gQRZwqLdTubzxpi3dIkrZbgDeJ7XjlzDdjThHRO+D6jzPG+d7/t/DeIBmQCFHyTZ54kQTf92pDHjRl3Wb5fKNnPgUs9iP3fA7njdSAXkvjjedBPAmM1BmtPMCOkVBu0G+kwQ7kCQCqAFeAmHRxpD6AAuNMZs0EVsJnGgxfYMYGKJP1poZd5tx++XwBrkXsJcisdvHpK4NjWkV9gNfCaIwrRMQANWg7TxviikAduD9Ipbm/Jbd1qRxplLkAs3xhLz6bVK4DZge1rH0xiz0FoCzSG9wuPAJSNd8R56DMAukNOB5YRTa7DPCv+LKV6s1Z7nnWV3rVMZX/VbLVJBdwbQ4Hneb8KqXAsTz/PeAF4HjiWc+pW/BV73PO+3laxVCeIUoBm5KDGMK536kKO+NSkW/sINSiuRrrmVogn4R+A5Y8zsFI4ryI0/11mryDXVSBVjRS2QqgoPUrU1FReFFCz5JnBfWpt1WpP/J8BJBJPXnkG62Zzged4bnuftSlPlpO/7b3met9MqgIW4T2qbAFTbU4GKrPFsBRcfVvAvCGFucsA9wJ1pDVbZnX8VMMfB45qRdOqzUjjOeaRu4Lt23bnm0krOcSVdgAlIu2zXpn8eKexZXukASYwW5QRr8s9z+NhG4PvGmAUpHO8ccItdd66tzTokm7UiqcpVFRqQLNKB9cIQ5uMVJDq6L6XCnwW+Y3fjbAiL8SjP81b7vt+XpnH3fX+/53kvI3cQTHb8+A8Bb9iAbCQsgGlI8M01nUgXnzQ37lyAXI0VVk/F6cBNVhGlTfnusRuf6/WXRU7ZJlfiHxrvIBSik67TJfuRTq+b0yr51gy8GckbD4tCpaeX0mnYbNehawuoBbjByl+oFsB8JOXXJTmkh9+TKW/eeREwNwLvUYc0tUyjFQDwFHAn7oOCX7AWWDgKwGb8LcV94G8TclNPmtNTa5AKx+qIvNIC3JxARHEucsjxt+/40fXjtQLGq7EXI+ehLumyu03ab+qZR3i56aWsgFNTrJD7gBtw30fgDKTfhlsFYP3PGx3vQPuR45ctKGcSvRtwT0ijG1DENuBWu05dUQssHasVkB2j8INkm7n2P9cAD6T90g77/b0IvlprxKySMOblAbtOXXIKcKRLC6AWuAa3R0+dwDJt5wUcqOePGrXjMUcTogQGkLjYboePrRmrFTBWAV6M24DPfuQKsZ0q+4DU9NdE8L2qCa//Q5SUwC4kK9ZlZuoJjCETNDuGL1cTwu7vq+l/EI1EJ/o/lA/q9ADwJLDOsfId9YnAWIR4AXL274puJM9fr+06QB3RuU15KBN0esDWpdyMdKN2xeLRumDZUX6pauQqb1e7T6FNs0b9K+O6udqJFGEL8AjuCoZqkKvuskEtpGlWy7hiN3BHWuv7D8MA7qvQyqVXp+ftDTOPtPZ2GRA8m1G0Es+O4suANJV0FXzKAStSXuhTin2EU4teDn/Q6TlIbvYgAWxXuQENwEXlxsuyo/yHz3Y4dlut+aQcSldEFUDe8W4XF1y7sZdQZoHYaBTA8bjriDoI3GbTK5XhXaMopkIPAnrb8qFWQD+SIegqh2UKkqhXGQVgg3+XOByzzbjPporTgtoPrI/gq/WguRqlWIcUsbniynKOBMu1AGYgx38uGABuT2t7r1Hw8wi6Aet03koq7UHkjkxXVsA8ykjWy5bx4uA2+LcBWKtLZkTWIsHAqLAf6UisHH7OXDWwyQJLRgoGlmMBuAz+DSDHfnqD78iKuRu5LSYqx4FtuM18i6vrtgJ3KcKncfD9j2NSAAtxd7X3NmsBKOVxP9E4d88Bd2mhVtlWwFZHz2oeyXXPjqCxssDJDk3Ie9WHHPWuuyICVsAW5KhLKS8WcIdDK2DJ4TIDR7IA6pDjPxe0A6t1iYxqMYG0BA+zMWoPcJ3u/qPiReBVR886ybrxY1IA8yl9lXQlyQMr9dx/TEqgH2lN3RmS6b+cFHdmHuOcDSAXt7qw3CYcbhPPjrC7nO5oTPYBT+vSGPOC2oZcyrLPsfB/F7mLUSdh9DyDZHSG6gYczgKoRZoMuDKJOnRNjIv1yLXo+xwJ/3eQDk16YjM29uAu2W0R0kNiVApgHm6i/wPAKt1FKhIPWI105m0L8FF9SEn4Mg3Yjnu+HkUuuAmaWkp0784e5uXOdDQWbcBGXRKVWVTGmE3AZ61LVWkfcydyKnSP7vwVYROw3dGzPjfcJlvKAqjGTd1/HnhUd5KKK4I9NiZwPpUpzukGvg0ca4zxtT9DxeYph9zq7CKlezHDNGspVSwwBTfNHXuB53UpBLK4BoDHjTFrkVjOycAspHV3OQlgPcAO4CXkjL9DBT8Q1lgFG7S73Wznf1s5CmABbtpObUXO/5XgFEE38JAx5nHkSKgV6SH/AeR8uMHOdb/9/Le1GnYAvXq+Hzhd1gU+w5EVcJACyAyzYLLAKoLP/88hJYv36RpQUq6kz7OuQND9FDcAnym25Ibb5bO4Kf3tQY7/FCXt+Lhp8DKPIV2bh1MA04HJDl5mE3IWqihppxM32ZQ1Qzf34RSA5+BF8sBP9exfUd4+dn8ON6cBnyqpAOyLHOvgJXrRs39FKWYdbkq75xZvvNlh/H8Xt/60E2y2mqLEjT0MidAHxGyKunsNVQAtQJODl1irZ8qKcoj1/UsHj5qAXPAzrAKY5eAFBpDkEkVRDmYzbpqGzi2lAGY7eHifI1NHUeLGNkdxgKMOUQDWBPm4g4fvQO+PU5Th3IBeKx+BWwCFQGCxBZB15AL8qx7/KUpJXLjHM7DdgosVQAPBFwANold9K8rh2OQgDlBTkPViBTCL4AuA+nFX/6wocWS7Ixd56nAKIGjaiNZtNooStThAv6M4wPShCuAIF9pN/X9FGREXp2RHDFUALQE/MA/8VudWUUbkdwRfF3DABbC7ctAKYBBt/qEo5dBO8DcHTYODGxC0BvzA/Wj5byV9xRbgXqTjaxTIA7faFmTK+Oi0CqA+wGdMMsY0FBRAAyX6hlfYAtirc1sx6pDCrfoIKYCHdVoqQhduUoKnZh35/wD92l9OUcqy7vJIo9CgmZx1ZP6Dm5ZHipIUXMjLRJcKQPP/FSVa8tJYUADvd+EC6JwqStm4uCm7rqAAXASS9PYfRSkfJ1evFRRAg4NnaQBQUSImLy4VgF4mqSgptgAURYkYLmMA6gIoSvn8KWkKQF0ARYmoC1Cv460o6XUBJuhQKEp6FYCiKKoAFEVJowLQNF1FSbECyOlQKIq6AIqiqAJQFEUVgKIoqVAAeQfPqtHhVpSyqXapAFy0H6rTOVWUsnm3SwXQreOtKOl1AVxYAOoCKEpEXQAXFoC6AIpSPvUuFcAf1AJQFLUAYq/RFCUhuOjSlXOpABp1ThWlbFyU6HeqAlCUaOJCXjoKCqDLhQtgjKnVeVWUw2OMyQJNDh61p6AAOgi+B1kt0KzTqygjMpHgY2a5Yhdgv1UCQVIDTNa5VZQRabYbZqD+vzFGgoDGGIB2BxbAFJ1bRRmRKQ4UwB44uBqwLeAHZoFP6Nwqyoh8lODzADqGKoDXHHyxI3VuFWVE5jh4xmuuLQCAacYYPQ5UlBIYY+qBWQ4etXOoAmh38NB6YLZOs6KUZBZukoC2D1UAnQTfHbjOkXmjKHE2/4MunOthmCBgrqAVAuYYnWNFKcnfEXyrvp3YLmDZIt8DYIuDLzjbGKPXkSvK8P6/Cwt5u5X3QzTNyw4e3qhxAEUZfnPETQ3Abwq/GKoAtjp4eB2wQOdaUQ5hLm7K5neUUgAdwF4HL/B5W/CgKMoBF/wzDh41CLxaSgHkHVkB09G0YEUpZpIj/38LRYV/2WG00L85eIkGYJ7OuaK8jYebEmDfGJMvZQEAbHbwEtXAiYVIpKKo+c+puOkD+FLxf2RLmAgurgtfYM0eRUk7E4H5Dp7Tx5Cj/uEUQD+w0cHLNAELde4VhQWOzP/NSBCwtAKw/sELjtyAM9UNUBROxU3b/JeK/f9SFgDAWtxcGDoPbROmpNv/n4i7vJj1Q3+jlAJox011YBOwWJeBkmIW2RhA0HQzTK1PKQWQs1aACzfgQmNMta4DJYW7fxa42JH5v97K9cgKwPrlLzgah9loibCSTo5E0n9d8OOh/v/hLACQk4A+By/WACzRtaCkkHNxcwVYP7BuuP+RHeEvrXU0EKfYYIiipMX8nwSc5uhx60pt5tnDvGAeWOXoBSc7HAxFiQIn4O6ejGHN/5EsgILm2OfgBauBy4wxdboulBTs/jVI8M9F8HvgcJZ8toy//KyjcZkBHK/LQ0kBHu6a4qxHegCOXgFYs+EJRy9aC1yhR4JKwnf/auAagm/8WeC5UuZ/ORYASP5wu6OXnYt2C1KSzQLcFP6ABP6eP9wfKEcBDAJPO3rheuAqtQKUBO/+V+Gm7RfAakaI4WXLeGmsG5Bz9NKLrI+kKEljPu4qYPPAg4cz/8u1AEB6iG1waAVcYyOlipKk3f9q3CT+gDT+3DTSH8qW+fI54PuO/SS1AhTd/cfOSop6/43XAgB4Edjl0Aq4XvMClITs/rXA9Q53/17gqXJ6bYxGAQwA9zu2As7Q5aMkgNMc7/7PUmYCX9kKwGqTxzhMUkGFqQFusDnTihLX3X8isBTJc3FBHlg5UvBvLBYASFOBxx2O33TgSm0bpsRU+AGuRLJcXbGVUXT2zo7yC+WBuxnSWDBAssClyJ3pihI3ZgFfJPjbfotZQRnBv7FaAABtwBqHX2gScJMGBJWY7f411vR36cK+CqwejcWcHcMXywG3jUbLVIDjgHN0WSkx4iSk5NclKxjlnR5jNU22ImmGrqgFlhpjpum6UmKw+7cC38Jdym/BMn9ytPGy7Bi/YA642WEsAOQy0eWaIajEwPS/CXC9Wd3OGFr4jSc4sRN3RUIFTgMu0FMBJcKcB5yF28Df9rHs/uNSANYKuBU39wgWuwLLcNdMQVFGIxMz7PqsdfjYnHU3xtTAd7xaahfwlONxbgFuM8ZM0CWnREj466xb3Or40euA58dqFWfH+aULJwJ9jr+0h9QKaN8AJQrCnwW+jPuWdgPIEfmYT+Qq4ae0Afc5/uLVwFeQduK6ApWwOR4583cdoH4MOZEjNAVgswNvB3Y7/vIN1vo4UtefEuLuP9Ou/0bHj+4GbrVWeHgKwNKFHH3kHQ9CK3CXFgwpIQn/ROAu3B/5YZVOx3j/kWyFBgLkSHBdCAMxz2pCTRVWXAp/LXAL4TSx3QrcU27FnwsLAGPMAHIE0u94MLLA2UimoCYJKS6EP4vEoM7D7Xk/SPLdUqTpB5FRAJZtuA8IggRfrgUutZOjKEEJP3bDuRH3QT+AhwC/UsHv6goPTs4YcxtSCDHV8cDUIQkRXcaYZ1JwOpCzPmBUXJ98CNZfGMJ/EnAHEEYeSgdw83gDf4EpAEshILgSN3efFdOIVET1AH7CFUAH8PmIvVNPwsd8EdIcN4ybrPPAcqCzkv9oJiBNWYv0DzwvpIlqBy42xmxUo1Wp0JqeBzwagmVbYDWwxMbaKkZVEG/q+37O87xXgBNxfz5asAQWeJ73iu/7v9flq4xT+Gdbi3Z6SK/QBVxkjPmvSv/DQQbM9gDX4bZkuJipwP3GmDm6hJVxCP9M4EFgZkivkLOm/6tB/ONVQb217/t4nvc60AQcFdLgvReY73nedrUElDEI/xy7838ixNd4BvjmePL9nccAhgziROAFwk3Z3Q1cDqzT2gGljDULkuBzP+Fk+RXoAI41xgSWZu/izHyfdQX6QhzIKVaTn6QKQClD+I8DHg5Z+AeBawi4xqYq6G9hXYE99lmeC6ujBA3AsUCX53mv+r6f1+WuDBH+LHA60vr+gyG/zp3ADyqR7huqArBK4C3P87YjFyRMD3FQ34Wc5WJPCP6iy16xwl8DXIQk+bwv5NdZB3zVGPOnoB9U5eob+b7/Z8/zfg18DgnOhcU7gWOAyZ7n/dr3/QFd/qkX/gYk0r6McDL8itkNnGOM6XTxMNd583uAK5Ba5jCpAb4ArNJW46kX/lbr71+L2zbew9GLXCXW5uqBmRAGvFC9dz/RyGNvQwo7nq1kjrUSecEHOBqp558dwmY4lEHgauCBoP3+UFyAIfGA/0BuFvpMBAb+PUhLp0bP87apS5AK4a9G0tTvBj5CeIHpAnmkw/adrjehTIiTUGe/9Fcisi5ywCbgemCLHhcmVvgL13VfGgGTv8BDwFXGGOfVlJmQJ2MCUl0VpXv/9iLtnX9ojBlUkUmM4GeRY+hbgDkRsDwLrAYuMcaEEherCvOb+74/6HneBuRo8CMRmZB3I/kCU+1R4ZsqPrEX/gnA14F/QWpEMhF5tfVI1eq+sF4gE5EJmoyUWi6M0LrJIwUYNwBrNUAYS8EHmGtdzfm4709xODYj5b0dYb5EVRRGwvf9P1pL4GjgAxGZoAzS+OFE4IOe5/27WgOxEv5GJJX2DqSSL0qt4nZa4X897BeJkkbsAM4HVlkfLSo0AF8EFhpjbkEuYdTYQHQFvwZp27UUmBWxNf628OPwrD/yLsAQk20a8COieQHoILAWCSRtcXleq4y4drJ2zdyIFPNEsU38LuBMYGdUTpkyEZxIrMn2I6R2IIr0AE9a87JdjwxDXzOTgauQ7M6JEX3Ndrvzb43SeslEdEKx5tsTEVYCeeTI8F4ke6tLRdH5OpkEXABchpR8ZyMs/OcSwfySTIQnF+R48NGIxQSGUmjPfS/wmCoCZ4J/HtLkpTWCfv5Qn/98YHsULcVMxCe6EBNYFXEloIrAzXpoRkp2L4yB4BeEf0mUfP5YKYAhSmAlckxIDBRBp40RPAy0abBwXPOftfO/xJr7LRE29YvZZhXVzijHiDIxWggtSAXh4pi8ch4JFr6IdJXdFFRjx4QKfh2SGHYhksLbGBPBB9iIZPi1R/1FMzFbFJOQ2oHTYrae+5GswlXA88BuPTkoae21AmdYv3kaUBuzr7EGuNxVQ49UKQC7SJqA26w5GLeLQPNIM5R1wI+BDcaYHhV802R3+VPtrj8xhnML8BRS1bcvLi+ciemCaUAyva4lnBtaK8F+5MaX9cBzaVIGdqefZIX+RKQF98QYz2UO+AGw3BjTG6cXz8R4EdUgNd23IOm6caagDDYCP0f6ErQnKXhog3lTkOKck63QNxH9SH457t1NwPfimCKeScCiOsHGBZoTIis55A6Fdmsd/ArYDnTGKW5g56YFuRDmGLvbt1hlXZ2QudqHtPF6Oq7Vopm4z4BdaDOR9k5Hkzz2W4Ww21oGv0JyytuidKpgLbKpSObmp+0O34p03alJ4LxsQxrcbo2zpZZJymzYE4KbkeBgNcklBwwgHWTbkaqy15Hcg15rkvbbP5PjwOWsefv75VJXNI619td19tOAtM+eDPwNkrE51f5+fcLHP48E+64D9sb9NCeTpJkxxtQiKaI3E92ikCAVQ84u0MLPwu8XL95yKY7CVxf9XnXRz+qUjXE3cn/AQ8aYRDSPzSRthorKQu+wZqiiVIL1dtffkaTgbCaps2X7wF0HfI3odH9V4kcfknfyvbgd8ZVDVVJnzTYc/SXSe+3jyLmzooyGrUhM6XFjzP8l8QtWJXn27CUkbwA/Af6K9Bh4p65rZQQGkdt5vwTsMsa8ldQvmknLjNrbYOYgiUMLiGeqqRIseeSodRmwMQ2doDNpm2FjTL0165apW6AUUbgQ5jFjTF9avnRV2mbZ9/39nue9AjyLpKJ+JI3joBxk7j+ENBr5Rdo6PmfSPPM2e20hcrY7V92C1Jn7m5EuwhvTevFLJu2rwGZy1QNnIRWGU1U2Ek8bcDsS3e9P80BkdC0cpAiagC8jBR6NOiqJYzdwF/AI0KNNWVQBDKcIskgRy1Lk1uI6HZXY02kF/4dAtwq+KoByFcF0JJvwbFUEsaQLqRK9B9ingq8KYKyKYBpy88w5SBWcEn1T/0G74+/TrsyqACqlCJqBS5CKwyk6KpGiENX/PtJ4tU93fFUAQSgCkFODRVYZLCJ+nWuTxACw2pr6m7X1uioAl8qgGgkYXmitglYdFWd0IJev3A90qJmvCiAKVsFiqwwWoUHDIOixu/0TwAZgUM18VQBRjBVMQO6oP90qgwYdmXGZ+OuQS1XWWt9ed3tVALFRBg3WMjjZKgVNMBqZPrvD/xSp2c+aIhgAAADWSURBVNBIviqARCiDeqQU+bNIm+wZpK+v3nDkkfTctcALyP0IAyr0qgCSHDPIIuXI861CWIDUIaSlIKkHqb3/mRX8diCvPr0qgDQrhBZrGRyFdC+amZD4wSCwA2mx9Wv7syDwusurAlBKKITCdVqzkb6Gs61imBxRSyGPpN+2289vgS1W+Ad1h1cFoIxfMYAEElvspxX48JD/bgrwNbqLPh3Af1ph34Wk4PYNeVdFFYDiWFHUWSVRuKmn8JlgfzZw4LqufEFohzHbu5H773oKQq8me7L4f5HUrlzHUDW1AAAAAElFTkSuQmCC"
}        
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/kyc/upload \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "File uploaded successfully.",
    "data": {
        "file_name": "address_proof_images_0.png"
    }
}
File Download
File Download

This API is used to download the user’s KYC file along with the file name in URL

Attributes
  • Url Parameters
    string
  • fileName
    stringRequired
    File name like (face_to_face_image.png / selfie_photo_url.png / id_document_images_0.png / address_proof_images_0.png)
Definition
GET https://test-consumer-api.flexm.com/user/kyc/download/{fileName}
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
   No inputs
}        
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/kyc/download/{fileName} \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    Display Images
}
File Delete
File Delete

This API is used to delete the user’s KYC file along with the file name in URL

Attributes
  • Url Parameters
    string
  • fileName
    stringRequired
    File name like (face_to_face_image.png / selfie_photo_url.png / id_document_images_0.png / address_proof_images_0.png)
Definition
DELETE https://test-consumer-api.flexm.com/user/kyc/delete/{fileName}
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    No inputs
}        
Example Request
curl --request DELETE \
--url https://test-consumer-api.flexm.com/user/kyc/delete/{fileName} \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "File deleted successfully."           
}
Agrani File Upload
File Upload

This API is used to upload the agrani user’s document file.

The API uses the following attributes:

Attributes
  • image_key
    stringRequired
    Image Name (document-image-front / document-image-back / selfie-image)
  • image_type
    stringRequired
    Image Type of the file
  • image_base64
    stringRequired
    Base64 Image
Definition
POST https://test-consumer-api.flexm.com/user/wallet/remittance/agrani/upload
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{       
    "image_type":"image/png",
    "image_key":"document_image_front", 
    "image_base64":"iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAYAAABccqhmAAAgAElEQVR42u2dfXRdVZXAf+8lxqwYs7pirLXGGDuldmqtlVVLxdK5llqR4ftrKN8IiIiIwGJhh6k96EIWwyAWVL4tXwVEFkIXFqy1XDu1lk6ptVOZTgglq2Y6sZPJCjFmYn0+5o99Hn1N85qX5N1zv/ZvrbdSStt73zln77P3Pnvvk0FJJMaYeqCx6DMBqLf/uwaoG+av9QF5YNB+eoGewk9jzICObLLI6BDESqgLv6wHpgCtQDPwYaCl6NNkhbzSDFqFsAfotD9/D+wF2oE2oH/IuyqqAJQxCHsWqLZCPhP4uP05E5gKZCP42nmgA9hlP78DtgM7gZwxJq8zqwpAGX5nzwINwDzg08AC4Mgisz3O9FtFsAV42f7cA+TVUlAFkOYdvtEK+t8BRwOzAjLdo2oprAdeAnygSxWCKoCk7/LVwHTgOODv7W5fq6NDHngVWAc8Zy2EQXUZVAEkQejrgPnAiVbwp0TUf48SXcBaqwzWA32qDFQBxEnoa4C5wBLgFGCyjsyY6QPWAKusq9CvboIqgKia9zOBfwBOI7qR+jizF3gaeALYBuxXZaAKIEzBLwTyTgMuQ6L2KvRuYgY7gJXAk0C3ugiqAFwKfjUwwwr9WcBEHZXQ6LVWwYPANmPMfh0SVQBBmfn1wPHA5cjxXbWOTGTIIacHK4DngQF1D1QBVErwJwBnA1cjx3hKtNkJ3GXdgz5VBKoAxir4TcAFwFVISq4SL3YDdwMP2TiBjogqgLIEfxJwqTX1m3VUYk8HcAfwCNCrikAVQCnBb7A7/g0q+IlkF3ArEjTUfAJVAG8Lfy2SpbcMOcpTks124FvAGmPMoCqA9Ap+NTAHWA4sQqP6aSKHpBsvA3YYY3KqANJl7jcDN1qTv07lIbX0A/cBtwN70+YWVKVQ+Out0D8MHAu8Q2Ug1dQAnwJOB970PK/N9/2/qAWQPMHPArORINBCNGVXOZQ88CISBH41DenFVSkR/gbgK9bU+yga/FRKb4hHIOndec/zdvq+/2e1AOK968+y/p2nu74ySjYC1wNbkmoNVCVY+GuBC5GKsZm66ytjoAU4A8h5nrfD9/3EFRplEij4IBH+m4Fz0KM9pXKxgWuA9iRZA5mECX/Wmvor7K6fNnLDfPJFi3ikhVtQloWW5Nkhv65OuRvViQQIn05K2XEmQcJfjwT6liIpvUkX9AHkDHs30lDzNaRjTjcHbvQZsJ8c0pd/sIwxrEEalRZ+XWd/3VD0swn4AFIz0WJ/1hZ9ksx+JJi83BjTowogGiZ/C1LscUoCd6i8FeIeJIX1FSvwbcBuY0x/BOag1s5BK1Iu/WmkJ2KTVSBJtBrWA1cCu+KcPJSJufBnkdz9e0lODn/e7uxdwGbgV1bwd8bpbj5jTJ11w+Yg9x4kUSHsBq4A1sU1LpCJsfBX2x3/LmuCxt2kL+zwPwM2IPnpiYk6FymEecDJSFLWhAQog17gOuCRONYTZGK6mGqALyGR/voYC/0+pNX1c8AmoDMNuejWcpuKBGxPt9bbBOJ7YjNo1+J34naDciaGi6cBKeL5GvG7Ritvd/rNwI+RarSuNNelW2XQgqRnn4pckRZHyyAHPAAsNcb0qgIIZrE0Ill9F8RsgQwiQbtHgdUk7Cy5wspgGpKKuwS5RSluSv5x4GpjTLcqgMoujknW3z8jRrt9rzXxHwbWRyFiHzNLbzFwcZFVEBeeBy43xuxVBVCZxdCMRPqPj4ngd9md4GFSUlUWsFUwCzgX6cw8OSbWnw9cbIzpUAUwvgXQagVpQQwEfw/SeHIl0KE95wJZC5cB5yHp3lFXBBuAS6zLpwogocKfR86D7wcei4PZF3MlAJJwdAkSC4q6IthqrZe2KCqBjAr/uOgCfgjcbYzpVPEMRRHEwSKIrBLIqPCPiR6ktfQK6+OrRIarCKYgyTjnEN1gYSSVQCaCE9qM3AUfReHfj+SAfwvYrMG9SK2bLHJasMyunVpVAjFTAMaYycgtr8dF1M+/zfr5AypykVUEdUgewfVIYVLU3ILNwJKonA5kIjRxE5HoedSO+vqQI71bo36koxyymVwFfBFojNjrbQDON8bsCftFqiIyWY3IJY4nR2zX/x1Sc/C9JNR+pwnf9//oed5LwMvADOD9EdrwPgR8zPO8n/u+H2pyWCYCwl9vTesvRWj9DCJBvhujoKWViliXS4EvEK1mMc8Cl4WZNlwV8sTUAF8Hro6Qr7YX+Cfgm8aY/1XxSYQ18CfP834B7AQ+hvQliII1MB2Y7HneS77vh3JHYSZE4c/aXf92ohGxzSEluYU20Co5ybQGWoCbkLTiqJwU/AC4PozgclWIwl9o5vGuCExAv52Eq4wxr/m+r5KSXGvgTc/zXkB6Jx5FNO6F/AQw4HneZt/384lWAHZn/SRSGvueCAx+G/BVJNCn1XrpUAJ/9TzvFaQD0yetSxAmhRyGDnsb0VuJdQGsCfYc0hIqTPLIccwVxphdKhapdQmmIxmdCwm/I1E30iFpgysXNOt4sBuQ7r1hC38OicCeq8KfegWwC8nOewA5/QmTJuQ4fEriXAAb8V+GVHGFGYHdj2QbftUY8z8qAorv+wP2lOBNpGlpmMHB9wIf9jxvjYuLSascCX8Wibp+G3hHiIM7APwz8A1jzB916StFSiDned4W5Bj4GMINDh6B3Ee4MeigoCsXYCaS7BOmZu1Bjvhu1lx+pcRGlQceAy63iiAsssC1wIKgYwFZB4PaiARZwuzd34lc4HBPknrtK4EpgWesq9oR4qvUI/GyQOWmKuDBrAa+gQRZwqLdTubzxpi3dIkrZbgDeJ7XjlzDdjThHRO+D6jzPG+d7/t/DeIBmQCFHyTZ54kQTf92pDHjRl3Wb5fKNnPgUs9iP3fA7njdSAXkvjjedBPAmM1BmtPMCOkVBu0G+kwQ7kCQCqAFeAmHRxpD6AAuNMZs0EVsJnGgxfYMYGKJP1poZd5tx++XwBrkXsJcisdvHpK4NjWkV9gNfCaIwrRMQANWg7TxviikAduD9Ipbm/Jbd1qRxplLkAs3xhLz6bVK4DZge1rH0xiz0FoCzSG9wuPAJSNd8R56DMAukNOB5YRTa7DPCv+LKV6s1Z7nnWV3rVMZX/VbLVJBdwbQ4Hneb8KqXAsTz/PeAF4HjiWc+pW/BV73PO+3laxVCeIUoBm5KDGMK536kKO+NSkW/sINSiuRrrmVogn4R+A5Y8zsFI4ryI0/11mryDXVSBVjRS2QqgoPUrU1FReFFCz5JnBfWpt1WpP/J8BJBJPXnkG62Zzged4bnuftSlPlpO/7b3met9MqgIW4T2qbAFTbU4GKrPFsBRcfVvAvCGFucsA9wJ1pDVbZnX8VMMfB45qRdOqzUjjOeaRu4Lt23bnm0krOcSVdgAlIu2zXpn8eKexZXukASYwW5QRr8s9z+NhG4PvGmAUpHO8ccItdd66tzTokm7UiqcpVFRqQLNKB9cIQ5uMVJDq6L6XCnwW+Y3fjbAiL8SjP81b7vt+XpnH3fX+/53kvI3cQTHb8+A8Bb9iAbCQsgGlI8M01nUgXnzQ37lyAXI0VVk/F6cBNVhGlTfnusRuf6/WXRU7ZJlfiHxrvIBSik67TJfuRTq+b0yr51gy8GckbD4tCpaeX0mnYbNehawuoBbjByl+oFsB8JOXXJTmkh9+TKW/eeREwNwLvUYc0tUyjFQDwFHAn7oOCX7AWWDgKwGb8LcV94G8TclNPmtNTa5AKx+qIvNIC3JxARHEucsjxt+/40fXjtQLGq7EXI+ehLumyu03ab+qZR3i56aWsgFNTrJD7gBtw30fgDKTfhlsFYP3PGx3vQPuR45ctKGcSvRtwT0ijG1DENuBWu05dUQssHasVkB2j8INkm7n2P9cAD6T90g77/b0IvlprxKySMOblAbtOXXIKcKRLC6AWuAa3R0+dwDJt5wUcqOePGrXjMUcTogQGkLjYboePrRmrFTBWAV6M24DPfuQKsZ0q+4DU9NdE8L2qCa//Q5SUwC4kK9ZlZuoJjCETNDuGL1cTwu7vq+l/EI1EJ/o/lA/q9ADwJLDOsfId9YnAWIR4AXL274puJM9fr+06QB3RuU15KBN0esDWpdyMdKN2xeLRumDZUX6pauQqb1e7T6FNs0b9K+O6udqJFGEL8AjuCoZqkKvuskEtpGlWy7hiN3BHWuv7D8MA7qvQyqVXp+ftDTOPtPZ2GRA8m1G0Es+O4suANJV0FXzKAStSXuhTin2EU4teDn/Q6TlIbvYgAWxXuQENwEXlxsuyo/yHz3Y4dlut+aQcSldEFUDe8W4XF1y7sZdQZoHYaBTA8bjriDoI3GbTK5XhXaMopkIPAnrb8qFWQD+SIegqh2UKkqhXGQVgg3+XOByzzbjPporTgtoPrI/gq/WguRqlWIcUsbniynKOBMu1AGYgx38uGABuT2t7r1Hw8wi6Aet03koq7UHkjkxXVsA8ykjWy5bx4uA2+LcBWKtLZkTWIsHAqLAf6UisHH7OXDWwyQJLRgoGlmMBuAz+DSDHfnqD78iKuRu5LSYqx4FtuM18i6vrtgJ3KcKncfD9j2NSAAtxd7X3NmsBKOVxP9E4d88Bd2mhVtlWwFZHz2oeyXXPjqCxssDJDk3Ie9WHHPWuuyICVsAW5KhLKS8WcIdDK2DJ4TIDR7IA6pDjPxe0A6t1iYxqMYG0BA+zMWoPcJ3u/qPiReBVR886ybrxY1IA8yl9lXQlyQMr9dx/TEqgH2lN3RmS6b+cFHdmHuOcDSAXt7qw3CYcbhPPjrC7nO5oTPYBT+vSGPOC2oZcyrLPsfB/F7mLUSdh9DyDZHSG6gYczgKoRZoMuDKJOnRNjIv1yLXo+xwJ/3eQDk16YjM29uAu2W0R0kNiVApgHm6i/wPAKt1FKhIPWI105m0L8FF9SEn4Mg3Yjnu+HkUuuAmaWkp0784e5uXOdDQWbcBGXRKVWVTGmE3AZ61LVWkfcydyKnSP7vwVYROw3dGzPjfcJlvKAqjGTd1/HnhUd5KKK4I9NiZwPpUpzukGvg0ca4zxtT9DxeYph9zq7CKlezHDNGspVSwwBTfNHXuB53UpBLK4BoDHjTFrkVjOycAspHV3OQlgPcAO4CXkjL9DBT8Q1lgFG7S73Wznf1s5CmABbtpObUXO/5XgFEE38JAx5nHkSKgV6SH/AeR8uMHOdb/9/Le1GnYAvXq+Hzhd1gU+w5EVcJACyAyzYLLAKoLP/88hJYv36RpQUq6kz7OuQND9FDcAnym25Ibb5bO4Kf3tQY7/FCXt+Lhp8DKPIV2bh1MA04HJDl5mE3IWqihppxM32ZQ1Qzf34RSA5+BF8sBP9exfUd4+dn8ON6cBnyqpAOyLHOvgJXrRs39FKWYdbkq75xZvvNlh/H8Xt/60E2y2mqLEjT0MidAHxGyKunsNVQAtQJODl1irZ8qKcoj1/UsHj5qAXPAzrAKY5eAFBpDkEkVRDmYzbpqGzi2lAGY7eHifI1NHUeLGNkdxgKMOUQDWBPm4g4fvQO+PU5Th3IBeKx+BWwCFQGCxBZB15AL8qx7/KUpJXLjHM7DdgosVQAPBFwANold9K8rh2OQgDlBTkPViBTCL4AuA+nFX/6wocWS7Ixd56nAKIGjaiNZtNooStThAv6M4wPShCuAIF9pN/X9FGREXp2RHDFUALQE/MA/8VudWUUbkdwRfF3DABbC7ctAKYBBt/qEo5dBO8DcHTYODGxC0BvzA/Wj5byV9xRbgXqTjaxTIA7faFmTK+Oi0CqA+wGdMMsY0FBRAAyX6hlfYAtirc1sx6pDCrfoIKYCHdVoqQhduUoKnZh35/wD92l9OUcqy7vJIo9CgmZx1ZP6Dm5ZHipIUXMjLRJcKQPP/FSVa8tJYUADvd+EC6JwqStm4uCm7rqAAXASS9PYfRSkfJ1evFRRAg4NnaQBQUSImLy4VgF4mqSgptgAURYkYLmMA6gIoSvn8KWkKQF0ARYmoC1Cv460o6XUBJuhQKEp6FYCiKKoAFEVJowLQNF1FSbECyOlQKIq6AIqiqAJQFEUVgKIoqVAAeQfPqtHhVpSyqXapAFy0H6rTOVWUsnm3SwXQreOtKOl1AVxYAOoCKEpEXQAXFoC6AIpSPvUuFcAf1AJQFLUAYq/RFCUhuOjSlXOpABp1ThWlbFyU6HeqAlCUaOJCXjoKCqDLhQtgjKnVeVWUw2OMyQJNDh61p6AAOgi+B1kt0KzTqygjMpHgY2a5Yhdgv1UCQVIDTNa5VZQRabYbZqD+vzFGgoDGGIB2BxbAFJ1bRRmRKQ4UwB44uBqwLeAHZoFP6Nwqyoh8lODzADqGKoDXHHyxI3VuFWVE5jh4xmuuLQCAacYYPQ5UlBIYY+qBWQ4etXOoAmh38NB6YLZOs6KUZBZukoC2D1UAnQTfHbjOkXmjKHE2/4MunOthmCBgrqAVAuYYnWNFKcnfEXyrvp3YLmDZIt8DYIuDLzjbGKPXkSvK8P6/Cwt5u5X3QzTNyw4e3qhxAEUZfnPETQ3Abwq/GKoAtjp4eB2wQOdaUQ5hLm7K5neUUgAdwF4HL/B5W/CgKMoBF/wzDh41CLxaSgHkHVkB09G0YEUpZpIj/38LRYV/2WG00L85eIkGYJ7OuaK8jYebEmDfGJMvZQEAbHbwEtXAiYVIpKKo+c+puOkD+FLxf2RLmAgurgtfYM0eRUk7E4H5Dp7Tx5Cj/uEUQD+w0cHLNAELde4VhQWOzP/NSBCwtAKw/sELjtyAM9UNUBROxU3b/JeK/f9SFgDAWtxcGDoPbROmpNv/n4i7vJj1Q3+jlAJox011YBOwWJeBkmIW2RhA0HQzTK1PKQWQs1aACzfgQmNMta4DJYW7fxa42JH5v97K9cgKwPrlLzgah9loibCSTo5E0n9d8OOh/v/hLACQk4A+By/WACzRtaCkkHNxcwVYP7BuuP+RHeEvrXU0EKfYYIiipMX8nwSc5uhx60pt5tnDvGAeWOXoBSc7HAxFiQIn4O6ejGHN/5EsgILm2OfgBauBy4wxdboulBTs/jVI8M9F8HvgcJZ8toy//KyjcZkBHK/LQ0kBHu6a4qxHegCOXgFYs+EJRy9aC1yhR4JKwnf/auAagm/8WeC5UuZ/ORYASP5wu6OXnYt2C1KSzQLcFP6ABP6eP9wfKEcBDAJPO3rheuAqtQKUBO/+V+Gm7RfAakaI4WXLeGmsG5Bz9NKLrI+kKEljPu4qYPPAg4cz/8u1AEB6iG1waAVcYyOlipKk3f9q3CT+gDT+3DTSH8qW+fI54PuO/SS1AhTd/cfOSop6/43XAgB4Edjl0Aq4XvMClITs/rXA9Q53/17gqXJ6bYxGAQwA9zu2As7Q5aMkgNMc7/7PUmYCX9kKwGqTxzhMUkGFqQFusDnTihLX3X8isBTJc3FBHlg5UvBvLBYASFOBxx2O33TgSm0bpsRU+AGuRLJcXbGVUXT2zo7yC+WBuxnSWDBAssClyJ3pihI3ZgFfJPjbfotZQRnBv7FaAABtwBqHX2gScJMGBJWY7f411vR36cK+CqwejcWcHcMXywG3jUbLVIDjgHN0WSkx4iSk5NclKxjlnR5jNU22ImmGrqgFlhpjpum6UmKw+7cC38Jdym/BMn9ytPGy7Bi/YA642WEsAOQy0eWaIajEwPS/CXC9Wd3OGFr4jSc4sRN3RUIFTgMu0FMBJcKcB5yF28Df9rHs/uNSANYKuBU39wgWuwLLcNdMQVFGIxMz7PqsdfjYnHU3xtTAd7xaahfwlONxbgFuM8ZM0CWnREj466xb3Or40euA58dqFWfH+aULJwJ9jr+0h9QKaN8AJQrCnwW+jPuWdgPIEfmYT+Qq4ae0Afc5/uLVwFeQduK6ApWwOR4583cdoH4MOZEjNAVgswNvB3Y7/vIN1vo4UtefEuLuP9Ou/0bHj+4GbrVWeHgKwNKFHH3kHQ9CK3CXFgwpIQn/ROAu3B/5YZVOx3j/kWyFBgLkSHBdCAMxz2pCTRVWXAp/LXAL4TSx3QrcU27FnwsLAGPMAHIE0u94MLLA2UimoCYJKS6EP4vEoM7D7Xk/SPLdUqTpB5FRAJZtuA8IggRfrgUutZOjKEEJP3bDuRH3QT+AhwC/UsHv6goPTs4YcxtSCDHV8cDUIQkRXcaYZ1JwOpCzPmBUXJ98CNZfGMJ/EnAHEEYeSgdw83gDf4EpAEshILgSN3efFdOIVET1AH7CFUAH8PmIvVNPwsd8EdIcN4ybrPPAcqCzkv9oJiBNWYv0DzwvpIlqBy42xmxUo1Wp0JqeBzwagmVbYDWwxMbaKkZVEG/q+37O87xXgBNxfz5asAQWeJ73iu/7v9flq4xT+Gdbi3Z6SK/QBVxkjPmvSv/DQQbM9gDX4bZkuJipwP3GmDm6hJVxCP9M4EFgZkivkLOm/6tB/ONVQb217/t4nvc60AQcFdLgvReY73nedrUElDEI/xy7838ixNd4BvjmePL9nccAhgziROAFwk3Z3Q1cDqzT2gGljDULkuBzP+Fk+RXoAI41xgSWZu/izHyfdQX6QhzIKVaTn6QKQClD+I8DHg5Z+AeBawi4xqYq6G9hXYE99lmeC6ujBA3AsUCX53mv+r6f1+WuDBH+LHA60vr+gyG/zp3ADyqR7huqArBK4C3P87YjFyRMD3FQ34Wc5WJPCP6iy16xwl8DXIQk+bwv5NdZB3zVGPOnoB9U5eob+b7/Z8/zfg18DgnOhcU7gWOAyZ7n/dr3/QFd/qkX/gYk0r6McDL8itkNnGOM6XTxMNd583uAK5Ba5jCpAb4ArNJW46kX/lbr71+L2zbew9GLXCXW5uqBmRAGvFC9dz/RyGNvQwo7nq1kjrUSecEHOBqp558dwmY4lEHgauCBoP3+UFyAIfGA/0BuFvpMBAb+PUhLp0bP87apS5AK4a9G0tTvBj5CeIHpAnmkw/adrjehTIiTUGe/9Fcisi5ywCbgemCLHhcmVvgL13VfGgGTv8BDwFXGGOfVlJmQJ2MCUl0VpXv/9iLtnX9ojBlUkUmM4GeRY+hbgDkRsDwLrAYuMcaEEherCvOb+74/6HneBuRo8CMRmZB3I/kCU+1R4ZsqPrEX/gnA14F/QWpEMhF5tfVI1eq+sF4gE5EJmoyUWi6M0LrJIwUYNwBrNUAYS8EHmGtdzfm4709xODYj5b0dYb5EVRRGwvf9P1pL4GjgAxGZoAzS+OFE4IOe5/27WgOxEv5GJJX2DqSSL0qt4nZa4X897BeJkkbsAM4HVlkfLSo0AF8EFhpjbkEuYdTYQHQFvwZp27UUmBWxNf628OPwrD/yLsAQk20a8COieQHoILAWCSRtcXleq4y4drJ2zdyIFPNEsU38LuBMYGdUTpkyEZxIrMn2I6R2IIr0AE9a87JdjwxDXzOTgauQ7M6JEX3Ndrvzb43SeslEdEKx5tsTEVYCeeTI8F4ke6tLRdH5OpkEXABchpR8ZyMs/OcSwfySTIQnF+R48NGIxQSGUmjPfS/wmCoCZ4J/HtLkpTWCfv5Qn/98YHsULcVMxCe6EBNYFXEloIrAzXpoRkp2L4yB4BeEf0mUfP5YKYAhSmAlckxIDBRBp40RPAy0abBwXPOftfO/xJr7LRE29YvZZhXVzijHiDIxWggtSAXh4pi8ch4JFr6IdJXdFFRjx4QKfh2SGHYhksLbGBPBB9iIZPi1R/1FMzFbFJOQ2oHTYrae+5GswlXA88BuPTkoae21AmdYv3kaUBuzr7EGuNxVQ49UKQC7SJqA26w5GLeLQPNIM5R1wI+BDcaYHhV802R3+VPtrj8xhnML8BRS1bcvLi+ciemCaUAyva4lnBtaK8F+5MaX9cBzaVIGdqefZIX+RKQF98QYz2UO+AGw3BjTG6cXz8R4EdUgNd23IOm6caagDDYCP0f6ErQnKXhog3lTkOKck63QNxH9SH457t1NwPfimCKeScCiOsHGBZoTIis55A6Fdmsd/ArYDnTGKW5g56YFuRDmGLvbt1hlXZ2QudqHtPF6Oq7Vopm4z4BdaDOR9k5Hkzz2W4Ww21oGv0JyytuidKpgLbKpSObmp+0O34p03alJ4LxsQxrcbo2zpZZJymzYE4KbkeBgNcklBwwgHWTbkaqy15Hcg15rkvbbP5PjwOWsefv75VJXNI619td19tOAtM+eDPwNkrE51f5+fcLHP48E+64D9sb9NCeTpJkxxtQiKaI3E92ikCAVQ84u0MLPwu8XL95yKY7CVxf9XnXRz+qUjXE3cn/AQ8aYRDSPzSRthorKQu+wZqiiVIL1dtffkaTgbCaps2X7wF0HfI3odH9V4kcfknfyvbgd8ZVDVVJnzTYc/SXSe+3jyLmzooyGrUhM6XFjzP8l8QtWJXn27CUkbwA/Af6K9Bh4p65rZQQGkdt5vwTsMsa8ldQvmknLjNrbYOYgiUMLiGeqqRIseeSodRmwMQ2doDNpm2FjTL0165apW6AUUbgQ5jFjTF9avnRV2mbZ9/39nue9AjyLpKJ+JI3joBxk7j+ENBr5Rdo6PmfSPPM2e20hcrY7V92C1Jn7m5EuwhvTevFLJu2rwGZy1QNnIRWGU1U2Ek8bcDsS3e9P80BkdC0cpAiagC8jBR6NOiqJYzdwF/AI0KNNWVQBDKcIskgRy1Lk1uI6HZXY02kF/4dAtwq+KoByFcF0JJvwbFUEsaQLqRK9B9ingq8KYKyKYBpy88w5SBWcEn1T/0G74+/TrsyqACqlCJqBS5CKwyk6KpGiENX/PtJ4tU93fFUAQSgCkFODRVYZLCJ+nWuTxACw2pr6m7X1uioAl8qgGgkYXmitglYdFWd0IJev3A90qJmvCiAKVsFiqwwWoUHDIOixu/0TwAZgUM18VQBRjBVMQO6oP90qgwYdmXGZ+OuQS1XWWt9ed3tVALFRBg3WMjjZKgVNMBqZPrvD/xSp2c+aIhgAAADWSURBVNBIviqARCiDeqQU+bNIm+wZpK+v3nDkkfTctcALyP0IAyr0qgCSHDPIIuXI861CWIDUIaSlIKkHqb3/mRX8diCvPr0qgDQrhBZrGRyFdC+amZD4wSCwA2mx9Wv7syDwusurAlBKKITCdVqzkb6Gs61imBxRSyGPpN+2289vgS1W+Ad1h1cFoIxfMYAEElvspxX48JD/bgrwNbqLPh3Af1ph34Wk4PYNeVdFFYDiWFHUWSVRuKmn8JlgfzZw4LqufEFohzHbu5H773oKQq8me7L4f5HUrlzHUDW1AAAAAElFTkSuQmCC"
}        
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/remittance/agrani/upload \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "File uploaded successfully.",
    "data": {
        "file_name": "document_image_front.png"
    }
}
Agrani File Download
File Download

This API is used to download the agrani user’s file along with the file name in URL

Attributes
  • Url Parameters
    string
  • fileName
    stringRequired
    File name like (document-image-front.png / document-image-back.png / selfie-image.png)
Definition
GET https://test-consumer-api.flexm.com/user/wallet/remittance/agrani/download/{fileName}
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
   No inputs
}        
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/remittance/agrani/download/{fileName} \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json
'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    Display Images
}
User - Wallet
User Wallet
User Wallet

This API uses the unique user id to retrieve the user wallet information along with the custom token.

The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/user/wallet
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    No inputs
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "User wallet details retrieved successfully.",
    "data": [
        {
            "display_name": "John Doe",
            "mobile_no": "82828282",
            "account_no": "0101000006",
            "currency_code": "SGD",
            "country_code": "SGP",
            "tier_no": "tier1",
            "balance": 8,
            "max_amount_allowed": "1000"
        }
    ]
}
User Wallet Account
User Wallet Account

This API is used to retrieve the user wallet information along with the user account number in URL.

The API has no Attributes

Attributes
  • Url Parameters
    string
  • account_number
    stringRequired
    User account number like (2101000143)
Definition
GET https://test-consumer-api.flexm.com/user/wallet/{account_number}
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    No inputs
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/{account_number} \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "User wallet details retrieved successfully.",
    "data": {
        "display_name": "John Doe",
        "mobile_no": "82828282",
        "account_no": "0101000006",
        "currency_code": "SGD",
        "country_code": "SGP",
        "tier_no": "tier1",
        "balance": 8,
        "max_amount_allowed": "1000"
    }
}
Wallet TopUp
Wallet Topup Transfer Fee List
Wallet Topup Transfer Fee List

This API is used to retrieve the wallet top-up transfer fee list.

The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/wallet/topup/fee
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    No Inputs
}        
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/wallet/topup/fee \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
"success": true,
"status_code": 200,
"message": "Wallet transfer fee retrieved successfully.",
"data": {
    "fee_details": [
        {
            "is_active": false,
            "payment_mode": "card",
            "mode": "include",
            "fee_amount": 0,
            "display_name": "Card",
            "fee_type": "amount"
        },
        {
            "is_active": true,
            "payment_mode": "Cash",
            "mode": "exclude",
            "fee_amount": 6,
            "display_name": "Top up at store",
            "fee_type": "amount"
        },
        {
            "fee_amount": 1,
            "display_name": "CDM Deposit",
            "fee_type": "amount",
            "is_active": true,
            "payment_mode": "CDMDeposit",
            "mode": "include"
        },
        {
            "is_active": false,
            "payment_mode": "MerchantTopup",
            "mode": "exclude",
            "fee_amount": 0,
            "display_name": "Merchant Topup",
            "fee_type": "amount"
        },
        {
            "fee_amount": 7,
            "display_name": "PayNow to Agrani Remit",
            "fee_type": "percentage",
            "is_active": true,
            "payment_mode": "PayNow",
            "mode": "exclude"
        },
        {
            "fee_type": "amount",
            "is_active": true,
            "payment_mode": "seven_eleven",
            "mode": "exclude",
            "fee_amount": 2,
            "display_name": "7 Eleven"
        },
        {
            "fee_amount": 1,
            "display_name": "Top up by Bank Transfer",
            "fee_type": "amount",
            "is_active": true,
            "payment_mode": "BankTransfer",
            "mode": "exclude"
        },
        {
            "is_active": false,
            "payment_mode": "BOBankTransfer",
            "mode": "exclude",
            "fee_amount": 9,
            "display_name": "BankTransfer",
            "fee_type": "percentage"
        },
        {
            "is_active": false,
            "payment_mode": "BOPayNow",
            "mode": "exclude",
            "fee_amount": 2,
            "display_name": "PayNow",
            "fee_type": "percentage"
        }
    ]
}
}
Wallet Add Money
Add Money

This API is used to add money to the user’s wallet using user card information.

The API uses the following attributes:

Attributes
  • payment_type
    stringRequired
    Type of Payment used to pay to wallet.
  • amount
    numberRequired
    Amount in form of 2 decimal places
  • created_from
    stringRequired
    Created From device type (Android/iOS)
  • terminal
    stringRequired
    Terminal like (InApp/BackOffice)
  • cvc
    stringRequired
    Card CVC.
  • exp_month
    stringRequired
    Card Exp Month
  • exp_year
    stringRequired
    Card Exp Year
  • number
    stringRequired
    Number which is used towards funds add.
  • save_card
    booleanRequired
    Y to save card details
Definition
POST https://test-consumer-api.flexm.com/user/wallet/funds/add
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
    "payment_type":"card",
    "amount":10,
    "created_from":"Android",
    "terminal":"InApp",
    "card_details": {
        "cvc": "111",
        "exp_month": "12",
        "exp_year": "2020",
        "number": "6554575467546890",
        "save_card":"Y"
    }
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/funds/add \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{                
    "success": true,
    "status_code": 200,
    "message": "Add money transaction is successfull.",
    "data": {
        "order_no": "ORD00120200002713",
        "receipt_no": "RCT00120200000612",
        "transaction_no": "TRN00120200001999",
        "points_earned": 300
    }    
}
Wallet Add Money Through BankTransfer
Wallet Add Money Through BankTransfer

This API is used to retrieve account details for BankTransfer.

The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/user/wallet/topup/flexm/bank_transfer
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    No Inputs
}        
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/topup/flexm/bank_transfer \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
"success": true,
"status_code": 200,
"message": "Flexm details retrieved successfully.",
"data": {
    "bank_name": "DBS Bank",
    "paynow_qr": "00020101021126580009SG.PAYNOW010120213201207298RFLB030110414202012312359595204630053037025802SG5913FLEXM PTE LTD6009Singapore62180114DICN2101000040630443C9",
    "account_no": "288-900731-8",
    "uen": "201207298RTOP",
    "payee_name": "FLEXM PTE. LTD.",
    "user_account_no": "DICN2101000040"
}
}
Wallet Add Money Through CDMDeposit
Wallet Add Money Through CDMDeposit

This API is used to retrieve account details for CDMDeposit.

The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/user/wallet/topup/flexm/cdmdeposit
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    No Inputs
}        
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/topup/flexm/cdmdeposit \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
"success": true,
"status_code": 200,
"message": "Account details retrieved successfully.",
"data": {
    "account_no": "003-914191-2",
    "uen": "UEN200200048DAEH",
    "payee_name": "Agrani Exchange House Pte Ltd Client Trust",
    "steps": [
    "Visit any DBS/POSB cdm, tap on the screen and press ‘Deposit’",
    "Select ‘DBS’ for account type, enter account no.003-914191-2",
    "Select ‘Leave a note’ & enter the transfer reference no. above",
    "Enter your personal detail and phone number, press enter",
    "Deposit your cash in, press confirm. Collect your receipt before leaving",
    "Send the photo via Whatsapp to +65 0000 0000"
    ],
    "bank_name": "DBS Bank",
    "user_account_no": "2101000040"
}
}
Wallet Pay By App User
Wallet Pay

This API is used to money send from the user wallet to another user wallet using a mobile number.

The API uses the following attributes:

Attributes
  • receiver_type
    stringRequired
    Receiver Type which is used to by (AppUser)
  • amount
    numberRequired
    Amount in form of 2 decimal places to be funds transfer wallet to wallet
  • receiver_mobile_no
    stringRequired
    Receiver Mobile Number
  • message
    string
    Message used to be transaction notes if any
Definition
POST https://test-consumer-api.flexm.com/user/wallet/pay
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
    "receiver_type":"APP_USER",
    "amount":10,
    "receiver_mobile_no":"81818181",
    "message":"Send money to friend"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/pay \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{                
    "success": true,
    "status_code": 200,
    "message": "Wallet Pay transaction is successfull.",
    "data": {
        "transaction_no": "TRN00120200001959",
        "points_earned": 500,
        "message":"Send money to friend"
    }      
}
Wallet Pay By Merchant
Wallet Pay

This API is used to money send from the user wallet to another user merchant wallet using location id.

The API uses the following attributes:

Attributes
  • receiver_id
    stringRequired
    Receiver User ID
  • location_id
    stringRequired
    Location ID of the merchant user
  • receiver_type
    stringRequired
    Receiver Type which is used to by Merchant
  • amount
    numberRequired
    Amount to be funds transfer by merchant
Definition
POST https://test-consumer-api.flexm.com/user/wallet/pay
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
    "receiver_id":"oqXstKILcvdyDGBmdxnKdw0UEZo2",
    "location_id":"9nbWPbH9CZM4PlN5I7il",
    "receiver_type":"MERCHANT",
    "amount":10
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/pay \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{                
    "success": true,
    "status_code": 200,
    "message": "Wallet Pay transaction is successfull.",
    "data": {
        "transaction_no": "TRN00120200001959",
        "merchant_transaction_no": "TRN00120200000006",
        "points_earned": 500
    }      
}
Wallet Pay by PayNow
Wallet Pay by PayNow

This API is used to make payment from wallet using PayNow QR code.

The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/user/wallet/generateQR
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
   No inputs
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/generateQR \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{                
    "success": true,
    "status_code": 200,
    "message": "PaynowQR data retrieved successfully.",
    "data": {
        "qr_code": "00020001021126520009SG.PAYNOW010120213201207298RFLB030110408202012315204630053037025406100.005802SG5913FLEXM PTE LTD6009Singapore62220118DICNSG0012020000236304E623"
    }             
}
Wallet Pay using 7-11
Wallet Pay using 7-11

This API request to validate the QR.

The API uses the following attributes:

Attributes
  • amount
    numberRequired
    Amount in form of cents
Definition
POST https://test-consumer-api.flexm.com/user/wallet/pay/7elevenqr
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    "amount":1000
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/pay/7elevenqr \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Successfully validate QR.",
    "data": {
        "v": "FLM",
        "a": "2101000029",
        "m": 100000
    }
}  
Transaction
User Statement
User Statement

This API is used to send statement to user’s mail.

The API uses the following attributes:

Attributes
  • from_date
    stringRequired
    User Transaction from date
  • to_date
    stringRequired
    User Transaction to date
Definition
POST https://test-consumer-api.flexm.com/user/wallet/statement
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    "from_date":"2020-03-10",
    "to_date":"2020-03-12"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/statement \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Mail sent successfully."
}
Wallet Transaction
Wallet Transaction By Transaction Number

This API is used to retrieve the user wallet transaction information along with the transaction number in URL.

Attributes
  • Url Parameters
    object
    Expand attributesClose attributes
    • transaction_no
      stringRequired
      Transaction Number like (TRN001202000000083)
Definition
GET https://test-consumer-api.flexm.com/user/wallet/transactions/details/{transaction_no}
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
   No inputs
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/transactions/details/{transaction_no} \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "User Transaction retrieved successfully",
    "data": {
        "account_id": "FFyy1zgA1HdXnqnjn4cx",
        "account_number": "2101000078",
        "account_type": "WALLET",
        "amount": 10,
        "balance": 110,
        "category": "wallet-load",
        "country_id": "SGP",
        "created_date": "2020-04-06T11:21:37Z",
        "message": "",
        "narration": "Add Money using card xxxx1111",
        "reference_order_id": "0V8uefPnpSlLKRCAo6zB",
        "reference_order_no": "ORD001202000000360",
        "serial_no": 342,
        "timestamp": 1586172097663,
        "transaction_no": "TRN001202000000342",
        "transaction_type": "Add Money to Wallet",
        "user_id": "dm0SVuea8eU68lcqAkBhZJifJBE3"
    }
}
Wallet Transaction
Wallet Transaction

This API is used to retrieve the user wallet transaction information. If you want to see the latest transaction, please give direction and timestamp in URL or you can pause empty

Attributes
  • Url Parameters
    object
    Expand attributesClose attributes
    • direction
      stringOptional
      Direction like (next / prev)
    • timestamp
      numberOptional
      Timestamp like (1583908884987)
Definition
GET https://test-consumer-api.flexm.com/user/wallet/transaction/{direction}/{timestamp}
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
   No inputs
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/transaction/{direction}/{timestamp} \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "User wallet transaction retrieved successfully.",
    "data": {
        "count": 10,
        "user_wallet_list": [
            {
                "account_id": "9Jv7lfn6nYrFyiWCXLeP",
                "account_number": "0101000008",
                "account_type": "WALLET",
                "amount": 10.5,
                "balance": 322,
                "category": "Add Money to Wallet",
                "country_id": "SGP",
                "created_date": "2020-03-11T09:26:45Z",
                "message": "",
                "narration": "Add Money using card xxxx1111",
                "reference_order_id": "bLW1fhokjTaRwa7yd9ay",
                "reference_order_no": "ORD00120200000026",
                "serial_no": 13,
                "timestamp": 1583918805650,
                "transaction_no": "TRN00120200000013",
                "transaction_type": "Add Money to Wallet",
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "account_id": "9Jv7lfn6nYrFyiWCXLeP",
                "account_number": "0101000008",
                "account_type": "WALLET",
                "amount": 10.5,
                "balance": 311.5,
                "category": "Add Money to Wallet",
                "country_id": "SGP",
                "created_date": "2020-03-11T09:26:30Z",
                "message": "",
                "narration": "Add Money using card xxxx1111",
                "reference_order_id": "LxQfZDfK1yq6IXTziDkL",
                "reference_order_no": "ORD00120200000025",
                "serial_no": 12,
                "timestamp": 1583918790522,
                "transaction_no": "TRN00120200000012",
                "transaction_type": "Add Money to Wallet",
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "account_id": "9Jv7lfn6nYrFyiWCXLeP",
                "account_number": "0101000008",
                "account_type": "WALLET",
                "amount": 10.5,
                "balance": 301,
                "category": "Add Money to Wallet",
                "country_id": "SGP",
                "created_date": "2020-03-11T09:26:13Z",
                "message": "",
                "narration": "Add Money using card xxxx1111",
                "reference_order_id": "hpygy7VVtIKN8zhYoDjC",
                "reference_order_no": "ORD00120200000024",
                "serial_no": 11,
                "timestamp": 1583918773681,
                "transaction_no": "TRN00120200000011",
                "transaction_type": "Add Money to Wallet",
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "account_id": "9Jv7lfn6nYrFyiWCXLeP",
                "account_number": "0101000008",
                "account_type": "WALLET",
                "amount": 10.5,
                "balance": 290.5,
                "category": "Add Money to Wallet",
                "country_id": "SGP",
                "created_date": "2020-03-11T09:25:54Z",
                "message": "",
                "narration": "Add Money using card xxxx1111",
                "reference_order_id": "uPCHgwxWkBPZeUOhiH3o",
                "reference_order_no": "ORD00120200000023",
                "serial_no": 10,
                "timestamp": 1583918754475,
                "transaction_no": "TRN00120200000010",
                "transaction_type": "Add Money to Wallet",
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "account_id": "9Jv7lfn6nYrFyiWCXLeP",
                "account_number": "0101000008",
                "account_type": "WALLET",
                "amount": -10,
                "balance": 280,
                "category": "Wallet Transfer",
                "country_id": "SGP",
                "created_date": "2020-03-11T07:47:33Z",
                "message": "",
                "narration": "Wallet Amount Transferred to - 93667041",
                "reference_order_id": "0",
                "reference_order_no": "0",
                "serial_no": 14,
                "timestamp": 1583912853246,
                "transaction_no": "TRN00120200000014",
                "transaction_type": "Wallet Transfer",
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "account_id": "9Jv7lfn6nYrFyiWCXLeP",
                "account_number": "0101000008",
                "account_type": "WALLET",
                "amount": 100,
                "balance": 290,
                "category": "Add Money to Wallet",
                "country_id": "SGP",
                "created_date": "2020-03-11T07:33:56Z",
                "message": "",
                "narration": "Added money to wallet",
                "reference_order_id": "kE9fKL6pvzk5oRK7WBRK",
                "reference_order_no": "ORD00120200000014",
                "serial_no": 12,
                "timestamp": 1583912036670,
                "transaction_no": "TRN00120200000012",
                "transaction_type": "Add Money to Wallet",
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "account_id": "9Jv7lfn6nYrFyiWCXLeP",
                "account_number": "0101000008",
                "account_type": "WALLET",
                "amount": 10,
                "balance": 190,
                "category": "Add Money to Wallet",
                "country_id": "SGP",
                "created_date": "2020-03-11T07:33:45Z",
                "message": "",
                "narration": "Add Money using card xxxx5252",
                "reference_order_id": "TrMvcKEv7nKILQTvuKC2",
                "reference_order_no": "ORD00120200000013",
                "serial_no": 11,
                "timestamp": 1583912025288,
                "transaction_no": "TRN00120200000011",
                "transaction_type": "Add Money to Wallet",
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "account_id": "9Jv7lfn6nYrFyiWCXLeP",
                "account_number": "0101000008",
                "account_type": "WALLET",
                "amount": 50,
                "balance": 180,
                "category": "Add Money to Wallet",
                "country_id": "SGP",
                "created_date": "2020-03-11T06:47:40Z",
                "message": "",
                "narration": "Added money to wallet",
                "reference_order_id": "YXArD2zYfqMCj8LM8QdN",
                "reference_order_no": "ORD00120200000012",
                "serial_no": 8,
                "timestamp": 1583909260988,
                "transaction_no": "TRN00120200000008",
                "transaction_type": "Add Money to Wallet",
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "account_id": "9Jv7lfn6nYrFyiWCXLeP",
                "account_number": "0101000008",
                "account_type": "WALLET",
                "amount": 5,
                "balance": 130,
                "category": "Add Money to Wallet",
                "country_id": "SGP",
                "created_date": "2020-03-11T06:44:48Z",
                "message": "",
                "narration": "Added money to wallet",
                "reference_order_id": "HGz9IzCA1Zc9s5AxRNPq",
                "reference_order_no": "ORD00120200000011",
                "serial_no": 7,
                "timestamp": 1583909088287,
                "transaction_no": "TRN00120200000007",
                "transaction_type": "Add Money to Wallet",
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "account_id": "9Jv7lfn6nYrFyiWCXLeP",
                "account_number": "0101000008",
                "account_type": "WALLET",
                "amount": 5,
                "balance": 125,
                "category": "Add Money to Wallet",
                "country_id": "SGP",
                "created_date": "2020-03-11T06:41:24Z",
                "message": "",
                "narration": "Added money to wallet",
                "reference_order_id": "uC1drz0bBD6758RTSBhd",
                "reference_order_no": "ORD00120200000010",
                "serial_no": 6,
                "timestamp": 1583908884987,
                "transaction_no": "TRN00120200000006",
                "transaction_type": "Add Money to Wallet",
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            }
        ],
        "links": {
        "prev": "/user/wallet/transaction/prev/1583918805650",
        "next": "/user/wallet/transaction/next/1583908884987"
    }
}
}
Order Transaction
Order Transactions by Order No

This API is used to retrieve the user transaction order information along with the order number in URL.

Attributes
  • Url Parameters
    object
    Expand attributesClose attributes
    • order_number
      stringRequired
      Order Number like (ORD001202000000598)
Definition
GET https://test-consumer-api.flexm.com/user/wallet/order/{order_number}
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
   No inputs
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/order/{order_number} \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "User Order retrieved successfully",
    "data": {
        "amount": 1,
        "country_id": "SGP",
        "created_date": "2020-04-15T10:31:43Z",
        "created_from": "Android",
        "deal_merchant_id": "",
        "merchant_id": "WHITE",
        "metadata": {
            "card_number": "6757",
            "payment_method": "banks"
        },
        "order_no": "ORD001202000000598",
        "order_status": "Order Accepted",
        "order_type": "SALES",
        "payment_type": "Card",
        "product_code": "REMIT-MONEY",
        "product_description": "REMITTANCEBND 1",
        "quantity": 1,
        "terminal": "InApp",
        "timestamp": 1586946703127,
        "unit_price": 1,
        "user_id": "PxHMlbT17mVnVLotncp5sysy4Uz1"
    }
}
Order Transaction
Order Transaction

This API is used to retrieve the user orders transaction information. If you want to see the latest transaction, please give direction and timestamp in URL or you can pause empty

Attributes
  • Url Parameters
    string
  • direction
    stringOptional
    Direction like (next / prev)
  • timestamp
    numberOptional
    Timestamp like (1583908884987)
Definition
GET https://test-consumer-api.flexm.com/user/wallet/order/transaction/{direction}/{timestamp}
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
   No inputs
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/order/transaction/{direction}/{timestamp} \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "User orders transaction retrieved successfully.",
    "data": {
        "count": 10,
        "user_order_list": [
                {
                    "amount": 10.5,
                    "country_id": "SGP",
                    "created_date": "2020-03-11T09:26:42Z",
                    "created_from": "Android",
                    "merchant_id": "WHITE",
                    "order_no": "ORD00120200000026",
                    "order_status": "Order Delivered",
                    "order_type": "SALES",
                    "payment_type": "card",
                    "product_code": "WHITE-BAL",
                    "product_description": "WhiteSGD 10.5",
                    "product_id": "uGoYPs1xhfstetzNoTjy",
                    "quantity": 1,
                    "serial_no": 26,
                    "terminal": "InApp",
                    "timestamp": 1583918802763,
                    "unit_price": 10.5,
                    "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
                },
                {
                    "amount": 10.5,
                    "country_id": "SGP",
                    "created_date": "2020-03-11T09:26:27Z",
                    "created_from": "Android",
                    "merchant_id": "WHITE",
                    "order_no": "ORD00120200000025",
                    "order_status": "Order Delivered",
                    "order_type": "SALES",
                    "payment_type": "card",
                    "product_code": "WHITE-BAL",
                    "product_description": "WhiteSGD 10.5",
                    "product_id": "uGoYPs1xhfstetzNoTjy",
                    "quantity": 1,
                    "serial_no": 25,
                    "terminal": "InApp",
                    "timestamp": 1583918787839,
                    "unit_price": 10.5,
                    "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
                },
                {
                    "amount": 10.5,
                    "country_id": "SGP",
                    "created_date": "2020-03-11T09:26:09Z",
                    "created_from": "Android",
                    "merchant_id": "WHITE",
                    "order_no": "ORD00120200000024",
                    "order_status": "Order Delivered",
                    "order_type": "SALES",
                    "payment_type": "card",
                    "product_code": "WHITE-BAL",
                    "product_description": "WhiteSGD 10.5",
                    "product_id": "uGoYPs1xhfstetzNoTjy",
                    "quantity": 1,
                    "serial_no": 24,
                    "terminal": "InApp",
                    "timestamp": 1583918769917,
                    "unit_price": 10.5,
                    "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
                },
                {
                    "amount": 10.5,
                    "country_id": "SGP",
                    "created_date": "2020-03-11T09:25:50Z",
                    "created_from": "Android",
                    "merchant_id": "WHITE",
                    "order_no": "ORD00120200000023",
                    "order_status": "Order Delivered",
                    "order_type": "SALES",
                    "payment_type": "card",
                    "product_code": "WHITE-BAL",
                    "product_description": "WhiteSGD 10.5",
                    "product_id": "uGoYPs1xhfstetzNoTjy",
                    "quantity": 1,
                    "serial_no": 23,
                    "terminal": "InApp",
                    "timestamp": 1583918750936,
                    "unit_price": 10.5,
                    "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
                },
                {
                    "amount": 100,
                    "country_id": "SGP",
                    "created_date": "2020-03-11T07:33:54Z",
                    "created_from": "Android",
                    "merchant_id": "WHITE",
                    "order_no": "ORD00120200000014",
                    "order_status": "Order Delivered",
                    "order_type": "SALES",
                    "payment_type": "card",
                    "product_code": "WHITE-BAL",
                    "product_description": "WhiteSGD 100",
                    "product_id": "uGoYPs1xhfstetzNoTjy",
                    "quantity": 1,
                    "serial_no": 14,
                    "terminal": "InApp",
                    "timestamp": 1583912034879,
                    "unit_price": 100,
                    "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
                },
                {
                    "amount": 10,
                    "country_id": "SGP",
                    "created_date": "2020-03-11T07:33:43Z",
                    "created_from": "iOS",
                    "merchant_id": "WHITE",
                    "order_no": "ORD00120200000013",
                    "order_status": "Order Delivered",
                    "order_type": "SALES",
                    "payment_type": "card",
                    "product_code": "WHITE-BAL",
                    "product_description": "WhiteSGD 10",
                    "product_id": "uGoYPs1xhfstetzNoTjy",
                    "quantity": 1,
                    "serial_no": 13,
                    "terminal": "InApp",
                    "timestamp": 1583912023589,
                    "unit_price": 10,
                    "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
                },
                {
                    "amount": 50,
                    "country_id": "SGP",
                    "created_date": "2020-03-11T06:47:39Z",
                    "created_from": "Android",
                    "merchant_id": "WHITE",
                    "order_no": "ORD00120200000012",
                    "order_status": "Order Delivered",
                    "order_type": "SALES",
                    "payment_type": "card",
                    "product_code": "WHITE-BAL",
                    "product_description": "WhiteSGD 50",
                    "product_id": "uGoYPs1xhfstetzNoTjy",
                    "quantity": 1,
                    "serial_no": 12,
                    "terminal": "InApp",
                    "timestamp": 1583909259262,
                    "unit_price": 50,
                    "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
                },
                {
                    "amount": 5,
                    "country_id": "SGP",
                    "created_date": "2020-03-11T06:44:46Z",
                    "created_from": "Android",
                    "merchant_id": "WHITE",
                    "order_no": "ORD00120200000011",
                    "order_status": "Order Delivered",
                    "order_type": "SALES",
                    "payment_type": "card",
                    "product_code": "WHITE-BAL",
                    "product_description": "WhiteSGD 5",
                    "product_id": "uGoYPs1xhfstetzNoTjy",
                    "quantity": 1,
                    "serial_no": 11,
                    "terminal": "InApp",
                    "timestamp": 1583909086387,
                    "unit_price": 5,
                    "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
                },
                {
                    "amount": 5,
                    "country_id": "SGP",
                    "created_date": "2020-03-11T06:41:23Z",
                    "created_from": "Android",
                    "merchant_id": "WHITE",
                    "order_no": "ORD00120200000010",
                    "order_status": "Order Delivered",
                    "order_type": "SALES",
                    "payment_type": "card",
                    "product_code": "WHITE-BAL",
                    "product_description": "WhiteSGD 5",
                    "product_id": "uGoYPs1xhfstetzNoTjy",
                    "quantity": 1,
                    "serial_no": 10,
                    "terminal": "InApp",
                    "timestamp": 1583908883187,
                    "unit_price": 5,
                    "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
                },
                {
                    "amount": 10,
                    "country_id": "SGP",
                    "created_date": "2020-03-11T06:40:41Z",
                    "created_from": "Android",
                    "merchant_id": "WHITE",
                    "order_no": "ORD00120200000009",
                    "order_status": "Order Delivered",
                    "order_type": "SALES",
                    "payment_type": "card",
                    "product_code": "WHITE-BAL",
                    "product_description": "WhiteSGD 10",
                    "product_id": "uGoYPs1xhfstetzNoTjy",
                    "quantity": 1,
                    "serial_no": 9,
                    "terminal": "InApp",
                    "timestamp": 1583908841087,
                    "unit_price": 10,
                    "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
                }
            ],
            "links": {
                "prev": "/user/wallet/order/transaction/prev/1583918802763",
                "next": "/user/wallet/order/transaction/next/1583908841087"
            }
        }
    }
Receipt Transaction
Receipt Transactions by Receipt No

This API is used to retrieve the user receipts transaction information along with the receipt number in URL.

Attributes
  • Url Parameters
    string
  • receipt_number
    stringRequired
    Receipt Number like (RCT001202000000250)
Definition
GET https://test-consumer-api.flexm.com/user/wallet/receipt/{receipt_number}
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
   No inputs
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/receipt/{receipt_number} \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "User Receipt retrieved successfully",
    "data": {
        "amount": 1,
        "country_id": "SGP",
        "created_date": "2020-04-03T13:35:14Z",
        "created_from": "7Eleven",
        "discount": 0,
        "is_refund": false,
        "net": 1,
        "order_id": "1L8Y34NnFMT6aus4q4tm",
        "payment_type": "",
        "receipt_no": "RCT001202000000250",
        "receipt_type": "WHITE-BAL",
        "serial_no": 250,
        "timestamp": 1585920914984,
        "user_id": "gsAQJbERlFhHTXR3ZMUS6sCZFjf2"
    }
}
Receipt Transaction
Receipt Transactions

This API is used to retrieve the user receipts transaction information. If you want to see the latest transaction, please give direction and timestamp in URL or you can pause empty

Attributes
  • Url Parameters
    string
  • direction
    stringOptional
    Direction like (next / prev)
  • timestamp
    numberOptional
    Timestamp like (1583908884987)
Definition
GET https://test-consumer-api.flexm.com/user/wallet/receipt/transaction/{direction}/{timestamp}
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
   No inputs
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/receipt/transaction/{direction}/{timestamp} \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "User receipts transaction retrieved successfully.",
    "data": {
        "count": 10,
        "user_receipt_list": [
            {
                "amount": 10.5,
                "country_id": "SGP",
                "created_date": "2020-03-11T09:26:47Z",
                "created_from": "Android",
                "discount": 0,
                "is_refund": false,
                "net": 10.5,
                "order_id": "bLW1fhokjTaRwa7yd9ay",
                "payment_type": "card",
                "receipt_no": "RCT00120200000020",
                "receipt_type": "WHITE-BAL",
                "serial_no": 20,
                "timestamp": 1583918807465,
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "amount": 10.5,
                "country_id": "SGP",
                "created_date": "2020-03-11T09:26:32Z",
                "created_from": "Android",
                "discount": 0,
                "is_refund": false,
                "net": 10.5,
                "order_id": "LxQfZDfK1yq6IXTziDkL",
                "payment_type": "card",
                "receipt_no": "RCT00120200000019",
                "receipt_type": "WHITE-BAL",
                "serial_no": 19,
                "timestamp": 1583918792210,
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "amount": 10.5,
                "country_id": "SGP",
                "created_date": "2020-03-11T09:26:15Z",
                "created_from": "Android",
                "discount": 0,
                "is_refund": false,
                "net": 10.5,
                "order_id": "hpygy7VVtIKN8zhYoDjC",
                "payment_type": "card",
                "receipt_no": "RCT00120200000018",
                "receipt_type": "WHITE-BAL",
                "serial_no": 18,
                "timestamp": 1583918775580,
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "amount": 10.5,
                "country_id": "SGP",
                "created_date": "2020-03-11T09:25:57Z",
                "created_from": "Android",
                "discount": 0,
                "is_refund": false,
                "net": 10.5,
                "order_id": "uPCHgwxWkBPZeUOhiH3o",
                "payment_type": "card",
                "receipt_no": "RCT00120200000017",
                "receipt_type": "WHITE-BAL",
                "serial_no": 17,
                "timestamp": 1583918757166,
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "amount": 100,
                "country_id": "SGP",
                "created_date": "2020-03-11T07:33:57Z",
                "created_from": "Android",
                "discount": 0,
                "is_refund": false,
                "net": 100,
                "order_id": "kE9fKL6pvzk5oRK7WBRK",
                "payment_type": "card",
                "receipt_no": "RCT00120200000011",
                "receipt_type": "WHITE-BAL",
                "serial_no": 11,
                "timestamp": 1583912037556,
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "amount": 10,
                "country_id": "SGP",
                "created_date": "2020-03-11T07:33:46Z",
                "created_from": "iOS",
                "discount": 0,
                "is_refund": false,
                "net": 10,
                "order_id": "TrMvcKEv7nKILQTvuKC2",
                "payment_type": "card",
                "receipt_no": "RCT00120200000010",
                "receipt_type": "WHITE-BAL",
                "serial_no": 10,
                "timestamp": 1583912026390,
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "amount": 50,
                "country_id": "SGP",
                "created_date": "2020-03-11T06:47:41Z",
                "created_from": "Android",
                "discount": 0,
                "is_refund": false,
                "net": 50,
                "order_id": "YXArD2zYfqMCj8LM8QdN",
                "payment_type": "card",
                "receipt_no": "RCT00120200000009",
                "receipt_type": "WHITE-BAL",
                "serial_no": 9,
                "timestamp": 1583909261970,
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "amount": 5,
                "country_id": "SGP",
                "created_date": "2020-03-11T06:44:49Z",
                "created_from": "Android",
                "discount": 0,
                "is_refund": false,
                "net": 5,
                "order_id": "HGz9IzCA1Zc9s5AxRNPq",
                "payment_type": "card",
                "receipt_no": "RCT00120200000008",
                "receipt_type": "WHITE-BAL",
                "serial_no": 8,
                "timestamp": 1583909089282,
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "amount": 5,
                "country_id": "SGP",
                "created_date": "2020-03-11T06:41:26Z",
                "created_from": "Android",
                "discount": 0,
                "is_refund": false,
                "net": 5,
                "order_id": "uC1drz0bBD6758RTSBhd",
                "payment_type": "card",
                "receipt_no": "RCT00120200000007",
                "receipt_type": "WHITE-BAL",
                "serial_no": 7,
                "timestamp": 1583908886097,
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            },
            {
                "amount": 10,
                "country_id": "SGP",
                "created_date": "2020-03-11T06:40:44Z",
                "created_from": "Android",
                "discount": 0,
                "is_refund": false,
                "net": 10,
                "order_id": "lHwvmhjQ70bRL3HzXVj7",
                "payment_type": "card",
                "receipt_no": "RCT00120200000006",
                "receipt_type": "WHITE-BAL",
                "serial_no": 6,
                "timestamp": 1583908844054,
                "user_id": "1miGXYz3etfnuAJQ83YEEsA1txq2"
            }
        ],
        "links": {
            "prev": "/user/wallet/receipt/transaction/prev/1583918807465",
            "next": "/user/wallet/receipt/transaction/next/1583908844054"
        }
    }
}
Airtime
Countries List
Countries List

This API is used to retrieve the available airtime country’s information.

The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/user/airtime/countries
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
    No inputs 
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/airtime/countries \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{   
    "success": true,
    "status_code": 200,
    "message": "Airtime countries retrieved successfully.",
    "data": [
        {
            "country": "Bangladesh",
            "country_id": "678",
            "country_code": 880
        },
        {
            "country": "India",
            "country_id": "766",
            "country_code": 91
        },
        {
            "country": "Indonesia",
            "country_id": "767",
            "country_code": 62
        },
        {
            "country": "Myanmar",
            "country_id": "816",
            "country_code": 95
        },
        {
            "country": "Philippines",
            "country_id": "840",
            "country_code": 63
        },
        {
            "country": "Singapore",
            "country_id": "863",
            "country_code": 65
        },
        {
            "country": "Vietnam",
            "country_id": "908",
            "country_code": 84
        }
    ]             
}
Product List
Product List

This API is used to retrieve the available airtime top-up product information.

The API uses the following attributes:

Attributes
  • mobile_no
    stringRequired
    Mobile Number
Definition
POST https://test-consumer-api.flexm.com/user/airtime/product/list
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
    "mobile_no":"6593667047"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/airtime/product/list \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{                
    "success": true,
    "status_code": 200,
    "message": "Airtime product list retrieved successfully.",
    "data": {
        "country": "Singapore",
        "countryid": "863",
        "operator": "M1 Singapore",
        "operatorid": "1728",
        "connection_status": "100",
        "destination_msisdn": "6593667047",
        "destination_currency": "SGD",
        "product_list": [
            "10",
            "18"
        ],
        "service_fee_list": [
            "0.00",
            "0.00"
        ],
        "retail_price_list": [
            "10.00",
            "18.00"
        ],
        "wholesale_price_list": [
            "9.50",
            "17.10"
        ],
        "local_info_value_list": [
            "10.00",
            "18.00"
        ],
        "local_info_amount_list": [
            "10.00",
            "18.00"
        ],
        "local_info_currency": "SGD",
        "authentication_key": "157984658691580",
        "error_code": "0",
        "error_txt": "Transaction successful"
    }    
}
Topup
Topup

This API is used to perform airtime top-up.

The API uses the following attributes:

Attributes
  • provider_topup_amount
    stringRequired
    Topup Amount from Airtime product list API
  • destination_msisdn
    stringRequired
    Receiver Mobile number
  • wallet_amount
    numberRequired
    Wallet Amount in form of 2 decimal places
  • operator_id
    stringRequired
    Operator ID for topup
  • created_from
    stringRequired
    Created From device type
  • payment_type
    stringRequired
    Payment Type Wallet or card
  • terminal
    stringRequired
    Terminal from InApp or BackOffice
Definition
POST https://test-consumer-api.flexm.com/user/airtime/topup
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
    "provider_topup_amount": "18",
    "destination_msisdn": "6593667047",
    "wallet_amount": 3,
    "operator_id": "1728",
    "created_from": "Android",
    "payment_type": "WALLET",
    "terminal": "InApp"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/airtime/topup \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{                
    "success": true,
    "status_code": 200,
    "message": "Topup has been sent successfully",
    "data": {
        "order_no": "ORD00120200002686",
        "receipt_no": "RCT00120200000598",                    
        "transaction_no": "TRN00120200001970",
        "points_earned": 90
    }    
}
Voucher
Purchase Voucher
Purchase Voucher

This API is used to purchase a Voucher.

The API uses the following attributes:

Attributes
  • amount
    numberRequired
    Amount in form of 2 decimal places
  • payment_type
    stringRequired
    Payment Type Wallet or Points
  • merchant_id
    stringRequired
    Merchant ID
  • deal_id
    stringRequired
    Deal ID
  • created_from
    stringRequired
    Created From device type
  • terminal
    stringRequired
    Terminal from InApp or BackOffice
Definition
POST https://test-consumer-api.flexm.com/merchant/products/voucher/purchase
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
    "amount": 5,
    "payment_type": "POINTS",
    "merchant_id": "8pRPVgXGgBnNWAil0MFK",
    "deal_id": "zyP4NQM9hwPJe41twqCN",
    "created_from": "Android",
    "terminal": "InApp"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/merchant/products/voucher/purchase \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Vouchers created successfully",
    "data": {
        "order_id": "UyaIxQcyPIHmc3bSByw8",
        "order_no": "ORD00120200002690",
        "voucher_id": "UCcsDhLJeWXEC4V0zgVU",
        "voucher": {
            "order_id": "UyaIxQcyPIHmc3bSByw8",
            "redeemed_date": "",
            "amount": 5,
            "created_date": "2020-01-24T06:51:04Z",
            "expiry_date": "2020-04-22T18:30:00Z",
            "merchant_id": "8pRPVgXGgBnNWAil0MFK",
            "coupon_code": "4ZsJDDqj",
            "merchant": {
                "MID": "MCD134",
                "created_date": "2019-12-23T12:45:59Z",
                "is_home_list": true,
                "home_list_order": 9,
                "logo": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/merchant%2F101-logo-product-pic%403x.jpg?alt=media&token=0aa6ab1a-4724-415a-b4b7-58a67b8bf794",
                "code": "FA001",
                "cover_image": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/merchant%2Fgroup%403x.jpg?alt=media&token=fb8ea784-e579-4c13-a508-60f908fddb35",
                "is_active": true,
                "name": "Fitta active",
                "profile_image": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/merchant%2Fgroup-18-copy-12%403x.jpg?alt=media&token=0d99ff24-ac56-4dff-8e56-caff12ad49d6",
                "timestamp": 1577105159284,
                "tags": []
            },
            "payment_type": "POINTS",
            "is_redeemed": false,
            "product_id": "zyP4NQM9hwPJe41twqCN",
            "timestamp": 1579848664423,
            "product": {
                "price": 160,
                "expiry_date": "2020-01-10T12:49:51Z",
                "points": 10,
                "description": "Excepteur sint occaecat cupidatat non proident, sunt in \nculpa qui officia deserunt mollit anim id laborum adipiscing \nelit, sed do eiusmod tempor incididunt",
                "code": "FA001",
                "merchant_id": "8pRPVgXGgBnNWAil0MFK",
                "is_unlimited": false,
                "available_stock_qty": 27,
                "is_active": true,
                "product_category": "Lifestyle",
                "image": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/products%2F11offers-detail%403x.jpg?alt=media&token=06c313a1-a254-41c6-aec0-97701faeff55",
                "expiry_timestamp": 1578660591000,
                "timestamp": 1577105486858,
                "title": "Fitta active",
                "consumed_qty": 3,
                "image_thumb": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/products%2Fgroup-18-copy-12%403x.jpg?alt=media&token=9d1cab4f-a30a-407f-9426-5ae6d223887b",
                "groups": [],
                "stock_qty": 30,
                "terms": "**what’s inside**\n- 25% off sitewide\n\n**how to redeem**\n- add any product of your choice to the cart\n- apply the coupon to the cart page & proceed\n   to checkout.\n\n**terms & conditions** \n- valid for one time use only by each customer\n- delivery will take 5-7 days\n- one will receive an email confirmation upon\n   placing the order.\n- please check the spam inbox as well for the\n   email confirmation.\n\n**Stock availability**\n- in stock\n",
                "created_date": "2019-12-23T12:51:26Z"
            },
            "user_id": "42WMJZ5HEUOb2AXAENxvGOhuUod2",
            "product_code": "FA001"
        }
    }    
}
Remittance
Get Countries
Get Countries

This API is used to retrieve the available remittance country’s information along with delivery methods and exchange rates.

The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/user/wallet/remittance/countries
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    No Inputs
}        
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/remittance/countries \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Remittance Countries retrieved successfully.",
    "data": {
        "countries": [
            {
                "remittance_enabled": true,
                "is_active": true,
                "alpha_2_code": "BD",
                "name": "Bangladesh",
                "currency_symbol": "৳",
                "flag": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/remittance%2Fflag-of-Bangladesh.png?alt=media&token=a84368e3-777c-43cd-90c1-b21946124e5c",
                "timestamp": 1573718489675,
                "currency_code": "BDT",
                "delivery_methods": [
                    {
                        "name": "Instant Cash",
                        "exchange_rates": [
                            {
                                "created_date": "2020-01-30T12:26:04Z",
                                "name": "Agrani",
                                "type": "agrani",
                                "rate": 62.5,
                                "duration": "2-4 days"
                            }
                        ],
                    "code": "05",
                    "id": "instant_cash"
                    }
                ],
                "telephone_code": 880,
                "currency_name": "Bangladeshi taka",
                "created_date": "2037-11-14T08:01:29Z",
                "alpha_3_code": "BGD",
                "language": "Bengali",
                "numeric_code": 50
            },
            {
            "created_date": "2124-11-14T08:01:29Z",
            "alpha_3_code": "IDN",
            "language": "Indonesian",
            "numeric_code": 360,
            "is_active": false,
            "alpha_2_code": "ID",
            "remittance_enabled": true,
            "name": "Indonesia",
            "currency_symbol": "Rp",
            "flag": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/remittance%2Fflag-of-Indonesia.png?alt=media&token=fecbc336-76c4-4688-9774-786914c3e275",
            "timestamp": 1573718489762,
            "currency_code": "IDR",
            "delivery_methods": [
                {
                    "name": "Account Deposit",
                    "exchange_rates": [
                        {
                            "name": "iPay Remit",
                            "type": "iPay",
                            "duration": "3333",
                            "logo": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/remittance%2Fmoney_deposit_bank-512.png?alt=media&token=68d7960f-d1e2-4910-85c7-fdaf69e48dcc",
                            "rate": 10453,
                            "created_date": "2020-01-27T12:26:04Z"
                        }
                    ],
                    "code": "ACCOUNT DEPOSIT",
                    "id": "account_deposit",
                    "icon": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/remittance%2Fmoney_deposit_bank-512.png?alt=media&token=68d7960f-d1e2-4910-85c7-fdaf69e48dcc"
                },
                {
                    "name": "Bank Transfer",
                    "exchange_rates": [
                        {
                            "duration": "3333",
                            "logo": "https://firebasestorage.googleapis.com/v0/b/fwmp-e27b3.appspot.com/o/icons%2Fremittance%2Fbank.png?alt=media&token=df07d6d7-d2de-468a-b052-4215f8fcc91f",
                            "rate": 10453,
                            "created_date": "2020-01-23T12:34:13Z",
                            "name": "iPay Remit",
                            "type": "iPay"
                        }
                    ],
                    "code": "BANK TRANSFER",
                    "id": "banks",
                    "icon": "https://firebasestorage.googleapis.com/v0/b/fwmp-e27b3.appspot.com/o/icons%2Fremittance%2Fbank.png?alt=media&token=df07d6d7-d2de-468a-b052-4215f8fcc91f"
                },
                {
                    "code": "CASH PAY",
                    "fixed_rate": 12,
                    "name": "Cash Pickup",
                    "exchange_rates": [
                        {
                            "name": "iPay Remit",
                            "type": "iPay",
                            "duration": "3333",
                            "logo": "https://firebasestorage.googleapis.com/v0/b/fwmp-e27b3.appspot.com/o/icons%2Fremittance%2Fcash.png?alt=media&token=ab551e40-4da4-4739-bada-54e23c65bd48",
                            "rate": 10453,
                            "created_date": "2020-01-23T12:34:13Z"
                        }
                    ],
                    "id": "cash_pickup",
                    "icon": "https://firebasestorage.googleapis.com/v0/b/fwmp-e27b3.appspot.com/o/icons%2Fremittance%2Fcash.png?alt=media&token=ab551e40-4da4-4739-bada-54e23c65bd48"
                },
                {
                "name": "Home Deliver",
                "exchange_rates": [
                    {
                        "type": "iPay",
                        "duration": "3333",
                        "logo": "https://firebasestorage.googleapis.com/v0/b/fwmp-e27b3.appspot.com/o/icons%2Fremittance%2Fcash.png?alt=media&token=ab551e40-4da4-4739-bada-54e23c65bd48",
                        "rate": 10453,
                        "created_date": "2020-01-23T12:34:13Z",
                        "name": "iPay Remit"
                    }
                ],
                "code": "HOME DELIVER",
                "id": "home_deliver",
                "icon": "https://firebasestorage.googleapis.com/v0/b/fwmp-e27b3.appspot.com/o/icons%2Fremittance%2Fcash.png?alt=media&token=ab551e40-4da4-4739-bada-54e23c65bd48"
            }
        ],                    
        "telephone_code": 62,
        "currency_name": "Indonesian rupiah"
    },
    {
        "telephone_code": 91,
        "currency_name": "Indian rupee",
        "created_date": "2123-11-14T08:01:29Z",
        "alpha_3_code": "IND",
        "language": "Hindi",
        "numeric_code": 356,
        "is_active": true,
        "alpha_2_code": "IN",
        "remittance_enabled": true,
        "name": "India",
        "currency_symbol": "₹",
        "flag": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/remittance%2Fflag-of-India.png?alt=media&token=6fcfa76d-1345-42b6-8bbe-ab67273ca7e7",
        "timestamp": 1573718489761,
        "currency_code": "INR",
        "delivery_methods": [
            {
            "id": "account_deposit",
            "icon": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/remittance%2Fmoney_deposit_bank-512.png?alt=media&token=68d7960f-d1e2-4910-85c7-fdaf69e48dcc",
            "name": "Account Deposit",
            "exchange_rates": [
                {
                    "logo": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/remittance%2Fmoney_deposit_bank-512.png?alt=media&token=68d7960f-d1e2-4910-85c7-fdaf69e48dcc",
                    "rate": 50.7957,
                    "is_active": true,
                    "created_date": "2020-01-27T12:26:03Z",
                    "name": "iPay Remit",
                    "type": "iPay",
                    "duration": "2 - 4 days"
                },
                {
                    "is_active": true,
                    "logo": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/merchant%2FC381C324-08E1-40D1-B458-CCADF1283E9E.png?alt=media&token=acc7d855-73cd-42ed-a702-29283598cd20",
                    "name": "WHITE",
                    "type": "WHITE"
                }
            ],
            "code": "ACCOUNT DEPOSIT"
        },
        {
            "name": "Bank Transfer",
            "exchange_rates": [
                {
                    "created_date": "2020-01-23T12:34:10Z",
                    "name": "iPay Remit",
                    "type": "iPay",
                    "duration": "2 - 4 days",
                    "logo": "https://firebasestorage.googleapis.com/v0/b/fwmp-e27b3.appspot.com/o/icons%2Fremittance%2Fbank.png?alt=media&token=df07d6d7-d2de-468a-b052-4215f8fcc91f",
                    "rate": 50.7957,
                    "is_active": true
                },
                {
                    "rate": 80,
                    "is_active": true,
                    "name": "WHITE",
                    "fixed_rate": 25,
                    "type": "WHITE",
                    "duration": "2 - 4 days",
                    "logo": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/merchant%2FC381C324-08E1-40D1-B458-CCADF1283E9E.png?alt=media&token=acc7d855-73cd-42ed-a702-29283598cd20"
                }
            ],
            "code": "BANK TRANSFER",
            "id": "banks",
            "icon": "https://firebasestorage.googleapis.com/v0/b/fwmp-e27b3.appspot.com/o/icons%2Fremittance%2Fbank.png?alt=media&token=df07d6d7-d2de-468a-b052-4215f8fcc91f"
        },
        {
            "name": "Cash Pickup",
            "exchange_rates": [
                {
                    "logo": "https://firebasestorage.googleapis.com/v0/b/fwmp-e27b3.appspot.com/o/icons%2Fremittance%2Fcash.png?alt=media&token=ab551e40-4da4-4739-bada-54e23c65bd48",
                    "rate": 50.7957,
                    "is_active": true,
                    "created_date": "2020-01-23T12:34:10Z",
                    "name": "iPay Remit",
                    "type": "iPay",
                    "duration": "2 - 4 days"
                },
                {
                    "name": "WHITE",
                    "fixed_rate": 12,
                    "type": "WHITE",
                    "duration": "2 - 4 days",
                    "logo": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/merchant%2FC381C324-08E1-40D1-B458-CCADF1283E9E.png?alt=media&token=acc7d855-73cd-42ed-a702-29283598cd20",
                    "rate": 65,
                    "is_active": true
                }
            ],
            "code": "CASH PAY",
            "id": "cash_pickup",
            "icon": "https://firebasestorage.googleapis.com/v0/b/fwmp-e27b3.appspot.com/o/icons%2Fremittance%2Fcash.png?alt=media&token=ab551e40-4da4-4739-bada-54e23c65bd48"
        }
    ],                
}
]
}
}
Remittance Validate
Remittance Validate

This API is used to retrieve the available remittance provider details.

The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/user/wallet/remittance/validate
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    No Inputs
}        
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/remittance/validate \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
"success": true,
"status_code": 200,
"message": "Remittance Provider details retrieved successfully.",
"data": {
    "provider_details": [
    {
        "name": "agrani",
        "is_active": false
    },
    {
        "name": "ipay",
        "is_active": true
    },
    {
        "name": "white",
        "is_active": false
    },
    {
        "name": "jdee",
        "is_active": false
    }
    ]
}
}
Get Merchant For White
Get Merchant

This API is used to retrieve the available agent/bank branches based on the merchant and delivery methods for white information.

The API uses the following attributes:

Attributes
  • merchant_code
    stringRequired
    Remittance Provider Merchant Code from Get Countries Request
  • delivery_method_id
    stringRequired
    Delivery Method ID of Remittance Provider from Get Countries Request
  • receiver_country_code
    stringRequired
    Country 3-letter alpha code from Get Countries Request
Definition
POST https://test-consumer-api.flexm.com/user/wallet/remittance/merchant
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    "merchant_code":"white",
    "delivery_method_id":"banks",
    "receiver_country_code":"IND"
}               
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/remittance/merchant \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Remittance agent details retrieved successfully.",
    "data": {
        "payout_agents": [
            {
                "name": "Indian Bank",
                "created_date": "2019-12-18T05:32:22Z",
                "timestamp": 1576647142616,
                "icon": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/corridor%2Funnamed%20(1).png?alt=media&token=29c8983a-e5db-48c1-b1bd-c2331c2622cf",
                "id": "banks",
                "code": "B001",
                "payout_agents_id": "Xsbxbm0lAUnuEGUD7mKx",
                "country_id": "IND"
            },
            {
                "code": "B002",
                "name": "State Bank of India",
                "created_date": "2019-12-18T05:33:11Z",
                "timestamp": 1576647191921,
                "icon": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/corridor%2FSBI-logo.svg?alt=media&token=8a2e4be1-b2ef-4802-aec6-4ae30271a932",
                "id": "banks",
                "payout_agents_id": "i1DNgeJpyJNMPPqELCmK",
                "country_id": "IND"
            }
        ]
    }
}
Get Merchant For ipay
Get Merchant

This API is used to retrieve the available agent/bank branches based on the merchant and delivery methods for ipay information.

The API uses the following attributes:

Attributes
  • merchant_code
    stringRequired
    Remittance Provider Merchant Code from Get Countries Request
  • delivery_method_id
    stringRequired
    Delivery Method ID of Remittance Provider from Get Countries Request
  • receiver_country_code
    stringRequired
    Country 3-letter alpha code from Get Countries Request
Definition
POST https://test-consumer-api.flexm.com/user/wallet/remittance/merchant
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    "merchant_code":"ipay",
    "delivery_method_id":"banks",
    "receiver_country_code":"AUS"
}                 
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/remittance/merchant \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Remittance agent details retrieved successfully.",
    "data": {
        "payout_agents": [
            {
                "code": "10000028",
                "created_date": "2020-03-13T06:13:31Z",
                "id": "account_deposit",
                "is_active": true,
                "is_deleted": false,
                "name": "Transcash International Pty Ltd",
                "timestamp": 1584080011191,
                "payout_agents_id": "cy7ekI9gexFuGOGVNeI7",
                "country_id": "AUS",
                "delivery_method_id": "zhMGbSqwlILm1DlGkBQB",
                "branches": [
                    {
                        "address": "",
                        "agent": "United Overseas Bank Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2984",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Australia and New Zealand Banking Group Limited (ANZ)",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "898",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "G&ampC Mutual Bank (a trading name of SGE Mutual Limited)",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2976",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Bank of America National Association",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2938",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Greater Building Society Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2954",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "IMB Bank",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2650",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "AMP Bank Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "897",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "BNP Paribas",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2943",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Police Bank Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2654",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Bank of Queensland Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "899",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Indue Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2958",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Qudos Bank",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2655",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Ubank",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2661",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Cuscal Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2949",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Bank of Tokyo-Mitsubishi UFJ, Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2941",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Holiday Coast Credit Union Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2956",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "80 Grenfell Street",
                        "agent": "Bendigo and Adelaide Bank Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "902",
                        "branch": "Adelaide",
                        "city": "Adelaide",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "610-102",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Big Sky Building Society Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2975",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Taiwan Business Bank, Sydney Branch",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2982",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Police &amp Nurses Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2653",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Capricornian Ltd (The)",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2945",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Macquarie Bank Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "904",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "BNP Paribas Securities Services",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2944",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Encompass Credit Union Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2952",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Hume Bank Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2649",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Uniting Financial Services",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2985",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Teachers Mutual Bank Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2660",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Westpac Banking Corporation",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "906",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Community First Credit Union Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2946",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Heritage Bank Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2648",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Citibank Australia",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2879",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Oversea-Chinese Banking Corporation Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2969",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Select Credit Union Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2974",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Australia Post (Money Orders)",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2936",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Maitland Mutual Building Society Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2962",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Sutherland Credit Union Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2981",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Summerland Credit Union Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2980",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Bankwest",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2928",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Gateway Credit Union Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2953",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Rabobank Australia Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2919",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Sumitomo Mitsui Banking Corporation",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2979",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Bank of Sydney Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2942",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Hongkong &amp Shanghai Banking Corporation Limited (The), Australian Branch",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2957",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "UBS AG, Australia Branch",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2983",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "JP Morgan Chase Bank, National Association",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2961",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Rural Bank Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2657",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "B&ampE Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2937",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "HSBC Bank Australia Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "910",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "Level 1 175 Pitt Street",
                        "agent": "Bendigo and Adelaide Bank Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "902",
                        "branch": "Leveraged Equities",
                        "city": "Sydney",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "610-104",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Members Equity Pty Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "905",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Bank of China (Australia) Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2939",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Bank of Melbourne",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2641",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "St. George Bank Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2658",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "ECU Australia Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2951",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Newcastle Permanent Building Society Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2968",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "State Street Bank and Trust Company",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2978",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Southern Cross Credit Union Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2977",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Suncorp-Metway Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2659",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Deutsche Bank Aktiengesellschaft",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2950",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Australian Defence Credit Union Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2638",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Maritime Mining &amp Power Credit Union Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2963",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "Shop 156-B5 156 Joplin Lane ANU",
                        "agent": "Commonwealth Bank of Australia",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2020",
                        "branch": "Australian National University",
                        "city": "Acton",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "062-903",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Delphi Bank (a division of Bendigo and Adelaide Bank Limited)",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2646",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Bank of China",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "908",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Auswide Bank Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2924",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Bank SA",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2643",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Royal Bank of Scotland PLC, Australia Branch (The)",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2973",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "ING Bank, NV (Sydney Branch)",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2960",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Heritage Isle Credit Union Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2955",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Mizuho Bank, Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2966",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Beyond Bank Australia",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2644",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Warwick Credit Union Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2986",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Tyro Payments Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2967",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Mega International Commercial Bank Co, Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2965",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "National Australia Bank Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2652",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Australian Settlements Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2639",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "ING Bank (Australia) Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2021",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Mystate Bank Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2651",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Credit Union Australia Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2948",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Defence Bank Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2645",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Mecu Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2964",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Reserve Bank of Australia",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2971",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Railways Credit Union Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2970",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Industrial and Commercial Bank of China Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2959",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "QT Mutual Bank Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2656",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Rock Building Society Limited (The)",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2972",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Bank of Communications Co., Ltd Sydney Branch",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2940",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Arab Bank Australia Limited",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "907",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Bank Australia",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2640",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    },
                    {
                        "address": "",
                        "agent": "Community Mutual Ltd",
                        "bank_branch_id": "",
                        "bank_branch_state": "",
                        "bank_id": "2947",
                        "branch": "",
                        "city": "",
                        "currency": "AUD",
                        "location_id": "10090054",
                        "optional_field": "",
                        "payout_agent_id": "10000028"
                    }
                ]
            }
        ]
    }
}
Get Merchant For Agrani
Get Merchant

This API is used to retrieve the available agent/bank branches based on the merchant and delivery methods for ipay information.

The API uses the following attributes:

Attributes
  • merchant_code
    stringRequired
    Remittance Provider Merchant Code from Get Countries Request
  • delivery_method_id
    stringRequired
    Delivery Method ID of Remittance Provider from Get Countries Request
  • receiver_country_code
    stringRequired
    Country 3-letter alpha code from Get Countries Request
Definition
POST https://test-consumer-api.flexm.com/user/wallet/remittance/merchant
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    "merchant_code":"agrani",
    "delivery_method_id":"cash_pickup",
    "receiver_country_code":"BGD"
}                 
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/remittance/merchant \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Remittance agent details retrieved successfully.",
    "data": {
        "payout_agents": [
            {
                "code": 0,
                "created_date": "2020-02-24T08:02:32Z",
                "id": "cash_pickup",
                "is_active": true,
                "name": "AGRANI BANK LTD.",
                "timestamp": 1582531352477,
                "payout_agents_id": "",
                "country_id": "BGD",
                "delivery_method_id": "",
                "branches": [
            {
                "address": "",
                "agent": "AGRANI BANK LTD.",
                "bank_branch_id": 0,
                "bank_branch_state": "",
                "bank_id": "",
                "branch": "AGRANI BANK LTD.",
                "city": "",
                "created_date": "2020-02-24T08:02:33Z",
                "currency": "",
                "is_deleted": false,
                "location_id": "",
                "optional_field": "",
                "payout_agent_id": "",
                "timestamp": 1582531353040
            }
        ]
    }
]
}
}
Remittance Validate For iPay
Remittance Validate For iPay

This API is used to validate the user details to perform iPay Remittance.

The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/user/wallet/remittance/ipay/validate
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
  No inputs  
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/remittance/ipay/validate \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Success"
}
Calculate Remittance For iPay
Calculate Remittance For iPay

This API is used to calculate the remittance amount based on the exchange rate and service charges. This API is used only on iPay Remittance.

The API uses the following attributes:

Attributes
  • transfer_amount
    numberRequired
    Transfer Amount in form of 2 decimal places
  • payment_mode
    stringRequired
    Payment Mode from Remittance Merchant API
  • location_id
    stringRequired
    Location ID from Get Merchant API
  • payout_country
    stringRequired
    Payout Country from Get Merchant API
Definition
POST https://test-consumer-api.flexm.com/user/wallet/remittance/calculate
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    "transfer_amount": 100,
    "payment_mode": "banks",
    "location_id": "10114543",
    "payout_country": "INDIA"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/remittance/calculate \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{                                
    "success": true,
    "status_code": 200,
    "message": "Remittance amount and service charges retrieved successfully.",
    "data": {
        "code": "0",
        "agent_session_id": "1233",
        "message": "MUTHOOT",
        "collect_amt": "100.0000",
        "collect_currency": "SGD",
        "service_charge": "0.0000",
        "exchange_rate": "50.7957",
        "payout_amt": "5080.0000",
        "payout_currency": "INR",
        "exrate_session_id": "1509741"
    }
}               
Create Remittance For White
Create Remittance For White

This API is used for the create remittance transaction for white

The API uses the following attributes:

Attributes
  • purpose
    stringRequired
    Purpose of Remittance
  • source_of_fund
    stringRequired
    Source of Fund
  • terminal
    stringRequired
    Terminal
  • created_from
    stringRequired
    Created From device type
  • delivery_method_id
    stringRequired
    Delivery Method ID information
  • merchant_code
    stringRequired
    Merchant Code information from Get Merchant API
  • payment_type
    stringRequired
    Payment Type from Get Merchant API
  • beneficiary
    object
    Expand attributesClose attributes
    • first_name
      stringRequired
      Beneficiary First Name
    • last_name
      stringRequired
      Beneficiary Last Name
    • mobile_no
      stringRequired
      Beneficiary Mobile Number
    • address_1
      stringRequired
      Beneficiary Address Line 1
    • address_2
      stringRequired
      Beneficiary Address Line 2
    • city
      stringRequired
      Beneficiary City
    • state
      stringRequired
      Beneficiary State
    • country
      stringRequired
      Beneficiary Country
    • zipcode
      stringRequired
      Beneficiary Zipcode
    • relationship
      stringRequired
      Sender relationship with beneficiary
    • bank_details
      object
      Only if delivery mode bank
      Expand attributesClose attributes
      • account_number
        stringRequired
        Receiver bank account number information
      • name
        string
        Name of the Remittance Bank information
    • currency_details
      string
    • exchange_rate
      stringRequired
      Exchange Rate from Get countries API
    • receive_amount
      stringRequired
      Receiver Amount in form of 2 decimal places
    • receive_country
      stringRequired
      Receiver Country information
    • receive_country_id
      stringRequired
      Receiver Country ID information from Get Merchant API
    • receive_currency
      stringRequired
      Receiver Currency information
    • send_amount
      stringRequired
      Sender Amount in form of 2 decimal places
    • send_country
      stringRequired
      Sender Country information
    • send_currency
      stringRequired
      Sender Currency information
    • service_charge
      stringRequired
      Service Charge from Get countries API
    • total_amount
      stringRequired
      Total Amount calculated by sender amount with service charge
Definition
POST https://test-consumer-api.flexm.com/user/wallet/remittance/transfer
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    "purpose": "Family Support",
    "source_of_fund": "Loan",
    "terminal": "InApp",
    "created_from": "Android",
    "delivery_method_id": "banks",
    "merchant_code": "white",
    "payment_type": "Wallet",
    "beneficiary": {
        "first_name": "SHARMIN",
        "last_name": "AKHTER",
        "mobile_no": "01933507684",
        "address_1": "MG",
        "address_2": "SVR",        
        "city": "Dhaka",
        "state": "Dhaka",
        "country": "Bangladesh",
        "zipcode": "987456",       
        "id_number": "547788",
        "id_type": "Passport",           
        "relationship": "friend",           
        "bank_details": {
            "account_number": "2222222222222222",
            "name": "Bangladesh Bank"
        }
    },   
    "currency_details": {
        "exchange_rate": 61.27000045776367,
        "receive_amount": 152.87500381469727,
        "receive_country": "Bangladesh",
        "receive_country_id": "BGD",
        "receive_currency": "BDT",
        "send_amount": 2.5,
        "send_country": "Singapore",
        "send_currency": "SGD",
        "service_charge": 0,
        "total_amount": 2.5
    }
}

Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/remittance/transfer \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Remittance is successful.",
    "data": {
        "order_no": "ORD00120200002957",
        "transaction_no": "TRN00120200002330",
        "points_earned": 350,                                     
    }
}
Create Remittance For iPay
Create Remittance For iPay

This API is used for the create remittance transaction for iPay

The API uses the following attributes:

Attributes
  • purpose
    stringRequired
    Purpose of Remittance
  • source_of_fund
    stringRequired
    Source of Fund
  • terminal
    stringRequired
    Terminal
  • created_from
    stringRequired
    Created From device type
  • delivery_method_id
    stringRequired
    Delivery Method ID information
  • merchant_code
    stringRequired
    Merchant Code information from Get Merchant API
  • payment_type
    stringRequired
    Payment Type from Get Merchant API
  • beneficiary
    object
    Expand attributesClose attributes
    • first_name
      stringRequired
      Beneficiary First Name
    • last_name
      stringRequired
      Beneficiary Last Name
    • mobile_no
      stringRequired
      Beneficiary Mobile Number
    • address_1
      stringRequired
      Beneficiary Address Line 1
    • address_2
      stringRequired
      Beneficiary Address Line 2
    • city
      stringRequired
      Beneficiary City
    • state
      stringRequired
      Beneficiary State
    • country
      stringRequired
      Beneficiary Country
    • zipcode
      stringRequired
      Beneficiary Zipcode
    • id_number
      stringRequired
      Beneficiary ID Number
    • id_type
      stringRequired
      Beneficiary ID Type
    • relationship
      stringRequired
      Sender relationship with beneficiary
    • bank_details
      object
      Only if delivery mode bank
      Expand attributesClose attributes
      • account_number
        stringRequired
        Receiver bank account number information
      • agent_id
        string
        agent ID from Merchant iPay API
      • name
        string
        Name of the Remittance Bank information
      • branch
        string
        Receiver bank branch information
      • location_id
        string
        Location ID from Merchant iPay API
    • currency_details
      string
    • exchange_rate
      stringRequired
      Exchange Rate from Calculate remittance API
    • receive_amount
      stringRequired
      Receiver Amount from Calculate remittance API
    • receive_country
      stringRequired
      Receiver Country information
    • receive_country_id
      stringRequired
      Receiver Country ID information from Get Merchant API
    • receive_currency
      stringRequired
      Receiver Currency information
    • send_amount
      stringRequired
      Sender Amount in form of 2 decimal places
    • send_country
      stringRequired
      Sender Country information
    • send_currency
      stringRequired
      Sender Currency information
    • service_charge
      stringRequired
      Service Charge from Calculate remittance API
    • total_amount
      stringRequired
      Total Amount calculated by sender amount with service charge
Definition
POST https://test-consumer-api.flexm.com/user/wallet/remittance/transfer
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
    {
        "purpose": "Family Support",
        "source_of_fund": "Salary",
        "terminal": "InApp",
        "created_from": "Android",
        "delivery_method_id": "account_deposit",
        "merchant_code": "ipay",
        "payment_type": "Wallet",
        "beneficiary": {
            "first_name": "Joyce",
            "last_name": "Doe",
            "mobile_no": "98765465",
            "address_1": "MG",
            "address_2": "SVR",
            "city": "Dhaka",
            "state": "Dhaka",
            "country": "Thailand",
            "zipcode": "987456",
            "id_number": "0001234",
            "id_type": "Passport",
            "relationship": "Friend",
            "bank_details": {
                "account_number": "00012456789",
                "agent_id": "4077",
                "name": "iPay Remit Pvt. Ltd",
                "branch": "",
                "location_id": "10126774"
            }
        },            
        "currency_details": {
        "exchange_rate": 10,
        "receive_amount": 100,
        "receive_country": "Thailand",
        "receive_country_id": "THA",
        "receive_currency": "THB",
        "send_amount": 10,
        "send_country": "Singapore",
        "send_currency": "SGD",
        "service_charge": 52,
        "total_amount": 62
    }        
}

Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/remittance/transfer \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
   "success": true,
    "status_code": 200,
    "message": "Remittance is successful.",
    "data": {
        "order_no": "ORD00120200000449",
        "transaction_no": "TRN00120200000395",
        "points_earned": 1000
    }
}
Remittance All Beneficiary For Agrani
Remittance All Beneficiary For Agrani

This API uses the unique user id to get required all beneficiaries.

The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/user/wallet/remittance/agrani/allbeneficiary
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
  No inputs  
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/remittance/agrani/allbeneficiary \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Beneficiary details retrieved successfully.",
    "data": {
        "beneficiaries": [
        {
            "beneid": "531337",
            "benename": "MD. SHAKHAWAT HOSSAIN TUHIN  (P.P.NO..BB.0717680)",
            "beneaccountno": "ABS-0200009293052 (TK.10000 FOR 10YRS)",
            "branchcode": "111268",
            "trmode": "account_deposit",
            "benecountry": "BD",
            "benetel": "+65 83678345",
            "benebranch": "B.B. ROAD",
            "benebank": "AGRANI BANK LTD.",
            "remamountdest": 0,
            "ratevalue": 0,
            "relationship": "",
            "postal_code": "",
            "city": "",
            "address2": "",
            "address1": "",
            "telephone_code": 880,
            "trmode_name": "Bank AC Transfer"
        }
        ]
    }
}     
Remittance Beneficiary For Agrani
Remittance Beneficiary For Agrani

This API uses the unique user id to get the required payment beneficiary details.

Attributes
  • Url Parameters
    string
  • payment
    stringRequired
    payment type like (account_deposit)
Definition
GET https://test-consumer-api.flexm.com/user/wallet/remittance/agrani/beneficiary/{payment}
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
  No inputs  
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/remittance/agrani/beneficiary/{payment} \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json
'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Beneficiary details retrieved successfully.",
    "data": {
        "beneficiaries": [
            {
                "beneid": "531337",
                "benename": "MD. SHAKHAWAT HOSSAIN TUHIN  (P.P.NO..BB.0717680)",
                "beneaccountno": "ABS-0200009293052 (TK.10000 FOR 10YRS)",
                "branchcode": "111268",
                "trmode": "account_deposit",
                "benecountry": "BD",
                "benetel": "+65 83678345",
                "benebranch": "B.B. ROAD",
                "benebank": "AGRANI BANK LTD.",
                "remamountdest": 0,
                "ratevalue": 0,
                "relationship": "",
                "postal_code": "",
                "city": "",
                "address2": "",
                "address1": "",
                "telephone_code": 880,
                "trmode_name": "Bank AC Transfer"
            }
        ]
    }
}  
Remittance Validate For Agrani
Remittance Validate For Agrani

This API uses the unique user id to check required validate fields.

The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/user/wallet/remittance/agrani/validate
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{           
  No inputs  
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/remittance/agrani/validate \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "No required fields"
}   
Create Remittance For Agrani
Create Remittance For Agrani

This API is used for the create remittance transaction for agrani

The API uses the following attributes:

Attributes
  • purpose
    stringRequired
    Purpose of Remittance
  • source_of_fund
    stringRequired
    Source of Fund
  • terminal
    stringRequired
    Terminal
  • created_from
    stringRequired
    Created From device type
  • delivery_method_id
    stringRequired
    Delivery Method ID information
  • merchant_code
    stringRequired
    Merchant Code information from Get Merchant API
  • payment_type
    stringRequired
    Payment Type from Get Merchant API
  • beneficiary
    object
    Expand attributesClose attributes
    • first_name
      stringRequired
      Beneficiary First Name
    • last_name
      stringRequired
      Beneficiary Last Name
    • mobile_no
      stringRequired
      Beneficiary Mobile Number
    • address_1
      stringRequired
      Beneficiary Address Line 1
    • address_2
      stringRequired
      Beneficiary Address Line 2
    • city
      stringRequired
      Beneficiary City
    • state
      stringRequired
      Beneficiary State
    • country
      stringRequired
      Beneficiary Country
    • zipcode
      stringRequired
      Beneficiary Zipcode
    • id_number
      stringRequired
      Beneficiary ID Number
    • id_type
      stringRequired
      Beneficiary ID Type
    • relationship
      stringRequired
      Sender relationship with beneficiary
    • bank_details
      object
      Only if delivery mode bank
      Expand attributesClose attributes
      • account_number
        stringRequired
        Receiver bank account number information
      • agent_id
        string
        agent ID from Merchant iPay API
      • name
        string
        Name of the Remittance Bank information
      • branch
        string
        Receiver bank branch information
      • location_id
        string
        Location ID from Merchant iPay API
    • currency_details
      string
    • exchange_rate
      stringRequired
      Exchange Rate from Calculate remittance API
    • receive_amount
      stringRequired
      Receiver Amount from Calculate remittance API
    • receive_country
      stringRequired
      Receiver Country information
    • receive_country_id
      stringRequired
      Receiver Country ID information from Get Merchant API
    • receive_currency
      stringRequired
      Receiver Currency information
    • send_amount
      stringRequired
      Sender Amount in form of 2 decimal places
    • send_country
      stringRequired
      Sender Country information
    • send_currency
      stringRequired
      Sender Currency information
    • service_charge
      stringRequired
      Service Charge from Calculate remittance API
    • total_amount
      stringRequired
      Total Amount calculated by sender amount with service charge
Definition
POST https://test-consumer-api.flexm.com/user/wallet/remittance/transfer
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
    {
        "beneficiary": {
            "address_1": "MG",
            "address_2": "SVR",
            "bank_details": {
                "account_number": "0200010106556",
                "agent_id": "",
                "branch": "DASHMINA",
                "location_id": "",
                "name": "AGRANI BANK LTD."
            },
            "city": "Dhaka",
            "country": "Bangladesh",
            "first_name": "SHARMIN",
            "id_number": "547788",
            "id_type": "Passport",
            "last_name": "AKHTER",
            "mobile_no": "065862566",
            "relationship": "friend",
            "state": "Dhaka",
            "zipcode": "987456"
        },
        "card_details": {
            "cvv": "111",
            "exp_month": "03",
            "exp_year": "03",
            "isNewCard": false,
            "number": "6554575467546757"
        },
        "created_from": "Android",
        "currency_details": {
            "exchange_rate": 61.150001525878906,
            "receive_amount": 61.150001525878906,
            "receive_country": "Bangladesh",
            "receive_country_id": "BGD",
            "receive_currency": "BDT",
            "send_amount": 1,
            "send_country": "Singapore",
            "send_currency": "SGD",
            "service_charge": 0,
            "total_amount": 1
        },
        "delivery_method_id": "banks",
        "merchant_code": "agrani",
        "payment_type": "Card",
        "purpose": "Family Support",
        "source_of_fund": "Loan",
        "terminal": "InApp"
    }

Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/remittance/transfer \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Remittance is successful.",
    "data": {
        "order_no": "ORD001202000000595",
        "transaction_no": "TRN001202000000088",
        "points_earned": 10
    }
}
Merchant
User Login
User Login

This API is used to merchant user login.

The API uses the following attributes:

Attributes
  • email
    stringRequired
    Email address of Merchant User for login purpose
  • password
    stringRequired
    Password of Merchant User for login purpose
  • device_signature
    stringRequired
    User Device Signature
Definition
POST https://test-consumer-api.flexm.com/merchant/user/login
Request
Request Headers
Content-Type: application/json
Request Body
{       
    "email":"robertkennedy@flexm.com",
    "password":"12345678",
    "device_signature": "<DEVICE SIGNATURE>"
} 
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/merchant/user/login \
--header 'content-type: application/json'
Response 200
Response Headers
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Merchant User login successfully.",
    "data": {
        "user": {
            "merchant_id": "8pRPVgXGgBnNWAil0MFK",
            "last_name": "Kennedy",
            "password": "123456789",
            "created_by": "dKQTqRd22sSm3fT9o5SG0usnggo1",
            "active": true,
            "email": "robertken@flexm.com",
            "last_login": 1580473755160,
            "timestamp": 1578658234670,
            "user_id": "OqueoEF3VMeOHYnkY7HB11JUrHv2",
            "terminal_id": "36n6Si1Rep2b6m9dsEvB",
            "first_name": "Robert",
            "mobile_no": "57878785",
            "created_date": "2020-01-10T12:10:34Z",
            "location_id": "6x1swf3VNpCnCc7hSjaV",
            "custom_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJodHRwczovL2lkZW50aXR5dG9vbGtpdC5nb29nbGVhcGlzLmNvbS9nb29nbGUuaWRlbnRpdHkuaWRlbnRpdHl0b29sa2l0LnYxLklkZW50aXR5VG9vbGtpdCIsImlhdCI6MTU4MDcyMzY3NCwiZXhwIjoxNTgwNzI3Mjc0LCJpc3MiOiJmaXJlYmFzZS1hZG1pbnNkay04anNhcUB3aGl0ZS1kZXYyLTY5YTM3LmlhbS5nc2VydmljZWFjY291bnQuY29tIiwic3ViIjoiZmlyZWJhc2UtYWRtaW5zZGstOGpzYXFAd2hpdGUtZGV2Mi02OWEzNy5pYW0uZ3NlcnZpY2VhY2NvdW50LmNvbSIsInVpZCI6Ik9xdWVvRUYzVk1lT0hZbmtZN0hCMTFKVXJIdjIifQ.BAYiiLjyUpIFJ8-QwwyB0Fsl5jPJYzGT9UhicaYM1ea1tcYLDoa0sRXr0d_6M9Sq6kF-WFuQ6v4m69ujV_-3Hn8cBpgXHdYJF04nWiqDK2rDZs2eTw38oKVIjFluCBLBwE70R3oLAqYEXgX3hJvDp2wHgvsLO94rRBckJy_q4EuCo9z9ZQya9YHXdSAEbU_6MV43y0WfH03Q53lvsQqjW5JyPu0sQJ5-Kt7JS6AYn3BRaLfWxLPs7eVg6Fr6XL_4EMSnHdZXRb-9TtS1r4raMltloLanKK56MIIQzjBH2x6ufbP9uhkG6JVhFeccvpf3TUHbXVJaSQcBcJhIHLWSiA"
        },
        "qr_code": {
            "qr_location": "6x1swf3VNpCnCc7hSjaV",
            "qr_owner": "8pRPVgXGgBnNWAil0MFK",
            "qr_code": "6x1swf3VNpCnCc7hSjaV",
            "qr_type": "MERCHANT"
        },
        "merchant": {
            "MID": "MCD134",
            "created_date": "2019-12-23T12:45:59Z",
            "is_home_list": true,
            "home_list_order": 9,
            "logo": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/merchant%2F101-logo-product-pic%403x.jpg?alt=media&token=0aa6ab1a-4724-415a-b4b7-58a67b8bf794",
            "code": "FA001",
            "cover_image": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/merchant%2Fgroup%403x.jpg?alt=media&token=fb8ea784-e579-4c13-a508-60f908fddb35",
            "active": true,
            "name": "Robinn",
            "profile_image": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/merchant%2Fgroup-18-copy-12%403x.jpg?alt=media&token=0d99ff24-ac56-4dff-8e56-caff12ad49d6",
            "timestamp": 1577105159284,
            "tags": []
        }
    }
}        
Redeem Voucher
Redeem Voucher

This API is used to redeem the voucher for a particular deal of the merchant based on the unique voucher code.

Attributes
  • voucher_code
    stringRequired
    Voucher Code
Definition
POST https://test-consumer-api.flexm.com/merchant/redeem-voucher
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{       
    "voucher_code":"ADMuyFGp"
} 
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/merchant/redeem-voucher \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Redeemed successful.",
}        
Get Topup Details
Get Topup Details

This API is used to retrieve the merchant information using a mobile number or user id.

The API uses the following attributes:

Attributes
  • topup_mobile_no
    stringRequired
    Topup Mobile Number
  • topup_user_id
    stringRequired
    Topup User ID
Definition
POST https://test-consumer-api.flexm.com/merchant/topup/details
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    "topup_mobile_no":"93667047"  
} OR  
{
    "topup_user_id":"42WMJZ5HEUOb2AXAENxvGOhuUod2"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/merchant/topup/details \
--header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "User details retrieved successfully.",
    "data": {
        "mobile_no": "93667047",
        "display_name": "John Doe",
        "profile_picture": "https://firebasestorage.googleapis.com/v0/b/white-test-f866a.appspot.com/o/profile-images%2F1ir3t3oYbeWGRNWzLce7bPhivPQ2.jpg?alt=media&token=184a4ab6-21b9-4c6e-871e-296e89957c14"
    }
}
Merchant Topup
Merchant Topup

This API is used to load the money to the wallet by using the merchant.

The API uses the following attributes:

Attributes
  • receiver_mobile_no
    stringRequired
    Receiver Mobile Number
  • amount
    numberRequired
    Amount in form of 2 decimal places in form of an double
  • created_from
    stringRequired
    Created From device type
Definition
POST https://test-consumer-api.flexm.com/merchant/topup
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    "amount":100,
    "receiver_mobile_no":"93660618",
    "created_from":"Android"
}        
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/merchant/topup \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Merchant User Topup is successful.",
    "data": {
        "order_no": "ORD00120200003064",
        "transaction_no": "TRN00120200002418",
        "merchant_transaction_no": "TRN00120200000257",
        "receipt_no": "RCT00120200000682"
    }
}  
Bill Payment
Get Bill Pay Countries
Get Bill Pay Countries

This API is used to retrieve the available bill payment countries information.

The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/user/wallet/billpay/countries
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{       
    No inputs     
}         
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/user/wallet/billpay/countries \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Bill payment countries retrieved successfully",
    "data": {
        "bill_pay_countries": [
            {
                "country_name": "Indonesia",
                "country_id": "IDN",
                "currency_code": "IDR",
                "currency_name": "Indonesian rupiah",
                "flag": "https://firebasestorage.googleapis.com/v0/b/white-dev2-69a37.appspot.com/o/remittance%2Fflag-of-Indonesia.png?alt=media&token=fecbc336-76c4-4688-9774-786914c3e275"
            }
        ]
    }
}
Get Products
Get Products

This API is used to retrieve the available bill payment product’s information.

The API uses the following attributes:

Attributes
  • country_id
    stringRequired
    Country 3-letter alpha code from Get Bill Payment Countries Request
Definition
POST https://test-consumer-api.flexm.com/user/wallet/billpay/products
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{       
    "country_id":"IDN"            
}        
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/billpay/products \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Products retrieved successfully.",
    "data": {
    "products": [
            {
                "service_charge": 0,
                "amount": 10000,
                "biller": "Telkomsel",
                "category": "Pulse",
                "code": "PLJSSTK10",
                "description": " ",
                "is_active": false,
                "logo": " ",
                "name": "Telkomsel JSS 10000",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "07qSUVBxLveRClx2pdJG"
            },
            {
                "service_charge": 0,
                "amount": 5000,
                "biller": "Indosat",
                "category": "Pulse",
                "code": "PLIDPT05",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Pulsa Rp 5.000",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "2DEaXB0eUxCPra7dVSep"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "TRANSVISION",
                "category": "Internet and Cable TV",
                "code": "PTTRSV",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Transvision",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "2Fa68Ka1meDXt79SShOy"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "Bima Finance",
                "category": "Installment Payment",
                "code": "PABMF",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Bima Finance",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "2KnNLvBicSnxtrETZZB8"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "Danamon",
                "category": "Credit card",
                "code": "KKDNMN",
                "description": " ",
                "is_active": true,
                "logo": " ",
                "name": "Danamon",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "2yHn8Axlxr5NMr6fWYdE"
            },
            {
                "service_charge": 0,
                "amount": 50000,
                "biller": "Mobile Legends",
                "category": "Game Voucher",
                "code": "DVAF100",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Digital Voucher AlfaMart Rp 100.000",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "4N4Mye05bZUJ0Z1gCGzM"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "Big TV",
                "category": "Internet and Cable TV",
                "code": "TVBIG",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Big Tv",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "5BrI9lD1zHTuElvpOQ3M"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "Telkomsel Halo",
                "category": "Postpaid",
                "code": "PSCHB",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Telkomsel Halo",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "5wBsnVYhJiYsyVgcJVZV"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "CIMB X",
                "category": "Credit card",
                "code": "KKCIMBX",
                "description": " ",
                "is_active": true,
                "logo": " ",
                "name": "CIMB X",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "68EevxWxHL8mqL4HQKn7"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "Panin",
                "category": "Credit card",
                "code": "KKPNN",
                "description": " ",
                "is_active": true,
                "logo": " ",
                "name": "Panin",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "69AKtafzfiJOoJxbu27i"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "Artha Prima Finance",
                "category": "Installment Payment",
                "code": "PAAPF",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Artha Prima Finance",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "7lsBvYpjVFTvxhsEFPyd"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "MyRepublic Retail",
                "category": "Internet and Cable TV",
                "code": "PTMR",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "MyRepublic",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "9jUsaKpuiBMmtZOTz7T3"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "HSBC",
                "category": "Credit card",
                "code": "KKHSBC",
                "description": " ",
                "is_active": true,
                "logo": " ",
                "name": "HSBC",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "A2Zwxe7lwswYpwMkzfMu"
            },
            {
                "service_charge": 0,
                "amount": 215000,
                "biller": "PUBG",
                "category": "Game Voucher",
                "code": "GVPUBG",
                "description": " ",
                "is_active": true,
                "logo": " ",
                "name": "PUBG Steam Key",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "AbFQd0GLqHqXVY5Rvvxu"
            },
            {
                "service_charge": 0,
                "amount": 25003,
                "biller": "Indosat",
                "category": "Pulse",
                "code": "PLID25",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Indosat 25.000",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "EpPU2YqwfCWMOmMwzxMc"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "Indosat GIG",
                "category": "Internet and Cable TV",
                "code": "INGIG",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Indosat GIG",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "FM6X3VkzSxhwsymFbBbD"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "Perusahaan Gas Negara",
                "category": "Gas",
                "code": "PGNFP",
                "description": "",
                "is_active": false,
                "logo": "",
                "name": "Gas Negara",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "GW0vqBwbOl1iUM354x7h"
            },
            {
                "service_charge": 0,
                "amount": 49000,
                "biller": "Joox",
                "category": "Streaming",
                "code": "STJX01",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Joox 1 Bulan",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "IqUgnzHfVXXznNj31iMy"
            },
            {
                "service_charge": 0,
                "amount": 10000,
                "biller": "Top Up (Customer)",
                "category": "Telkom",
                "code": "TPGP10",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "GoPay 10000",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "LpLHe9O0SxFYv9kcNGuK"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "Bank Permata",
                "category": "Credit card",
                "code": "KKPRMT",
                "description": " ",
                "is_active": true,
                "logo": " ",
                "name": "Permata",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "M1FzqWVKuBIFMdOM7tyt"
            },
            {
                "service_charge": 0,
                "amount": 5000,
                "biller": "Telkomsel",
                "category": "Pulse",
                "code": "PLTKPT05",
                "description": "",
                "is_active": false,
                "logo": "",
                "name": "Pulsa Rp. 5.000",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "N8kGTWDqdvglSqp8jZVs"
            },
            {
                "service_charge": 0,
                "amount": 5001,
                "biller": "Indosat",
                "category": "Pulse",
                "code": "PLID05",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Indosat 5.000",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "O4jHIEKBsezEhSOnFDiC"
            },
            {
                "service_charge": 2500,
                "amount": 0,
                "biller": "Kota Sungai Penuh",
                "category": "PDAM",
                "code": "PMSP",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "PDAM Test",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "PIg3gyfCsdRH7onirO2x"
            },
            {
                "service_charge": 1500,
                "amount": 0,
                "biller": "BPJS Kesehatan",
                "category": "BPJS",
                "code": "BPJSKES",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "BPJS Kesahatan",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "SOF97Xoq27uPk7DzbF76"
            },
            {
                "service_charge": 0,
                "amount": 50000,
                "biller": "PUBG",
                "category": "Game Voucher",
                "code": "GVSM12",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Steam Rp45.000",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "SdoB0VOJBRWtUwnKGdSE"
            },
            {
                "service_charge": 0,
                "amount": 3000,
                "biller": "Mobile Legends",
                "category": "Game Voucher",
                "code": "GVCDML11",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "10 Diamonds",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "SkzaA3trUFD3BRYnAeYR"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "Home credit",
                "category": "Installment Payment",
                "code": "MFHC",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Home Credit",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "T5NbfwPZ2KRZOFs90a5l"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "UOB",
                "category": "Credit card",
                "code": "KKUOB",
                "description": " ",
                "is_active": true,
                "logo": " ",
                "name": "UOB",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "Tsa4E8nIGjwcrgqlGJLl"
            },
            {
                "service_charge": 0,
                "amount": 20000,
                "biller": "PLN Prepaid",
                "category": "Electricity",
                "code": "LSTK20",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Token 20.000",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "UknJSSr2qvSYVv3AoOo2"
            },
            {
                "service_charge": 0,
                "amount": 500000,
                "biller": "PLN Prepaid",
                "category": "Electricity",
                "code": "LSTK500",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Token 500.000",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "VJfMC8bAAZ83YgOcxUrx"
            },
            {
                "service_charge": 0,
                "amount": 215000,
                "biller": "PUBG",
                "category": "Game Voucher",
                "code": "PODPUBG_002",
                "description": " ",
                "is_active": true,
                "logo": " ",
                "name": "PUBG Steam Key",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "VuGvogMZJT3WzEiuHPOQ"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "CIMB Card Visa",
                "category": "Credit card",
                "code": "KKCIMBV",
                "description": " ",
                "is_active": true,
                "logo": " ",
                "name": "CIMB Visa Card",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "Xkeq512NwX5sRyWbUhF6"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "Smart Finance",
                "category": "Installment Payment",
                "code": "PASF",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Smart Finance",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "YwzYu3eaMgOAiXLknBzK"
            },
            {
                "service_charge": 0,
                "amount": 60000,
                "biller": "VIU",
                "category": "Streaming",
                "code": "STVU60",
                "description": " ",
                "is_active": true,
                "logo": "",
                "name": "VIU 3 Bulan Premium",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "a05HbrMs72RBQLAtDaAl"
            },
            {
                "service_charge": 0,
                "amount": 11000,
                "biller": "Telkomsel",
                "category": "Data Package",
                "code": "PDTK11",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Paket Data Internet 40mb",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "aKzfLgL5Rr4ooVK7vm0z"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "MNC",
                "category": "Credit card",
                "code": "KKMNC",
                "description": " ",
                "is_active": true,
                "logo": " ",
                "name": "MNC",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "aRla1d33teFXUcQZgjWT"
            },
            {
                "service_charge": 0,
                "amount": 11000,
                "biller": "Telkomsel",
                "category": "Pulse",
                "code": "PLTK11",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Pulsa Telkomsel 10.000",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "aT5XAne26Qmqccoq7IZl"
            },
            {
                "service_charge": 0,
                "amount": 44500,
                "biller": "Mobile Legends Diamonds",
                "category": "Game Voucher",
                "code": "GVUPTMLD170",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "170 Diamonds",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "bvfeSft9R8MAR9pKuyHG"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "K Vision",
                "category": "Internet and Cable TV",
                "code": "TVKV",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "K Vision",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "cBOwTTd4XedGy7efeo3b"
            },
            {
                "service_charge": 0,
                "amount": 100000,
                "biller": "Voucher Alfamart",
                "category": "eMoney",
                "code": "DVAFM100",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Digital Voucher Alfa Mart Rp 100.000",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "cgGMSyt5YjEm2YwWIVgT"
            },
            {
                "service_charge": 0,
                "amount": 50000,
                "biller": "Mobile Legends Diamonds",
                "category": "Game Voucher",
                "code": "GVUPTMLD",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Mobile Legend 185 Diamonds",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "eGSYMfY7yizdN8VOWuO5"
            },
            {
                "service_charge": 0,
                "amount": 19300,
                "biller": "PUBG Lite (UPGC)\t",
                "category": "Game Voucher",
                "code": "GVPUBGL50",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "50 L-coins",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "f6bn4DM2s93JhJjWqLZW"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "BFI Finance",
                "category": "Installment Payment",
                "code": "MFBFIRS",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "BFI Finance",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "gkPUos62M3tIV5mTZ5Cs"
            },
            {
                "service_charge": 0,
                "amount": 9700,
                "biller": "PUBG Lite (UPGC)\t",
                "category": "Game Voucher",
                "code": "GVPUBGL28",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "28 L-coins",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "hRgotXBioK2vhAXScfrQ"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "TOPAS TV",
                "category": "Internet and Cable TV",
                "code": "TVTOP",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Topas Tv",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "iSX5J3bwNyvyLjLLjlXQ"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "QNB Kesawan",
                "category": "Credit card",
                "code": "KKQNB",
                "description": " ",
                "is_active": true,
                "logo": " ",
                "name": "QNB Kesawan",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "iV1fgyBg2P4AB9AEnlQS"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "Nexmedia",
                "category": "Internet and Cable TV",
                "code": "TVNEX",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "NexMedia",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "j7vJhHHpnc97YKQEgt7T"
            },
            {
                "service_charge": 0,
                "amount": 10000,
                "biller": "Telkomsel",
                "category": "Pulse",
                "code": "PLTK10",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Pulsa telkomsel 10000",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "jIKSrV7opefQOOb8s3YM"
            },
            {
                "service_charge": 0,
                "amount": 5000,
                "biller": "XL",
                "category": "Pulse",
                "code": "PLXLPT05",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "Pulsa Rp 5.000",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "jfmVl8lGI7UpWVNrF3EB"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "Bukopin",
                "category": "Credit card",
                "code": "KKBKPN",
                "description": " ",
                "is_active": true,
                "logo": " ",
                "name": "Bukopin",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "kC0KE2l8vOY4OgZzYQQh"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "CIMB Card JCB",
                "category": "Credit card",
                "code": "KKCIMBJ",
                "description": " ",
                "is_active": true,
                "logo": " ",
                "name": "CIMB JCB Card",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "oDM6Dp3sUmFBZApqGhFa"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "IPMI Business School",
                "category": "Education",
                "code": "SEUNKIN",
                "description": "",
                "is_active": true,
                "logo": "",
                "name": "IPMI Business School",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "rn644hH7urZhQxQnqYoD"
            },
            {
                "service_charge": 0,
                "amount": 0,
                "biller": "PLN Postpaid",
                "category": "Electricity",
                "code": "LSPPJL",
                "description": "",
                "is_active": false,
                "logo": "",
                "name": "Tagihan Listrik",
                "partner": "ayopop",
                "type": "postpaid",
                "id": "u5TWYxXE2WokyLRIecK5"
            },
            {
                "service_charge": 0,
                "amount": 39000,
                "biller": "Voucher Alfamart",
                "category": "eMoney",
                "code": "STIF39",
                "description": " ",
                "is_active": true,
                "logo": "",
                "name": "iFlix 1 Bulan",
                "partner": "ayopop",
                "type": "prepaid",
                "id": "v2MdUsoJRsZyclgyirPS"
            }
            ]
        }
}
Inquiry Bill Pay
Inquiry Bill Pay

This API is used to inquiry the bill payment details.

The API uses the following attributes:

Attributes
  • account_number
    stringRequired
    Product account number information
  • product_code
    stringRequired
    Product code from Get Bill Payment product Request
  • country_id
    stringRequired
    Country 3-letter alpha code from Get Bill Payment Countries Request
Definition
POST https://test-consumer-api.flexm.com/user/wallet/billpay/inquiry
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{       
    "account_number": "081339372389",
    "product_code": "PLTK11",
    "country_id":"IDN"  
}         
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/billpay/inquiry \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Inquiry is successful",
    "data": {
        "inquiry_id": 26976,
        "account_number": "081339372389",
        "customer_name": "",
        "product_name": "Telkomsel Rp 11.000....",
        "product_code": "PLTK11",
        "category": "Pulsa",
        "amount": 11000,
        "amount_in_sg": "1.08",
        "service_charge": 0,
        "validity": "",
        "customer_detail": [],
        "bill_details": [],
        "product_details": [],
        "extra_fields": []
    }
}    
Confirm Bill Pay
Confirm Bill Pay

This API is used to process confirm the bill payment.

The API uses the following attributes:

Attributes
  • inquiry_id
    numberRequired
    Inquiry ID from Get Bill Payment product Request
  • account_number
    stringRequired
    Product account number information
  • product_code
    stringRequired
    Product code from Get Bill Payment product Request
  • amount
    numberRequired
    Amount in the form of 2 decimal places
  • created_from
    stringRequired
    Created From device type
  • description
    stringRequired
    Description of the product
  • payment_type
    stringRequired
    Type of Payment used to pay the bill
  • terminal
    stringOptional
    Terminal like (InApp/BackOffice)
  • country_id
    stringOptional
    Country 3-letter alpha code from Get Bill Payment Countries Request
Definition
POST https://test-consumer-api.flexm.com/user/wallet/billpay/confirm
Request
Request Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{       
    "inquiry_id": 26976,
    "account_number": "081339372389",
    "product_code": "PLTK11",
    "amount": 11000,
    "created_from":"Android",
    "description":"Bill payment of Pulsa Telkomsel",
    "payment_type":"Wallet",
    "terminal":"InApp",
    "country_id":"IDN" 
}         
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/user/wallet/billpay/confirm \ --header 'authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ' \
--header 'content-type: application/json'
Response 200
Response Headers
authorization: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Bill payment has been sent successfully.",
    "data": {
        "receipt_no": "RCT00120200000920",
        "transaction_no": "TRN00120200000968",
        "order_no": "ORD00120200000937",
        "points_earned": 54
    }
}          
Wallet Payment
User Generate OTP
User Generate OTP

This API request would generate and send the 6-digit one-time password (OTP) to the user’s mobile number. The generated OTP is valid for 1 hour.

The API uses the following attributes:

Attributes
  • mobile
    stringRequired
    User Mobile Number
  • country_code
    stringRequired
    Country 3-letter alpha code
Definition
POST https://test-consumer-api.flexm.com/wallet/user/send-otp
Request
Request Headers
Content-Type: application/json
Request Body
{           
    "mobile":"89405680",
    "country_code":"65"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/wallet/user/send-otp \
--header 'content-type: application/json'
Response 200
Response Headers
Content-Type: application/json
Response Body
{                
    "success": true,
    "status_code": 200,
    "message": "OTP sent successfully."       
}
User Verify OTP
User Verify OTP

This API is used to verify the OTP that was sent to the user mobile. On sending the valid OTP the response will have data with custom token and if the user already exists the user details will be sent along with the custom token.

Verify OTP API has the following attributes:

Attributes
  • mobile
    stringRequired
    User Mobile Number
  • otp
    stringRequired
    One Time Password sent to user mobile
Definition
POST https://test-consumer-api.flexm.com/wallet/user/verify-otp
Request
Request Headers
Content-Type: application/json
Request Body
{
    "mobile":"89405680",
    "otp":"123456"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/wallet/user/verify-otp \
--header 'content-type: application/json'
Response 200
Response Headers
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "OTP verified successfully",
    "data": {
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiN2h1U1ZxVWhoRWVWYXRjRE85eFNxUmF2dGdYMiIsImlhdCI6MTU4NDUzOTQ3MX0.IslvfqgD5JKNK7uZX3E-pnNn3fcTvPRzKUDlL_w51V8"
    }
}
Get User Wallet Balance
Get User Wallet Balance

This API uses the unique custom token to retrieve the user wallet balance information.

The API has no Attributes

Definition
GET https://test-consumer-api.flexm.com/wallet/user/balance
Request
Request Headers
x-token: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{
    No inputs
}
Example Request
curl --request GET \
--url https://test-consumer-api.flexm.com/wallet/user/balance \
--header 'content-type: application/json' \
--header 'x-token: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ'
Response 200
Response Headers
x-token: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "User Wallet balance retrieved successfully.",
    "data": {
        "balance": 150940.00
    }
}
Debit Wallet
Debit Wallet Debit

This API uses to debit the user wallet amount.

This API has the following attributes:

Attributes
  • amount
    numberRequired
    Amount in form of 2 decimal places to be funds transfer from user wallet
  • debit_purpose
    stringRequired
    Purpose of transaction
  • MID
    stringRequired
    Merchant ID
  • TID
    stringRequired
    Terminal ID
Definition
POST https://test-consumer-api.flexm.com/wallet/user/debit
Request
Request Headers
x-token: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Request Body
{                
    "amount":10,
    "debit_purpose":"purpose of transaction",
    "MID":"M00000001",
    "TID":"T000000001"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/wallet/user/debit \
--header 'content-type: application/json' \
--header 'x-token: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ'
Response 200
Response Headers
x-token: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU1YTkxZDlmMzlmYTRkZTI1NGExZTg5ZGYwMGYwNWI3ZTI0OGI5ODUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vd2hpdGUtZGV2Mi02OWEzNyIsImF1ZCI6IndoaXRlLWRldjItNjlhMzciLCJhdXRoX3RpbWUiOjE1Nzk3NjQ2NTcsInVzZXJfaWQiOiI0MldNSlo1SEVVT2IyQVhBRU54dkdPaHVVb2QyIiwic3ViIjoiNDJXTUpaNUhFVU9iMkFYQUVOeHZHT2h1VW9kMiIsImlhdCI6MTU3OTc2NDY2NiwiZXhwIjoxNTc5NzY4MjY2LCJwaG9uZV9udW1iZXIiOiIrNjU5MzY2NzA0NyIsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsicGhvbmUiOlsiKzY1OTM2NjcwNDciXX0sInNpZ25faW5fcHJvdmlkZXIiOiJwaG9uZSJ9fQ.kJOB7wyIxw1p0pCkIyTsZ2uS4BQvk_fgRrHLkex61i9CtvQVxlKnRHdqJHAnnUP_8DbZT0O4L1WJK-uivWBs8_tO3TxwCwZxGyjbPiU6YLAROJfjfC0HZSOdcPneuJO7eeZmeQAmvbiRxC0pkO87GQ1JV6uQ8OKuN5qNm3a80kdfC52jv17JFLnycXwLUhii6qqo6jqngWRzYCCKeEuF_DH2QHtFxXw_wnIiMpTe3FXILwzERn5MhOeTKEclZj-6lRnpnd1eprW9jeCVgFXFk4MQOfzrXR88Al6HTc9o_Na39R7bZzRdEwzgk-MzDPrfF9T8tjIJsAi3ThGIJoZGYQ
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Wallet amount debited transaction successfully.",
    "data": {
        "balance": 150930.00,
        "transaction_no": "TRN00120190000447"
    }
}    
Agent Topup APIs
Agent Balance
Agent Balance

This API is used to provide Agent’s prefund or settlement balance.

To authenticate the request content, there will be a signature in the request header. Its value is MD5 sum of the concatenation of JSON message in the request content and Secret key (to be assigned during deployment)

The API has the following attributes:

Attributes
  • agent_id
    stringRequired
    Identifier of the Agent
Definition
POST https://test-consumer-api.flexm.com/agent/balance
Request
Request Headers
X-API-KEY: XXXX-XXXX-XXXXX
signature: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ( 32-digit char like 57277788a406b654296bc017d7d3590b)
Content-Type: application/json
Request Body
{
    "agent_id": "ylZ0cEzLEt4Vc3q2ioKm"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/agent/balance \ --header 'content-type: application/json' \
--header 'signature: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ( 32-digit char like 57277788a406b654296bc017d7d3590b)' \
--header 'x-api-key: XXXX-XXXX-XXXXX'
Response 200
Response Headers
X-API-KEY: XXXX-XXXX-XXXXX
signature: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ( 32-digit char like 57277788a406b654296bc017d7d3590b)
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Agent Balance retrieved successfully",
    "data": {
        "balance": 9980,
        "type": "prefund"
    }
}
Validate Topup
Validate Topup

This API is used to validate the user and the user’s wallet before the topup is performed.

To authenticate the request content, there will be a signature in the request header. Its value is MD5 sum of the concatenation of JSON message in the request content and Secret key (to be assigned during deployment)

The API has the following attributes:

Attributes
  • account_no
    stringRequired
    Account number of the wallet user
  • amount
    numberRequired
    Topup amount for the wallet user
Definition
POST https://test-consumer-api.flexm.com/agent/topup/validate
Request
Request Headers
X-API-KEY: XXXX-XXXX-XXXXX
signature: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ( 32-digit char like 57277788a406b654296bc017d7d3590b)
Content-Type: application/json
Request Body
{
    "account_no": "0101000303",
    "amount":5
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/agent/topup/validate \
--header 'content-type: application/json' \
--header 'signature: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ( 32-digit char like 57277788a406b654296bc017d7d3590b)' \
--header 'x-api-key: XXXX-XXXX-XXXXX'
Response 200
Response Headers
X-API-KEY: XXXX-XXXX-XXXXX
signature: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ( 32-digit char like 57277788a406b654296bc017d7d3590b)
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "Successfully validated account"
}
Agent Topup
Agent Topup

This API is used to confirm payment of a transaction with account and amount previously validated.

To authenticate the request content, there will be a signature in the request header. Its value is MD5 sum of the concatenation of JSON message in the request content and Secret key (to be assigned during deployment)

The API has the following attributes:

Attributes
  • account_no
    stringRequired
    Account number of the wallet user
  • amount
    numberRequired
    Topup amount for the wallet user
  • agent_id
    stringRequired
    Identifier of the Agent
  • agent_reference_id
    stringRequired
    Unique Agent's Reference Document number
  • agent_store_code
    stringRequired
    Agent Store code
Definition
POST https://test-consumer-api.flexm.com/agent/topup
Request
Request Headers
X-API-KEY: XXXX-XXXX-XXXXX
signature: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ( 32-digit char like 57277788a406b654296bc017d7d3590b)
Content-Type: application/json
Request Body
{
    "amount": 15,
    "agent_id": "ylZ0cEzLEt4Vc3q2ioKm",
    "account_no": "0301000218",
    "agent_store_code": "003",
    "agent_reference_id": "772114"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/agent/topup \ --header 'content-type: application/json' \
--header 'signature: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ( 32-digit char like 57277788a406b654296bc017d7d3590b)' \
--header 'x-api-key: XXXX-XXXX-XXXXX'
Response 200
Response Headers
X-API-KEY: XXXX-XXXX-XXXXX
signature: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ( 32-digit char like 57277788a406b654296bc017d7d3590b)
Content-Type: application/json
Response Body
{
    "success": true,
    "status_code": 200,
    "message": "success",
    "data": {
        "transaction_no": "TRN031202000001705"
    }
}
}
Get Reconciliation
Get Reconciliation

This API is used to retrieve list of successful transaction.

To authenticate the request content, there will be a signature in the request header. Its value is MD5 sum of the concatenation of JSON message in the request content and Secret key (to be assigned during deployment)

The API has the following attributes:

Attributes
  • start_date
    stringRequired
    Start date to fetch the transaction details.
  • end_date
    stringRequired
    End date to fetch the transaction details
  • agent_id
    stringRequired
    Identifier of the Agent
Definition
POST https://test-consumer-api.flexm.com/agent/topup/getReconciliation
Request
Request Headers
X-API-KEY: XXXX-XXXX-XXXXX
signature: e407e8a66c76bc99c9ff3d0fc35ab2c3
Content-Type: application/json
Request Body
{
    "start_date": "2020/12/06",
    "end_date": "2020/12/07",
    "agent_id": "ylZ0cEzLEt4Vc3q2ioKm"
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/agent/topup/getReconciliation \
--header 'content-type: application/json' \
--header 'signature: e407e8a66c76bc99c9ff3d0fc35ab2c3' \
--header 'x-api-key: XXXX-XXXX-XXXXX'
Response 200
Response Headers
X-API-KEY: XXXX-XXXX-XXXXX
signature: e407e8a66c76bc99c9ff3d0fc35ab2c3
Content-Type: application/json
Response Body
{
"success": true,
"status_code": 200,
"message": "Transactions retrieved successfully",
"data": [
{
    "transaction_date": "2020-12-07T13:58:43Z",
    "transaction_amount": 5,
    "transaction_no": "TRN031202000001704",
    "agent_store_code": "003",
    "agent_reference_id": "772113",
    "user_account_no": "0301000218"
},
{
    "transaction_date": "2020-12-07T13:59:16Z",
    "transaction_amount": 15,
    "transaction_no": "TRN031202000001705",
    "agent_store_code": "003",
    "agent_reference_id": "772114",
    "user_account_no": "0301000218"
}
]
}
Push Reconciliation
Push Reconciliation

This API is used to retrieve list of successful transaction.

To authenticate the request content, there will be a signature in the request header. Its value is MD5 sum of the concatenation of JSON message in the request content and Secret key (to be assigned during deployment)

The API has the following attributes:

Attributes
  • start_date
    stringRequired
    Start date to fetch the transaction details.
  • end_date
    stringRequired
    End date to fetch the transaction details
  • agent_id
    stringRequired
    Identifier of the Agent
  • data
    arrayRequired
    Array of successful transactions
Definition
POST https://test-consumer-api.flexm.com/agent/topup/getReconciliation
Request
Request Headers
X-API-KEY: XXXX-XXXX-XXXXX
signature: e407e8a66c76bc99c9ff3d0fc35ab2c3
Content-Type: application/json
Request Body
{
    "start_date": "2020/12/06",
    "end_date": "2020/12/07",
    "agent_id": "ylZ0cEzLEt4Vc3q2ioKm",
    "data": [
        {
            "transaction_date": "2020-12-07T13:58:43Z",
            "transaction_amount": 5,
            "transaction_no": "TRN031202000001704",
            "agent_store_code": "003",
            "agent_reference_id": "772113",
            "user_account_no": "0301000218"
        },
        {
            "transaction_date": "2020-12-07T13:59:16Z",
            "transaction_amount": 15,
            "transaction_no": "TRN031202000001705",
            "agent_store_code": "003",
            "agent_reference_id": "772114",
            "user_account_no": "0301000218"
        }
    ]
}
Example Request
curl --request POST \
--url https://test-consumer-api.flexm.com/agent/topup/getReconciliation \
--header 'content-type: application/json' \
--header 'signature: e407e8a66c76bc99c9ff3d0fc35ab2c3' \
--header 'x-api-key: XXXX-XXXX-XXXXX'
Response 200
Response Headers
X-API-KEY: XXXX-XXXX-XXXXX
signature: e407e8a66c76bc99c9ff3d0fc35ab2c3
Content-Type: application/json
Response Body
{
"success": true,
"status_code": 200,
"message": "Transactions stored successfully"
}