Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Wallet Transactions

Patch an existing transaction

Note: This has been deprecated and won't do anything. Required scope: transaction:write

patch/api/v1/wallet-transactions/{transactionId}

Path parameters

transactionIdinteger required

Request body

partnerExternalIdstring nullable

External Id of this entity, managed by you.

partnerCustomPayloadobject[] nullable

Custom JSON payload for this entity, managed by you.

Example request

{
  "partnerExternalId": "ACME-12345"
}

Response

Transaction updated

idinteger

Id of the transaction

fromAmountnumber double

Amount sent, incl. VAT

fromSubAmountnumber double

Amount sent, excl. VAT

fromVatAmountnumber double

VAT amount sent

fromTypestring nullable

Type of sender: operator, team

fromWalletIdinteger nullable

Id of the wallet where the amount was sent from. Can be null if the transaction did not originate from a wallet.

toAmountnumber double

Amount received, incl. VAT

toSubAmountnumber double

Amount received, excl. VAT

toVatAmountnumber double

VAT amount received

toTypestring nullable

Type of receiver: operator, team

toWalletIdinteger nullable

Id of the wallet where the amount was sent to. Can be null if the transaction did not target a wallet.

exchangeRatenumber double

Exchange rate used for currency conversion

createdAtstring date-time required

Creation date of transaction

updatedAtstring date-time nullable

Update date of transaction

completedAtstring date-time nullable

Completion date of transaction

referenceIdstring nullable

Reference id of this transaction. e.g the charge id

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'
group'deposit' | 'withdraw' | 'charge' | 'other' required

Transaction group of this transaction

kindstring required

Kind of this transaction, ie 'charge-sponsored'.<br/>Note: This is an open field and therefore more kinds will be added moving forward.

vatPercentagenumber double

VAT percentage included in this transaction.

state'complete' | 'pending' | 'failed' | 'reserved' | 'other' required

Transaction state of this transaction

notestring nullable

A note that has been entered for this transaction.

partnerExternalIdstring nullable

**Note: This has been deprecated and will be null always.**External Id of this entity, managed by you.

partnerCustomPayloadobject[] nullable

**Note: This has been deprecated and will be null always.**Custom JSON payload for this entity, managed by you.

Example response

{
  "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
  }
}