Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Wallet Transactions

Retrieve your wallet transactions

Required scope: wallet-transactions:read </br>Organization authorization: supported

get/api/v1/wallet-transactions

Query parameters

pageinteger

page number to retrieve (starts with 0)

perPageinteger

number of items per page (between 1 and 100, default 10)

operatorIdinteger nullable

Filter to retrieve transactions for a given operator.</br>*Note:*The operatorId must be in the consumer’s operatorIds or, if empty, belong to the organization’s sub-operators.</br>Note: When not provided the default operator will be used for the given consumer, if the default operator cannot be assigned the request will be rejected

Example:1
teamIdinteger nullable

Filter to retrieve transactions for a given team.</br>Note: When not provided the transactions for the operator will be returned instead

Example:1
fromDatestring date-time nullable

Filter to retrieve transactions where createdAt >= fromDate (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

Example:2022-05-22T09:30:03Z
toDatestring date-time nullable

Filter to retrieve transactions where createdAt <= toDate (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

Example:2022-05-22T09:30:03Z
referenceIdstring nullable

Filter to retrieve transactions by the matching referenceId

Example:1
referenceType'TEAM' | 'COMPANY_REFERRAL' | 'USER_REFERRAL' | 'ORDER' | 'SUBSCRIPTION_PURCHASE' | 'CHARGE' | 'BANK_ACCOUNT' | 'WALLET_BANK_ACCOUNT' | 'STRIPE_CHARGE' | 'SUBSCRIPTION' | 'TRANSACTION' | 'PROMO_CODE_USE' | 'TEAM_MEMBER_FEE_PURCHASE' | 'WALLET' | 'PAYTER_PAYMENT_SESSION' | 'ADYEN_PAYMENT' | 'POWER_BANK_PAYOUT' | 'SPLIT_BILLING_SETTLEMENT' | 'OTHER' nullable

Filter to retrieve transactions by the matching referenceType

Example:CHARGE
state'complete' | 'pending' | 'failed' | 'reserved' | 'other' nullable

Filter to retrieve transactions by the matching state

Example:complete
group'deposit' | 'withdraw' | 'charge' | 'other' nullable

Filter to retrieve transactions by the matching group

Example:deposit
partnerExternalIdstring nullable

**Note: This has been deprecated and won't do anything moving forward.**Filter transactions by partnerExternalId, to filter only resources without partnerExternalId use partnerExternalId=""

Example:1

Response

List of wallet transactions that match the criteria

Example response

{
  "data": [
    {
      "id": 1,
      "fromAmount": 13.77,
      "fromSubAmount": 11.02,
      "fromVatAmount": 2.75,
      "fromCurrency": {
        "identifier": "dkk",
        "name": "Danish krone",
        "decimals": 2
      },
      "fromType": "team",
      "from": {
        "id": 14,
        "name": "Monta",
        "identifier": "monta",
        "partnerId": 1,
        "vatNumber": "FOO-123-ABC"
      },
      "fromWalletId": 1,
      "toAmount": 13.77,
      "toSubAmount": 11.02,
      "toVatAmount": 2.75,
      "toCurrency": {
        "identifier": "dkk",
        "name": "Danish krone",
        "decimals": 2
      },
      "toType": "operator",
      "to": {
        "id": 14,
        "name": "Monta",
        "identifier": "monta",
        "partnerId": 1,
        "vatNumber": "FOO-123-ABC"
      },
      "toWalletId": 2,
      "exchangeRate": 1,
      "createdAt": "2022-04-22T09:47:05Z",
      "updatedAt": "2022-04-22T09:47:05Z",
      "completedAt": "2022-04-22T09:47:05Z",
      "referenceId": "referenceId",
      "group": "withdraw",
      "kind": "charge-sponsored",
      "vatPercentage": 25,
      "state": "complete",
      "note": "Test transaction.",
      "partnerExternalId": "ACME-12345",
      "metadata": {
        "id": 1,
        "kwh": 13.77
      }
    }
  ]
}