Wallet Transaction¶

Credit user wallet balance and list wallet recharge transaction history.

Authentication

All methods require a valid Platform API key in the x-yappes-key header.

Base URL

Substitute the sample host https://platformapi.enterprise-xyz.com with the Platform API URL configured for your Yappes organization, since the host value changes depending on the organization and deployment setup.

REST Resources¶

Resource	Methods
mint.organizations.transactions.users	list
organizations.users.balance	credit

Resource: mint.organizations.transactions.users¶

Wallet recharge transaction history for a user.

Platform API — Wallet Transaction Tracking¶

Lists a user's wallet recharge transactions.

HTTP request¶

GET https://platformapi.enterprise-xyz.com/v1/mint/organizations/{orgReferenceId}/transactions/users/{userReference}

Path parameters¶

Parameter	Type	Description
`orgReferenceId`	string	Required. Organization reference.
`userReference`	string	Required. User reference (`userId`, email, or username).

Query parameters¶

Parameter	Type	Description
`productId`	string	Optional. Reported back as `apiProduct` on each transaction.
`utctime`	string	Optional. Lower bound for `submittedDateTime`.
`utctime2`	string	Optional. Upper bound for `submittedDateTime`.
`limit`	integer	Optional. Maximum results. Default `100`, maximum `1000`.

Request body¶

The request body must be empty.

Response body¶

If successful, the response body contains a list of transactions:

{
  "transaction": [
    {
      "id": "TXN-123",
      "transactionTime": "2026-06-04 10:15:00",
      "userEmail": "info@yappes.com",
      "apiProduct": "",
      "applicationName": "",
      "proxyName": "",
      "requestCount": 1,
      "chargeAmount": {
        "currencyCode": "INR",
        "units": "150",
        "nanos": 0
      },
      "status": "SUCCESS"
    }
  ]
}

Authorization¶

Requires a valid x-yappes-key header.

Resource: organizations.users.balance¶

User wallet balance operations.

Platform API — Add Wallet Balance¶

Credits a user's wallet balance.

HTTP request¶

POST https://platformapi.enterprise-xyz.com/v1/organizations/{orgReferenceId}/users/{userEmail}/balance:credit

Path parameters¶

Parameter	Type	Description
`orgReferenceId`	string	Required. Organization reference (id, reference name, or organization name).
`userEmail`	string	Required. User reference (email, `userId`, or username).

Query parameters¶

None.

Request body¶

{
  "transactionAmount": {
    "currencyCode": "USD",
    "units": "50",
    "nanos": 0
  }
}

Field	Type	Required	Description
`transactionAmount`	object	Yes	Amount to credit.

Response body¶

If successful (200), the response body is:

{
  "wallets": [
    {
      "balance": {
        "currencyCode": "USD",
        "units": "50",
        "nanos": 0
      },
      "lastCreditTime": "1717424600000"
    }
  ]
}

Field	Description
`wallets[].balance.units`	Updated balance after credit.
`wallets[].balance.currencyCode`	Echoed from the request `transactionAmount.currencyCode` (default `USD`).
`wallets[].lastCreditTime`	Credit timestamp as epoch milliseconds.

Errors¶

HTTP status	Condition
`400`	Missing `transactionAmount` or invalid path parameters.
`404`	Organization or user not found.
`502`	Service unreachable or returned an error.
Other	Non-2xx responses may be returned with the original status and body.

Authorization¶

Requires a valid x-yappes-key header.

Method index¶

#	HTTP	Path
1	GET	`/v1/mint/organizations/{orgReferenceId}/transactions/users/{userReference}`
2	POST	`/v1/organizations/{orgReferenceId}/users/{userEmail}/balance:credit`