Skip to content

Query Wallet

Retrieve wallet account information through wallet account id. The response includes wallet balance, wallet status, country code, currency, and group id.

HTTP Request

GET /v1/accounts/wallet/{wallet_id}

Request Headers
{    
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "Your assigned api key"
}

Response

Content-Type: application/json
{
    "id": "cde5843c-bbd0-46d2-9fbb-27b08f3ad021",
    "balanceInCents": 0,
    "status":"ACTIVE",
    "groupId": "0001",
    "country": "CO",
    "currency": "COP"
}

HTTP Headers Details

Key Value
Content-Type application/json
Authorization Bearer {{access_token}}
x-api-key Your assigned api key

PATH Parameters

Parameter Required Type Description
wallet_id String Wallet account id in UUID format

Response Body Details

Parameter Type Description
id String Wallet account id in UUID represented in String format.
balanceInCents Int Wallet account balance amount as in cents.
status String Wallet account status, Enum: "ACTIVE".
groupId String Group id/name that wallet holder belongs to.
country String Wallet account country in country code.
currency String Wallet account settlement currency in currency code
Back to top