What’s included
Deposits
| Endpoint | Description |
|---|---|
| List deposits | Retrieve a paginated list of deposits |
| Get deposit | Retrieve a single deposit by ID |
| List deposit details | Retrieve line-item details for a deposit |
| Get deposit detail | Retrieve a single deposit detail line item |
Chargebacks
| Endpoint | Description |
|---|---|
| List chargebacks | Retrieve a paginated list of chargebacks |
| Get chargeback | Retrieve a single chargeback by ID |
| List related chargebacks | Retrieve chargebacks related to a given dispute |
Residuals
Summaries & metrics
| Endpoint | Description |
|---|---|
| List residuals | Retrieve ISO residual historical summaries |
| Get residual | Retrieve a single residual period summary |
| Get residual metrics | Retrieve aggregated metrics across all residual periods |
| List gross details | Retrieve gross fee details across residuals |
Merchant summaries
| Endpoint | Description |
|---|---|
| List all merchant summaries | Retrieve merchant-level summaries across all residuals |
| List merchant summaries | Retrieve merchant summaries for a specific residual |
| Get merchant summary | Retrieve a single merchant-level residual summary |
| List merchant details | Retrieve fee category details for a merchant residual summary |
| Get merchant detail | Retrieve a single fee category detail record |
Overrides
| Endpoint | Description |
|---|---|
| List all overrides | Retrieve residual overrides across all periods |
| List overrides | Retrieve overrides for a specific residual period |
| Get override | Retrieve a single residual override |
Transactions
| Endpoint | Description |
|---|---|
| List transactions | Retrieve a paginated list of transactions |
| Get transaction | Retrieve a single transaction by ID |
| List by reference | Retrieve transactions by an external reference ID |
| List notes | Retrieve all notes on a transaction |
| Create note | Add a note to a transaction |
| Get note | Retrieve a single transaction note |
Transaction batches
| Endpoint | Description |
|---|---|
| List batches | Retrieve a paginated list of transaction batches |
| Get batch | Retrieve a single transaction batch by ID |
| List batch notes | Retrieve all notes on a transaction batch |
| Create batch note | Add a note to a transaction batch |
| Get batch note | Retrieve a single batch note |
Statements
| Endpoint | Description |
|---|---|
| List statements | Retrieve a paginated list of statements |
| Get statement | Retrieve a single statement by ID |
| Get statement document | Download a document attached to a statement |
| List statement notes | Retrieve all notes on a statement |
| Create statement note | Add a note to a statement |
| Get statement note | Retrieve a single statement note |