Wallet Transactions

Retrieve your wallet transactions

GET

https://partner-api.monta.com

/api/v1/wallet-transactions

Required scope: wallet-transactions:read
Organization authorization: supported

Retrieve your wallet transactions › query Parameters

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

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

Default: 10

operatorId

integer | null · int32

Filter to retrieve transactions for a given operator.
*Note:*The operatorId must be in the consumer’s operatorIds or, if empty, belong to the organization’s sub-operators.
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

teamId

integer | null · int32

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

Example: 1

fromDate

string | null · date-time · pattern: ^(\d{4}-\d{2}-\d{2}T…

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

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

toDate

string | null · date-time · pattern: ^(\d{4}-\d{2}-\d{2}T…

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

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

referenceId

string | null

Filter to retrieve transactions by the matching referenceId

Example: 1

referenceType

string | null · enum

Filter to retrieve transactions by the matching referenceType

Enum values:

TEAM

COMPANY_REFERRAL

USER_REFERRAL

ORDER

SUBSCRIPTION_PURCHASE

CHARGE

BANK_ACCOUNT

WALLET_BANK_ACCOUNT

Example: CHARGE

state

string | null · enum

Filter to retrieve transactions by the matching state

Enum values:

complete

pending

failed

reserved

other

Example: complete

group

string | null · enum

Filter to retrieve transactions by the matching group

Enum values:

deposit

withdraw

charge

other

Example: deposit

partnerExternalId

string | null

**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

Retrieve your wallet transactions › Responses

List of wallet transactions that match the criteria

OffsetBasedResponse_72

WalletTransaction[] · required

MontaPage.Meta · required

GET/api/v1/wallet-transactions

curl https://partner-api.monta.com/api/v1/wallet-transactions \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1,
      "fromAmount": 13.77,
      "fromSubAmount": 11.02,
      "fromVatAmount": 2.75,
      "fromCurrency": {
        "identifier": "dkk",
        "name": "Danish krone",
        "decimals": 2
      },
      "fromType": "team",
      "from": "team",
      "fromWalletId": 1,
      "toAmount": 13.77,
      "toSubAmount": 11.02,
      "toVatAmount": 2.75,
      "toCurrency": {
        "identifier": "dkk",
        "name": "Danish krone",
        "decimals": 2
      },
      "toType": "operator",
      "to": "team",
      "toWalletId": 2,
      "exchangeRate": 1,
      "createdAt": "2022-04-22T09:47:05Z",
      "updatedAt": "2022-04-22T09:47:05Z",
      "completedAt": "2022-04-22T09:47:05Z",
      "referenceId": "referenceId",
      "referenceType": "CHARGE",
      "group": "withdraw",
      "kind": "charge-sponsored",
      "vatPercentage": 25,
      "state": "complete",
      "note": "Test transaction.",
      "partnerExternalId": "ACME-12345",
      "partnerCustomPayload": {},
      "metadata": {
        "id": 1,
        "kwh": 13.77,
        "type": "tax-refund-metadata",
        "chargeId": 0
      }
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Retrieve wallet transactions for an invoice

GET

https://partner-api.monta.com

/api/v1/wallet-transactions/invoices/{invoiceId}

Required scope: wallet-transactions:read
Organization authorization: supported

Retrieve wallet transactions for an invoice › path Parameters

invoiceId

integer · int64 · required

Retrieve wallet transactions for an invoice › query Parameters

Pageable · required

teamId

integer | null · int64

Retrieve wallet transactions for an invoice › Responses

Transactions by invoice successfully retrieved

OffsetBasedResponse_72

WalletTransaction[] · required

MontaPage.Meta · required

GET/api/v1/wallet-transactions/invoices/{invoiceId}

curl 'https://partner-api.monta.com/api/v1/wallet-transactions/invoices/:invoiceId?pageable=<value>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1,
      "fromAmount": 13.77,
      "fromSubAmount": 11.02,
      "fromVatAmount": 2.75,
      "fromCurrency": {
        "identifier": "dkk",
        "name": "Danish krone",
        "decimals": 2
      },
      "fromType": "team",
      "from": "team",
      "fromWalletId": 1,
      "toAmount": 13.77,
      "toSubAmount": 11.02,
      "toVatAmount": 2.75,
      "toCurrency": {
        "identifier": "dkk",
        "name": "Danish krone",
        "decimals": 2
      },
      "toType": "operator",
      "to": "team",
      "toWalletId": 2,
      "exchangeRate": 1,
      "createdAt": "2022-04-22T09:47:05Z",
      "updatedAt": "2022-04-22T09:47:05Z",
      "completedAt": "2022-04-22T09:47:05Z",
      "referenceId": "referenceId",
      "referenceType": "CHARGE",
      "group": "withdraw",
      "kind": "charge-sponsored",
      "vatPercentage": 25,
      "state": "complete",
      "note": "Test transaction.",
      "partnerExternalId": "ACME-12345",
      "partnerCustomPayload": {},
      "metadata": {
        "id": 1,
        "kwh": 13.77,
        "type": "tax-refund-metadata",
        "chargeId": 0
      }
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Post an operator adjustment transaction

POST

https://partner-api.monta.com

/api/v1/wallet-transactions/operator-adjustment-transaction

Operator creates an adjustment transaction. Required scope: wallet-transaction:write

Post an operator adjustment transaction › Request Body

OperatorAdjustmentTransaction

fromWalletId

integer · int64 · required

Id of the wallet to transfer from

Example: 1

toWalletId

integer · int64 · required

Id of the wallet to transfer to

Example: 2

note

string | null

Note for the transaction

Example: Adjustment for user 12345

currencyId

integer · int64

Currency identifier

Example: null

amount

number · double

Amount to transfer

Example: 13.77

Post an operator adjustment transaction › Responses

Operator adjustment transaction created

WalletTransaction

object · required

Currency for fromAmount.

object · required

Currency used for toAmount.

createdAt

string · date-time · required

Creation date of transaction

Example: 2022-04-22T09:47:05Z

group

string · enum · required

Transaction group of this transaction

Enum values:

deposit

withdraw

charge

other

Example: withdraw

kind

string · required

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

Example: charge-sponsored

state

string · enum · required

Transaction state of this transaction

Enum values:

complete

pending

failed

reserved

other

Example: complete

id

integer · int64

Id of the transaction

Example: 1

fromAmount

number · double

Amount sent, incl. VAT

Example: 13.77

fromSubAmount

number · double

Amount sent, excl. VAT

Example: 11.02

fromVatAmount

number · double

VAT amount sent

Example: 2.75

fromType

string | null

Type of sender: operator, team

Example: team

object

Type of sender: operator, team

Example: team

fromWalletId

integer | null · int64

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

Example: 1

toAmount

number · double

Amount received, incl. VAT

Example: 13.77

toSubAmount

number · double

Amount received, excl. VAT

Example: 11.02

toVatAmount

number · double

VAT amount received

Example: 2.75

toType

string | null

Type of receiver: operator, team

Example: operator

object

Type of sender: operator, team

Example: team

toWalletId

integer | null · int64

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

Example: 2

exchangeRate

number · double

Exchange rate used for currency conversion

Example: 1

updatedAt

string | null · date-time

Update date of transaction

Example: 2022-04-22T09:47:05Z

completedAt

string | null · date-time

Completion date of transaction

Example: 2022-04-22T09:47:05Z

referenceId

string | null

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

Example: referenceId

referenceType

string · enum

Reference type of this transaction.

Enum values:

TEAM

COMPANY_REFERRAL

USER_REFERRAL

ORDER

SUBSCRIPTION_PURCHASE

CHARGE

BANK_ACCOUNT

WALLET_BANK_ACCOUNT

Example: CHARGE

vatPercentage

number · double

VAT percentage included in this transaction.

Example: 25

note

string | null

A note that has been entered for this transaction.

Example: Test transaction.

object

Additional information for this transaction

POST/api/v1/wallet-transactions/operator-adjustment-transaction

curl https://partner-api.monta.com/api/v1/wallet-transactions/operator-adjustment-transaction \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "fromWalletId": 1,
  "toWalletId": 2,
  "note": "Adjustment for user 12345",
  "currencyId": null,
  "amount": 13.77,
  "partnerExternalId": "ACME-12345",
  "partnerCustomPayload": {}
}'

Example Request Body

{
  "fromWalletId": 1,
  "toWalletId": 2,
  "note": "Adjustment for user 12345",
  "currencyId": null,
  "amount": 13.77,
  "partnerExternalId": "ACME-12345",
  "partnerCustomPayload": {}
}

json

Example Responses

{
  "id": 1,
  "fromAmount": 13.77,
  "fromSubAmount": 11.02,
  "fromVatAmount": 2.75,
  "fromCurrency": {
    "identifier": "dkk",
    "name": "Danish krone",
    "decimals": 2
  },
  "fromType": "team",
  "from": "team",
  "fromWalletId": 1,
  "toAmount": 13.77,
  "toSubAmount": 11.02,
  "toVatAmount": 2.75,
  "toCurrency": {
    "identifier": "dkk",
    "name": "Danish krone",
    "decimals": 2
  },
  "toType": "operator",
  "to": "team",
  "toWalletId": 2,
  "exchangeRate": 1,
  "createdAt": "2022-04-22T09:47:05Z",
  "updatedAt": "2022-04-22T09:47:05Z",
  "completedAt": "2022-04-22T09:47:05Z",
  "referenceId": "referenceId",
  "referenceType": "CHARGE",
  "group": "withdraw",
  "kind": "charge-sponsored",
  "vatPercentage": 25,
  "state": "complete",
  "note": "Test transaction.",
  "partnerExternalId": "ACME-12345",
  "partnerCustomPayload": {},
  "metadata": {
    "id": 1,
    "kwh": 13.77,
    "type": "tax-refund-metadata",
    "chargeId": 0
  }
}

json

application/json

Retrieve a single wallet transaction

GET

https://partner-api.monta.com

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

Required scope: wallet-transactions:read
Organization authorization: supported

Retrieve a single wallet transaction › path Parameters

transactionId

integer · int64 · required

Retrieve a single wallet transaction › Responses

Wallet transaction with provided id

WalletTransaction

object · required

Currency for fromAmount.

object · required

Currency used for toAmount.

createdAt

string · date-time · required

Creation date of transaction

Example: 2022-04-22T09:47:05Z

group

string · enum · required

Transaction group of this transaction

Enum values:

deposit

withdraw

charge

other

Example: withdraw

kind

string · required

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

Example: charge-sponsored

state

string · enum · required

Transaction state of this transaction

Enum values:

complete

pending

failed

reserved

other

Example: complete

id

integer · int64

Id of the transaction

Example: 1

fromAmount

number · double

Amount sent, incl. VAT

Example: 13.77

fromSubAmount

number · double

Amount sent, excl. VAT

Example: 11.02

fromVatAmount

number · double

VAT amount sent

Example: 2.75

fromType

string | null

Type of sender: operator, team

Example: team

object

Type of sender: operator, team

Example: team

fromWalletId

integer | null · int64

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

Example: 1

toAmount

number · double

Amount received, incl. VAT

Example: 13.77

toSubAmount

number · double

Amount received, excl. VAT

Example: 11.02

toVatAmount

number · double

VAT amount received

Example: 2.75

toType

string | null

Type of receiver: operator, team

Example: operator

object

Type of sender: operator, team

Example: team

toWalletId

integer | null · int64

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

Example: 2

exchangeRate

number · double

Exchange rate used for currency conversion

Example: 1

updatedAt

string | null · date-time

Update date of transaction

Example: 2022-04-22T09:47:05Z

completedAt

string | null · date-time

Completion date of transaction

Example: 2022-04-22T09:47:05Z

referenceId

string | null

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

Example: referenceId

referenceType

string · enum

Reference type of this transaction.

Enum values:

TEAM

COMPANY_REFERRAL

USER_REFERRAL

ORDER

SUBSCRIPTION_PURCHASE

CHARGE

BANK_ACCOUNT

WALLET_BANK_ACCOUNT

Example: CHARGE

vatPercentage

number · double

VAT percentage included in this transaction.

Example: 25

note

string | null

A note that has been entered for this transaction.

Example: Test transaction.

object

Additional information for this transaction

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

curl https://partner-api.monta.com/api/v1/wallet-transactions/:transactionId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": 1,
  "fromAmount": 13.77,
  "fromSubAmount": 11.02,
  "fromVatAmount": 2.75,
  "fromCurrency": {
    "identifier": "dkk",
    "name": "Danish krone",
    "decimals": 2
  },
  "fromType": "team",
  "from": "team",
  "fromWalletId": 1,
  "toAmount": 13.77,
  "toSubAmount": 11.02,
  "toVatAmount": 2.75,
  "toCurrency": {
    "identifier": "dkk",
    "name": "Danish krone",
    "decimals": 2
  },
  "toType": "operator",
  "to": "team",
  "toWalletId": 2,
  "exchangeRate": 1,
  "createdAt": "2022-04-22T09:47:05Z",
  "updatedAt": "2022-04-22T09:47:05Z",
  "completedAt": "2022-04-22T09:47:05Z",
  "referenceId": "referenceId",
  "referenceType": "CHARGE",
  "group": "withdraw",
  "kind": "charge-sponsored",
  "vatPercentage": 25,
  "state": "complete",
  "note": "Test transaction.",
  "partnerExternalId": "ACME-12345",
  "partnerCustomPayload": {},
  "metadata": {
    "id": 1,
    "kwh": 13.77,
    "type": "tax-refund-metadata",
    "chargeId": 0
  }
}

