Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Use cases API Changelog
  1. API reference
  2. Latest (beta)
  3. Moov accounts
  4. Billing

List merchant statements

Retrieve all statements associated with an account.

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

GET
/accounts/{accountID}/statements
cURL Java TypeScript Python PHP Ruby 
1
2

curl -X GET "https://api.moov.io/accounts/{accountID}/statements" \
  -H "Authorization: Bearer {token}" \

 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
29
30
31
32
33
34
35
36

package hello.world;

import java.lang.Exception;
import org.openapis.openapi.Moov;
import org.openapis.openapi.models.components.Security;
import org.openapis.openapi.models.errors.GenericError;
import org.openapis.openapi.models.operations.ListStatementsRequest;
import org.openapis.openapi.models.operations.ListStatementsResponse;

public class Application {

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

        Moov sdk = Moov.builder()
                .xMoovVersion("<value>")
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        ListStatementsRequest req = ListStatementsRequest.builder()
                .accountID("b63ef5ea-db36-47f1-a72e-1a5eb1c43c0f")
                .skip(60L)
                .count(20L)
                .build();

        ListStatementsResponse res = sdk.statements().list()
                .request(req)
                .call();

        if (res.statements().isPresent()) {
            // handle response
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

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

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

async function run() {
  const result = await moov.statements.list({
    skip: 60,
    count: 20,
    accountID: "b63ef5ea-db36-47f1-a72e-1a5eb1c43c0f",
  });

  console.log(result);
}

run();
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

from moovio_sdk import Moov
from moovio_sdk.models import components


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

    res = moov.statements.list(account_id="b63ef5ea-db36-47f1-a72e-1a5eb1c43c0f", skip=60, count=20)

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

using Moov.Sdk;
using Moov.Sdk.Models.Requests;

var sdk = new MoovClient(xMoovVersion: "<value>");

ListStatementsRequest req = new ListStatementsRequest() {
    Skip = 60,
    Count = 20,
    AccountID = "b63ef5ea-db36-47f1-a72e-1a5eb1c43c0f",
};

var res = await sdk.Statements.ListAsync(req);

// 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
29
30
31

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('<value>')
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\ListStatementsRequest(
    skip: 60,
    count: 20,
    accountID: 'b63ef5ea-db36-47f1-a72e-1a5eb1c43c0f',
);

$response = $sdk->statements->list(
    request: $request
);

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

require 'moov_ruby'

Models = ::Moov::Models
s = ::Moov::Client.new(
      x_moov_version: '<value>',
    )

req = Models::Operations::ListStatementsRequest.new(
  skip: 60,
  count: 20,
  account_id: 'b63ef5ea-db36-47f1-a72e-1a5eb1c43c0f',
)

res = s.statements.list(request: req)

unless res.statements.nil?
  # handle response
end
200 400 401 403 429 500 504
The request completed successfully.
application/json
Example
[
  {
    "statementID": "77496e4d-d30a-43db-84ae-c3147da377ff",
    "statementName": "string",
    "fileName": "string",
    "fileSize": 0,
    "billingPeriodStartDateTime": "2019-08-24T14:15:22Z",
    "billingPeriodEndDateTime": "2019-08-24T14:15:22Z",
    "subscriptionIDs": [
      "string"
    ],
    "summary": {
      "cardAcquiring": {
        "volumeAmount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "volumeCount": 0,
        "feeAmount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "merchantFeesCollected": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "partnerFeesAssessed": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "netIncome": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "interchangeFees": {
          "visa": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          },
          "mastercard": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          },
          "discover": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          },
          "americanExpress": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        }
      },
      "ach": {
        "volumeAmount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "volumeCount": 0,
        "feeAmount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "merchantFeesCollected": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "partnerFeesAssessed": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "netIncome": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "instantPayments": {
        "volumeAmount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "volumeCount": 0,
        "feeAmount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "merchantFeesCollected": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "partnerFeesAssessed": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "netIncome": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "platformFees": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "accountFees": {
        "volumeAmount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "volumeCount": 0,
        "feeAmount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "merchantFeesCollected": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "partnerFeesAssessed": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "netIncome": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "adjustmentFees": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "otherFees": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "otherCardFees": {
        "volumeAmount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "volumeCount": 0,
        "feeAmount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "merchantFeesCollected": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "partnerFeesAssessed": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "netIncome": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "total": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "netIncomeSubtotal": {
        "volumeAmount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "volumeCount": 0,
        "feeAmount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "merchantFeesCollected": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "partnerFeesAssessed": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "netIncome": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "revenueShare": "string",
      "residualSubtotal": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "monthlyPartnerCosts": {
        "minimumCommitment": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "monthlyPlatform": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        },
        "total": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "netPartnerPayment": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "cardAcquiringFees": {
      "visa": {
        "interchange": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "interchangePrograms": [
          {
            "programName": "string",
            "count": 0,
            "percentageRate": 0,
            "perItemRate": {
              "currency": "USD",
              "valueDecimal": "12.987654321"
            },
            "total": {
              "currency": "USD",
              "valueDecimal": "12.987654321"
            },
            "transferVolume": {
              "currency": "USD",
              "valueDecimal": "12.987654321"
            }
          }
        ],
        "networkPassthrough": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "completedDomesticOnline": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "completedDomesticInPerson": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "completedInternationalOnline": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "completedInternationalInPerson": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "declines": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "refunds": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "total": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        }
      },
      "mastercard": {
        "interchange": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "interchangePrograms": [
          {
            "programName": "string",
            "count": 0,
            "percentageRate": 0,
            "perItemRate": {
              "currency": "USD",
              "valueDecimal": "12.987654321"
            },
            "total": {
              "currency": "USD",
              "valueDecimal": "12.987654321"
            },
            "transferVolume": {
              "currency": "USD",
              "valueDecimal": "12.987654321"
            }
          }
        ],
        "networkPassthrough": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "completedDomesticOnline": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "completedDomesticInPerson": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "completedInternationalOnline": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "completedInternationalInPerson": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "declines": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "refunds": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "total": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        }
      },
      "discover": {
        "interchange": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "interchangePrograms": [
          {
            "programName": "string",
            "count": 0,
            "percentageRate": 0,
            "perItemRate": {
              "currency": "USD",
              "valueDecimal": "12.987654321"
            },
            "total": {
              "currency": "USD",
              "valueDecimal": "12.987654321"
            },
            "transferVolume": {
              "currency": "USD",
              "valueDecimal": "12.987654321"
            }
          }
        ],
        "networkPassthrough": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "completedDomesticOnline": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "completedDomesticInPerson": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "completedInternationalOnline": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "completedInternationalInPerson": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "declines": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "refunds": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "total": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        }
      },
      "americanExpress": {
        "interchange": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "interchangePrograms": [
          {
            "programName": "string",
            "count": 0,
            "percentageRate": 0,
            "perItemRate": {
              "currency": "USD",
              "valueDecimal": "12.987654321"
            },
            "total": {
              "currency": "USD",
              "valueDecimal": "12.987654321"
            },
            "transferVolume": {
              "currency": "USD",
              "valueDecimal": "12.987654321"
            }
          }
        ],
        "networkPassthrough": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "completedDomesticOnline": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "completedDomesticInPerson": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "completedInternationalOnline": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "completedInternationalInPerson": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "declines": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "refunds": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        },
        "total": {
          "count": 0,
          "amount": {
            "currency": "USD",
            "valueDecimal": "12.987654321"
          }
        }
      }
    },
    "achFees": {
      "standardCredit": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "sameDayCredit": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "debits": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "return": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "unauthorizedReturn": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "noticeOfChange": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "total": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      }
    },
    "instantPaymentFees": {
      "rtpCreditTransaction": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "rtpDecline": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "pushToCardTransaction": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "pushToCardDecline": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "pullFromCardTransaction": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "pullFromCardDecline": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "pullFromCardRefund": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "instantVerification": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "total": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      }
    },
    "platformFees": {
      "walletFee": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "merchantPCIFee": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "total": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "accountFees": {
      "walletFee": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "merchantPCIFee": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "kybFee": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "kycFee": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "transactionMonitoringFee": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "total": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "otherCardFees": {
      "disputes": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "cardAccountUpdater": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "cardVerification": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "nameVerification": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      },
      "total": {
        "count": 0,
        "amount": {
          "currency": "USD",
          "valueDecimal": "12.987654321"
        }
      }
    },
    "partnerFees": {
      "minimumCommitment": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "monthlyPlatform": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      },
      "total": {
        "currency": "USD",
        "valueDecimal": "12.987654321"
      }
    },
    "createdOn": "2019-08-24T14:15:22Z",
    "updatedOn": "2019-08-24T14:15:22Z"
  }
]

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The server could not understand the request due to invalid syntax.
application/json
Example
{
  "error": "string"
}

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

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. When no version is specified, the API defaults to v2024.01.00.

