Dev Resources

Developer API for Digital Wallet

You’ll find all the UPay wallet API here...

Developer API

API Guide
Introduction
API Guide

Developer API

POST Customer Login

https://usr.upay.ma/v1/api/customer/login

Customer Login


HEADERS

secret_key $2y$10$zwy2wsGyguW1rxEvVTwFu.ptkKQCI.DOrB3gpGWDxymBGdwOoF9j2
auth_token $2y$10$DN7l4uwTbm1GEXbHYlvwsOcTrYdq6futX3cRkuhpDEPesuhIsCqhe

API Responses

Language

cURL

Example Request

Customer Login 
curl --location --request POST "https://usr.upay.ma/v1/api/customer/login"
    --header "secret_key: $2y$10$zwy2wsGyguW1rxEvVTwFu.ptkKQCI.DOrB3gpGWDxymBGdwOoF9j2"
    --header "auth_token: $2y$10$DN7l4uwTbm1GEXbHYlvwsOcTrYdq6futX3cRkuhpDEPesuhIsCqhe"

Example Response

200 － OK 
    
    {
        "message": "Login Success",
        "data": {
            "auth_token": "$2y$10$9W8lY2xg0CvxWDJFptjGk.XcbQtxQ.-ZjZzwCLQqv2tnrWH1elejK",
            "redirect_url": "https://www.exampleredirecturi.com/"
        }
    }

GET User Detail

https://usr.upay.ma/v1/api/user-details

Getting customer details


HEADERS

secret_key $2y$10$zwy2wsGyguW1rxEvVTwFu.ptkKQCI.DOrB3gpGWDxymBGdwOoF9j2
auth_token $2y$10$DN7l4uwTbm1GEXbHYlvwsOcTrYdq6futX3cRkuhpDEPesuhIsCqhe

Example Request

User Detail 
curl --location --request POST "https://usr.upay.ma/v1/api/customer/login"
    --header "secret_key: $2y$10$zwy2wsGyguW1rxEvVTwFu.ptkKQCI.DOrB3gpGWDxymBGdwOoF9j2"
    --header "auth_token: $2y$10$DN7l4uwTbm1GEXbHYlvwsOcTrYdq6futX3cRkuhpDEPesuhIsCqhe"

Example Response

200 － OK 
    
    {
        "message": "User details are",
        "data": {
            "customer_name": "Gold M",
            "customer_email": "gold@gmail.com",
            "customer_phone_number": "8124443152",
            "customer_currency": "USD",
            "customer_currency_symbol": "$",
            "customer_wallet": 450.19,
            "customer_coins": 0,
        }
    }

POST Balance Validate

https://trans.upay.ma/v1/api/user/balance-validate

This is used to check before process transaction. purpose is to check customer wallet balance for process transaction


HEADERS

secret_key $2y$10$zwy2wsGyguW1rxEvVTwFu.ptkKQCI.DOrB3gpGWDxymBGdwOoF9j2
auth_token $2y$10$DN7l4uwTbm1GEXbHYlvwsOcTrYdq6futX3cRkuhpDEPesuhIsCqhe

BODY

amount 10.00
currency USD
TODO :: get real values

POST Generate QR

https://trans.upay.ma/v1/api/generate-qr

This is used to check before process transaction. purpose is to check customer wallet balance for process transaction


HEADERS

secret_key $2y$10$zwy2wsGyguW1rxEvVTwFu.ptkKQCI.DOrB3gpGWDxymBGdwOoF9j2
auth_token $2y$10$DN7l4uwTbm1GEXbHYlvwsOcTrYdq6futX3cRkuhpDEPesuhIsCqhe

BODY

amount 10.00
currency USD
TODO :: get real values

POST Payment Capture

https://trans.upay.ma/v1/api/capture-payment

This is an more secure api to proceed tranaction which is called after balance check


HEADERS

secret_key $2y$10$zwy2wsGyguW1rxEvVTwFu.ptkKQCI.DOrB3gpGWDxymBGdwOoF9j2
auth_token $2y$10$DN7l4uwTbm1GEXbHYlvwsOcTrYdq6futX3cRkuhpDEPesuhIsCqhe

BODY

amount 12.35
currency USD
receipt ORDTEST123453
TODO :: get real values

GET Transaction List

https://trans.upay.ma/v1/api/customer/transaction-list

This will list all the customer done by the transaction to specific merchant


HEADERS

secret_key $2y$10$zwy2wsGyguW1rxEvVTwFu.ptkKQCI.DOrB3gpGWDxymBGdwOoF9j2
auth_token $2y$10$DN7l4uwTbm1GEXbHYlvwsOcTrYdq6futX3cRkuhpDEPesuhIsCqhe
TODO :: get real values

GET Transaction Detail

https://trans.upay.ma/v1/api/transaction-detail/PATXN1000321

Get transaction details


HEADERS

secret_key $2y$10$zwy2wsGyguW1rxEvVTwFu.ptkKQCI.DOrB3gpGWDxymBGdwOoF9j2
auth_token $2y$10$DN7l4uwTbm1GEXbHYlvwsOcTrYdq6futX3cRkuhpDEPesuhIsCqhe
TODO :: get real values

DEL User Logout

https://usr.upay.ma/v1/api/user-details

Getting customer details


HEADERS

secret_key $2y$10$zwy2wsGyguW1rxEvVTwFu.ptkKQCI.DOrB3gpGWDxymBGdwOoF9j2
auth_token $2y$10$DN7l4uwTbm1GEXbHYlvwsOcTrYdq6futX3cRkuhpDEPesuhIsCqhe
TODO :: get real values