json

application/json

deprecated

Patch an existing transaction

PATCH

https://partner-api.monta.com

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

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

Patch an existing transaction › path Parameters

transactionId

integer · int64 · required

Patch an existing transaction › Request Body

PatchWalletTransaction

partnerExternalId

string | null

External Id of this entity, managed by you.

Example: ACME-12345

object | null

Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.

Example: {"internalId":"ACME-12345","department":"Fleet"}

Patch an existing transaction › Responses

Transaction updated

WalletTransaction

object · required

Currency for fromAmount.

object · required

Currency used for toAmount.

createdAt

string · date-time · required

Creation date of transaction

Example: 2022-04-22T09:47:05Z

group

string · enum · required

Transaction group of this transaction

Enum values:

deposit

withdraw

charge

other

Example: withdraw

kind

string · required

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

Example: charge-sponsored

state

string · enum · required

Transaction state of this transaction

Enum values:

complete

pending

failed

reserved

other

Example: complete

id

integer · int64

Id of the transaction

Example: 1

fromAmount

number · double

Amount sent, incl. VAT

Example: 13.77

fromSubAmount

number · double

Amount sent, excl. VAT

Example: 11.02

fromVatAmount

number · double

VAT amount sent

Example: 2.75

fromType

string | null

Type of sender: operator, team