Path parameters

accountID

string <uuid> required

Query parameters

billingPeriodStartDateTime

string <date-time>
Optional date-time which inclusively filters all statements where billing period is on or after this date-time.

billingPeriodEndDateTime

string <date-time>
Optional date-time which exclusively filters all statements where billing period is before this date-time.

skip

integer <int64>

count

integer <int64>
Default: 200

Response

application/json

accountFees

object
A detailed breakdown of account fees.
Show child attributes

merchantPCIFee

object required
Fees for PCI compliance.
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'.

total

object required
Total platform fees.
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'.

walletFee

object required
Fees associated with wallet services.
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'.

kybFee

object
Fees for business verification.
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'.

kycFee

object
Fees for customer verification.
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'.

transactionMonitoringFee

object
Fees for transaction risk monitoring.
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'.

achFees

object
A detailed breakdown of ACH fees.
Show child attributes

debits

object required
Fees for debit transfers.

noticeOfChange

object required
Fees for notices of change.

return

object required
Fees for authorized returns.

sameDayCredit

object required
Fees for same-day credit transfers.

standardCredit

object required
Fees for standard credit transfers.

total

object required
Total ACH fees.

unauthorizedReturn

object required
Fees for unauthorized returns.

billingPeriodEndDateTime

string<date-time>
The end date and time of the billing period.

