User Wallet Balance

Enabling user wallet balance

This endpoint fetches the user's wallet balance

Must be authorized to call these APIs

Gets user wallet balance

GET https://example.com/wp-json/rimplenet/v1/user-wallet-balance

Request Body

Name
Type
Description

wallet_id*

String

This is the wallet id you are retrieving the balance for.

user_id*

int

This is the user id you are retrieving the balance for

{
  
    "status_code": 200,
    "status": true,
    "message": "Wallet Balance retrieved",
    "data": {
        "ngn": 1000
    }
}
}

To view request params, click on the arrow (>) at the right-hand side of the endpoint URL to expand or collapse

{
  
    "status_code": 200,
    "status": true,
    "message": "Wallet Balance retrieved",
    "data": {
        "ngn": 1000
    }
}
}

Returning wallet balance

GET https://example.com/wp-json/rimplenet/v1/user-wallet-balance?wallet_id=usd&user_id=1

Request Body

Name
Type
Description

wallet_id*

String

This is the wallet id you are retrieving the balance for.

user_id

int

This is the user id you are retrieving the balance for.

{
    "status_code": 200,
    "status": true,
    "message": "Wallet Balance retrieved",
    "data": {
        "ngn": 10000,
        "usd": 0
    }
}
{
    "status_code": 200,
    "status": true,
    "message": "Wallet Balance retrieved",
    "data": {
        "ngn": 10000,
        "usd": 0
    }
}

Returning formatted wallet balance

GET https://example.com/wp-json/rimplenet/v1/user-wallet-balance?wallet_id=ngn,usd&formatted=yes

Request Body

Name
Type
Description

wallet_id*

String

This is the wallet id you are retrieving the balance for.(required)

user_id

int

This is the user id you are retrieving the balance for.

{
    "status_code": 200,
    "status": true,
    "message": "Wallet Balance retrieved",
    "data": {
        "ngn": 10000,
        "formatted": {
            "ngn": "N10,000.00",
            "usd": "$0"
        },
        "usd": 0
    }
}
{
    "status_code": 200,
    "status": true,
    "message": "Wallet Balance retrieved",
    "data": {
        "ngn": 10000,
        "formatted": {
            "ngn": "N10,000.00",
            "usd": "$0"
        },
        "usd": 0
    }
}

Last updated