Get the calling application's wallet

curl --request GET \
  --url https://idaas.yourflexpay.com/api/v1/wallet \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "message": "<string>",
  "errorCode": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "applicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "applicationName": "<string>",
    "currency": "<string>",
    "balance": 123,
    "totalDebited": 123,
    "totalCredited": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "errors": [
    "<string>"
  ],
  "timestamp": "2023-11-07T05:31:56Z"
}

Wallet

Get the calling application's wallet

Returns the current escrow wallet for the authenticated application including:

balance – net position (credits − debits for all completed transactions)
totalDebited – running sum of all outgoing accepted payments
totalCredited – running sum of all incoming accepted payments

The wallet is auto-provisioned on the first transaction so calling this endpoint before any transaction is initiated will return a 404 until the wallet exists. Call POST /v1/wallet to provision it eagerly.

GET

wallet

Get the calling application's wallet

curl --request GET \
  --url https://idaas.yourflexpay.com/api/v1/wallet \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "message": "<string>",
  "errorCode": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "applicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "applicationName": "<string>",
    "currency": "<string>",
    "balance": 123,
    "totalDebited": 123,
    "totalCredited": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "errors": [
    "<string>"
  ],
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Obtain a token from POST /v1/auth/token using your client_id and client_secret, then enter Bearer <token> here.

Response

Wallet returned

success

boolean

message

string

errorCode

string

data

object

Show child attributes

errors

string[]

timestamp

string<date-time>

Provision the calling application's wallet