billingPeriodStartDateTime

string<date-time>
The start date and time of the billing period.

cardAcquiringFees

object
A detailed breakdown of card acquiring fees by card brand.
Show child attributes

americanExpress

object required
Fees associated with American Express transactions.

discover

object required
Fees associated with Discover transactions.

mastercard

object required
Fees associated with Mastercard transactions.

visa

object required
Fees associated with Visa transactions.
Show child attributes

completedDomesticInPerson

object
Details of completed domestic in-person transactions.

completedDomesticOnline

object
Details of completed domestic online transactions.

completedInternationalInPerson

object
Details of completed international in-person transactions.

completedInternationalOnline

object
Details of completed international online transactions.

declines

object
Details of declined transactions.

interchange

object
Details of interchange fees.
Show child attributes

amount

object required
The total 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'.

count

integer<int64> required
The number of items.

interchangePrograms

array<object>
A list of interchange program fees.
Show child attributes

count

integer<int64>
The number of transactions for this program.

percentageRate

number<decimal>
The percentage rate for this program.

perItemRate

object
The per-item rate for this program.
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'.

programName

string
The name of the interchange program.

total

object
The total fee amount for this program.
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'.

transferVolume

object
The total transfer volume for this program.
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'.

networkPassthrough

object
Details of network passthrough fees.

refunds

object
Details of refunded transactions.

total

object required
Total fees for this card brand.

createdOn

string<date-time>
The date and time the statement was created.

fileName

string
The name of the statement file.

fileSize

integer<int64>
The size of the statement file in bytes.

instantPaymentFees

object
A detailed breakdown of instant payment fees.
Show child attributes

instantVerification

object required
Fees for instant payment verifications.

pullFromCardTransaction

object required
Fees for pull-from-card transactions.

pushToCardTransaction

object required
Fees for push-to-card transactions.

rtpCreditTransaction

object required
Fees for RTP credit transactions.

total

object required
Total instant payment fees.

