Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Dashboard Use cases API Changelog
  1. API reference
  2. Moov accounts
  3. Fee plans

List fees for an account

List fees associated with an account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/transfers.read scope.

POST
/accounts/{accountID}/fees/.fetch
Java PHP Python TypeScript 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.ListFeesFetchResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        ListFeesFetchResponse res = sdk.feePlans().listFeesFetch()
                .accountID("7b85e951-a6d9-4e67-a155-4d18e9d1ac58")
                .call();

        if (res.incurredFees().isPresent()) {
            // handle response
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$listFeesFetchRequest = new Components\ListFeesFetchRequest();

$response = $sdk->feePlans->fetchFees(
    accountID: 'abb6dc0f-1b14-4754-8489-20b0216c093f',
    xMoovVersion: 'v2024.01.00',
    listFeesFetchRequest: $listFeesFetchRequest

);

if ($response->incurredFees !== null) {
    // handle response
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.fee_plans.list_fees_fetch(account_id="7b85e951-a6d9-4e67-a155-4d18e9d1ac58")

    # Handle response
    print(res)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

import { Moov } from "@moovio/sdk";

const moov = new Moov({
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.feePlans.listFeesFetch({
    accountID: "7b85e951-a6d9-4e67-a155-4d18e9d1ac58",
  });

  // Handle the result
  console.log(result);
}

run();
200 401 403 429 500 504
The request completed successfully.
schema
{
  "items": {
    "description": "A fee incurred by a user.",
    "properties": {
      "accountID": {
        "format": "uuid",
        "type": "string"
      },
      "amount": {
        "properties": {
          "currency": {
            "description": "A 3-letter ISO 4217 currency code.",
            "example": "USD",
            "pattern": "^[A-Za-z]{3}$",
            "type": "string"
          },
          "valueDecimal": {
            "description": "A decimal-formatted numerical string that represents up to 9 decimal place precision. \n\nFor example, $12.987654321 is '12.987654321'.",
            "example": "12.987654321",
            "pattern": "^\\d+\\.\\d{1,9}$",
            "type": "string"
          }
        },
        "required": [
          "currency",
          "valueDecimal"
        ],
        "type": "object"
      },
      "createdOn": {
        "format": "date-time",
        "type": "string"
      },
      "feeID": {
        "format": "uuid",
        "type": "string"
      },
      "feeName": {
        "type": "string"
      },
      "generatedBy": {
        "description": "The entity that generated the fee.",
        "oneOf": [
          {
            "properties": {
              "transferID": {
                "format": "uuid",
                "type": "string"
              }
            },
            "title": "Transfer ID",
            "type": "object"
          },
          {
            "properties": {
              "CardID": {
                "format": "uuid",
                "type": "string"
              }
            },
            "title": "Card ID",
            "type": "object"
          },
          {
            "properties": {
              "DisputeID": {
                "format": "uuid",
                "type": "string"
              }
            },
            "title": "Dispute ID",
            "type": "object"
          },
          {
            "properties": {
              "AccountID": {
                "format": "uuid",
                "type": "string"
              }
            },
            "title": "Account ID",
            "type": "object"
          },
          {
            "properties": {
              "BankAccountID": {
                "format": "uuid",
                "type": "string"
              }
            },
            "title": "Bank account ID",
            "type": "object"
          }
        ]
      },
      "walletID": {
        "format": "uuid",
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The user is not authorized to make the request.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

x-moov-version

string
API version

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Default: v2024.01.00

Path parameters

accountID

string <uuid> required

Body

application/json
Array of fee IDs to fetch.

feeIDs

array

Response

application/json

accountID

string<uuid>

amount

object
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

valueDecimal

string required Pattern

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is '12.987654321'.

createdOn

string<date-time>

feeID

string<uuid>

feeName

string

generatedBy

The entity that generated the fee.
Show child attributes
Transfer ID Card ID Dispute ID Account ID Bank account ID

transferID

string<uuid>

CardID

string<uuid>

DisputeID

string<uuid>

AccountID

string<uuid>

BankAccountID

string<uuid>

walletID

string<uuid>