Example: team

object

Type of sender: operator, team

Example: team

fromWalletId

integer | null · int64

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

Example: 1

toAmount

number · double

Amount received, incl. VAT

Example: 13.77

toSubAmount

number · double

Amount received, excl. VAT

Example: 11.02

toVatAmount

number · double

VAT amount received

Example: 2.75

toType

string | null

Type of receiver: operator, team

Example: operator

object

Type of sender: operator, team

Example: team

toWalletId

integer | null · int64

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

Example: 2

exchangeRate

number · double

Exchange rate used for currency conversion

Example: 1

updatedAt

string | null · date-time

Update date of transaction

Example: 2022-04-22T09:47:05Z

completedAt

string | null · date-time

Completion date of transaction

Example: 2022-04-22T09:47:05Z

referenceId

string | null

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

Example: referenceId

referenceType

string · enum

Reference type of this transaction.

Enum values:

TEAM

COMPANY_REFERRAL

USER_REFERRAL

ORDER

SUBSCRIPTION_PURCHASE

CHARGE

BANK_ACCOUNT

WALLET_BANK_ACCOUNT

Example: CHARGE

vatPercentage

number · double

VAT percentage included in this transaction.

Example: 25

note

string | null

A note that has been entered for this transaction.

Example: Test transaction.

