List residual fees
List all fees associated with a residual.
To access this endpoint using an access token
you'll need to specify the /accounts/{accountID}/profile.read scope.
GET
/accounts/{accountID}/residuals/{residualID}/fees
curl -X GET "https://api.moov.io/accounts/{accountID}/residuals/{residualID}/fees" \
-H "Authorization: Bearer {token}" \
mc, _ := moov.NewClient()
var accountID string
var residualID string
mc.ListResidualFees(ctx, accountID, residualID)
import { Moov } from "@moovio/sdk";
const moov = new Moov({
xMoovVersion: "v2024.01.00",
security: {
username: "",
password: "",
},
});
async function run() {
const result = await moov.feePlans.listResidualFees({
skip: 60,
count: 20,
accountID: "6b95293f-c3e7-42b5-98b7-fd9cc8d49685",
residualID: "8ecb1a63-25e0-41e7-a9c7-bb8a1cf63d1c",
});
console.log(result);
}
run();declare(strict_types=1);
require 'vendor/autoload.php';
use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;
use Moov\MoovPhp\Models\Operations;
$sdk = MoovPhp\Moov::builder()
->setXMoovVersion('v2024.01.00')
->setSecurity(
new Components\Security(
username: '',
password: '',
)
)
->build();
$request = new Operations\ListResidualFeesRequest(
skip: 60,
count: 20,
accountID: '6b95293f-c3e7-42b5-98b7-fd9cc8d49685',
residualID: '8ecb1a63-25e0-41e7-a9c7-bb8a1cf63d1c',
);
$response = $sdk->feePlans->listResidualFees(
request: $request
);
if ($response->incurredFees !== null) {
// handle response
}package hello.world;
import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.ListResidualFeesRequest;
import io.moov.sdk.models.operations.ListResidualFeesResponse;
import java.lang.Exception;
public class Application {
public static void main(String[] args) throws Exception {
Moov sdk = Moov.builder()
.xMoovVersion("v2024.01.00")
.security(Security.builder()
.username("")
.password("")
.build())
.build();
ListResidualFeesRequest req = ListResidualFeesRequest.builder()
.accountID("6b95293f-c3e7-42b5-98b7-fd9cc8d49685")
.residualID("8ecb1a63-25e0-41e7-a9c7-bb8a1cf63d1c")
.skip(60L)
.count(20L)
.build();
ListResidualFeesResponse res = sdk.feePlans().listResidualFees()
.request(req)
.call();
if (res.incurredFees().isPresent()) {
// handle response
}
}
}from moovio_sdk import Moov
from moovio_sdk.models import components
with Moov(
x_moov_version="v2024.01.00",
security=components.Security(
username="",
password="",
),
) as moov:
res = moov.fee_plans.list_residual_fees(account_id="6b95293f-c3e7-42b5-98b7-fd9cc8d49685", residual_id="8ecb1a63-25e0-41e7-a9c7-bb8a1cf63d1c", skip=60, count=20)
# Handle response
print(res)require 'moov_ruby'
Models = ::Moov::Models
s = ::Moov::Client.new(
x_moov_version: 'v2024.01.00'
)
req = Models::Operations::ListResidualFeesRequest.new(
skip: 60,
count: 20,
account_id: '6b95293f-c3e7-42b5-98b7-fd9cc8d49685',
residual_id: '8ecb1a63-25e0-41e7-a9c7-bb8a1cf63d1c'
)
res = s.fee_plans.list_residual_fees(request: req)
unless res.incurred_fees.nil?
# handle response
endusing Moov.Sdk;
using Moov.Sdk.Models.Requests;
var sdk = new MoovClient(xMoovVersion: "<value>");
ListResidualFeesRequest req = new ListResidualFeesRequest() {
Skip = 60,
Count = 20,
AccountID = "6b95293f-c3e7-42b5-98b7-fd9cc8d49685",
ResidualID = "8ecb1a63-25e0-41e7-a9c7-bb8a1cf63d1c",
};
var res = await sdk.FeePlans.ListResidualFeesAsync(req);
// handle responseThe request completed successfully.
[
{
"feeID": "string",
"accountID": "string",
"walletID": "string",
"createdOn": "2019-08-24T14:15:22Z",
"feeName": "string",
"amount": {
"currency": "USD",
"valueDecimal": "12.987654321"
},
"generatedBy": {
"transferID": "string",
"cardID": "string",
"disputeID": "string",
"accountID": "string",
"bankAccountID": "string",
"invoiceID": "string"
},
"feeGroup": "string",
"residualID": "string"
}
]Response headers
x-request-id
string
required
A unique identifier used to trace requests.
The request contained missing or expired authentication.
Response headers
x-request-id
string
required
A unique identifier used to trace requests.
The user is not authorized to make the request.
Response headers
x-request-id
string
required
A unique identifier used to trace requests.
Request was refused due to rate limiting.
Response headers
x-request-id
string
required
A unique identifier used to trace requests.
The request failed due to an unexpected error.
Response headers
x-request-id
string
required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.
Response headers
x-request-id
string
required
A unique identifier used to trace requests.
Headers
X-Moov-Version
string
Specify an API version.
API versioning follows the format vYYYY.QQ.BB, where
YYYYis the yearQQis the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)BBis the build number, starting at.01, for subsequent builds in the same quarter.- For example,
v2024.01.00is the initial release of the first quarter of 2024.
- For example,
The dev version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
When no version is specified, the API defaults to v2024.01.00.
Path parameters
accountID
string
required
residualID
string
required
Unique identifier for this residual payment calculation.
Query parameters
skip
integer
<int64>
count
integer
<int64>
Default:
200startDateTime
string
<RFC-3339>
Optional date-time to inclusively filter all fees created after this date-time.
endDateTime
string
<RFC-3339>
Optional date-time to exclusively filter all fees created before this date-time.
Response
accountID
string
Account ID the fee belongs to.
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).
amount
object
The fee amount.
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>
Timestamp when the fee was created.
feeGroup
string
Describes the source of the fee, such as a Moov-set processing fee, a network pass-through fee, or an interchange or discount fee.
feeID
string
<=36 characters
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).
feeName
string
Name of the fee.
generatedBy
object
Object indicating what generated the fee (TransferID, CardID, DisputeID, AccountID, or BankAccountID).
The entity that generated the fee.
Show child attributes
accountID
string
<=36 characters
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).
bankAccountID
string
<=36 characters
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).
cardID
string
<=36 characters
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).
disputeID
string
<=36 characters
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).
invoiceID
string
<=36 characters
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).
transferID
string
<=36 characters
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).
residualID
string
Unique identifier for this residual payment calculation.
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).
walletID
string
Wallet ID associated with the fee.
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).