pullFromCardDecline

object
Fees for pull-from-card declines.

pullFromCardRefund

object
Fees for pull-from-card refunds.

pushToCardDecline

object
Fees for push-to-card declines.

rtpDecline

object
Fees for RTP declines.

otherCardFees

object
A detailed breakdown of other card-related fees.
Show child attributes

cardAccountUpdater

object required
Fees for card account updater services.

cardVerification

object required
Fees for card verification.

disputes

object required
Fees for disputes.

nameVerification

object required
Fees for name verification.

total

object required
Total other card fees.

partnerFees

object
Monthly partner costs that are charged separately and not included in residual subtotal (e.g. platform fees, minimums).
Show child attributes

platformFees

object deprecated
A detailed breakdown of platform fees. This field is deprecated and will be removed in a future release. Use accountFees.
Show child attributes

merchantPCIFee

object required
Fees for PCI compliance.
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'.

total

object required
Total platform fees.
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'.

walletFee

object required
Fees associated with wallet services.
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'.

statementID

string<uuid>
The unique identifier for the statement.

statementName

string
The name of the statement.

subscriptionIDs

array<string>
List of subscription IDs associated with this statement.

summary

object
A summary of all fees included in a statement.
Show child attributes

accountFees

object
A summary of account fees.

ach

object
A summary of ACH fees.
Show child attributes

feeAmount

object
The total 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'.

merchantFeesCollected

object
Total fee revenue collected from merchants.
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'.

netIncome

object
Net revenue after deducting partner fee costs.
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'.

partnerFeesAssessed

object
Total fee costs incurred by the partner.
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'.

volumeAmount

object deprecated
The total transaction volume amount. This field is deprecated and will be removed in a future release.
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'.

volumeCount

integer<int64> deprecated
The total number of transactions. This field is deprecated and will be removed in a future release.

adjustmentFees

object deprecated
The total amount of adjustment fees. This field is deprecated and will be removed in a future release.
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'.

cardAcquiring

object
A summary of card acquiring fees.
Show child attributes

feeAmount

object
The total 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'.

interchangeFees

object
A summary of interchange fees by card brand.
Show child attributes

americanExpress

object required
Total interchange fees for American Express.
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'.

discover

object required
Total interchange fees for Discover.
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'.

mastercard

object required
Total interchange fees for Mastercard.
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'.

visa

object required
Total interchange fees for Visa.
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'.

merchantFeesCollected

object
Total fee revenue collected from merchants.
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'.

netIncome

object
Net revenue after deducting partner fee costs.
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'.

partnerFeesAssessed

object
Total fee costs incurred by the partner.
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'.

volumeAmount

object deprecated
The total transaction volume amount. This field is deprecated and will be removed in a future release.
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'.

volumeCount

integer<int64> deprecated
The total number of transactions. This field is deprecated and will be removed in a future release.

instantPayments

object
A summary of instant payment fees.

monthlyPartnerCosts

object
Monthly partner costs that are charged separately and not included in residual subtotal (e.g. platform fees, minimums).
Show child attributes

minimumCommitment

object required
The minimum spending amount that must be met in the billing period. If actual usage is below the minimum amount, account is charged the difference.
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'.

monthlyPlatform

object required
Fixed recurring fee for the billing period regardless of usage.
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'.

total

object required
Total partner fees.
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'.

netIncomeSubtotal

object
Total net revenue after deducting total partner fees.

netPartnerPayment

object
Final partner payment after deducting monthlyPartnerCosts.
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'.

otherCardFees

object
A summary of other card fees.

otherFees

object deprecated
The total amount of other card fees. This field is deprecated and will be removed in a future release. Use summary.otherCardFees.
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'.

platformFees

object deprecated
The total amount of platform fees. This field is deprecated and will be removed in a future release. Use summary.accountFees.
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'.

residualSubtotal

object
The portion of net income allocated to the partner before monthly partner costs.
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'.

revenueShare

string
Partner’s share of the net income, expressed as a percentage.

total

object
The total amount of all fees.
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'.

updatedOn

string<date-time>
The date and time the statement was last updated.