object

Additional information for this transaction

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

curl https://partner-api.monta.com/api/v1/wallet-transactions/:transactionId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "partnerExternalId": "ACME-12345",
  "partnerCustomPayload": {
    "internalId": "ACME-12345",
    "department": "Fleet"
  }
}'

Example Request Body

{
  "partnerExternalId": "ACME-12345",
  "partnerCustomPayload": {
    "internalId": "ACME-12345",
    "department": "Fleet"
  }
}

json

Example Responses

{
  "id": 1,
  "fromAmount": 13.77,
  "fromSubAmount": 11.02,
  "fromVatAmount": 2.75,
  "fromCurrency": {
    "identifier": "dkk",
    "name": "Danish krone",
    "decimals": 2
  },
  "fromType": "team",
  "from": "team",
  "fromWalletId": 1,
  "toAmount": 13.77,
  "toSubAmount": 11.02,
  "toVatAmount": 2.75,
  "toCurrency": {
    "identifier": "dkk",
    "name": "Danish krone",
    "decimals": 2
  },
  "toType": "operator",
  "to": "team",
  "toWalletId": 2,
  "exchangeRate": 1,
  "createdAt": "2022-04-22T09:47:05Z",
  "updatedAt": "2022-04-22T09:47:05Z",
  "completedAt": "2022-04-22T09:47:05Z",
  "referenceId": "referenceId",
  "referenceType": "CHARGE",
  "group": "withdraw",
  "kind": "charge-sponsored",
  "vatPercentage": 25,
  "state": "complete",
  "note": "Test transaction.",
  "partnerExternalId": "ACME-12345",
  "partnerCustomPayload": {},
  "metadata": {
    "id": 1,
    "kwh": 13.77,
    "type": "tax-refund-metadata",
    "chargeId": 0
  }
}

json

application/json

Vehicles Wallets