Augustus Deposits API
The Deposits API from Augustus — 2 operation(s) for deposits.
The Deposits API from Augustus — 2 operation(s) for deposits.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/augustus:augustus-deposits-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Augustus Banking Deposits API
description: Augustus Banking API
version: 0.1.0
contact:
name: Augustus
url: https://docs.augustus.com
email: developer@augustus.com
servers:
- url: https://api.augustus.com
description: Production
- url: https://api.sandbox.augustus.com
description: Sandbox
security:
- BearerAuth: []
tags:
- name: Deposits
paths:
/v1/deposits/{id}:
get:
description: Retrieves a deposit by ID.
operationId: DepositsController_retrieve
parameters:
- name: id
required: true
in: path
description: Unique identifier of the deposit.
schema:
format: uuid
example: 550e8400-e29b-41d4-a716-446655440004
type: string
responses:
'200':
description: The deposit resource
content:
application/json:
schema:
$ref: '#/components/schemas/DepositResourceDto'
summary: Retrieve deposit
tags:
- Deposits
/v1/deposits:
get:
description: Lists deposits for the merchant with cursor-based pagination.
operationId: DepositsController_list
parameters:
- name: limit
required: false
in: query
description: Number of results per page (1-100). Defaults to 10.
schema:
minimum: 1
maximum: 100
default: 10
type: integer
- name: cursor
required: false
in: query
description: Opaque cursor from a previous next_cursor.
schema:
type: string
- name: settled_at.gte
required: false
in: query
description: Include deposits whose settled_at is greater than or equal to this ISO 8601 timestamp.
schema:
format: date-time
example: '2026-01-01T00:00:00Z'
type: string
- name: settled_at.lte
required: false
in: query
description: Include deposits whose settled_at is less than or equal to this ISO 8601 timestamp.
schema:
format: date-time
example: '2026-02-01T00:00:00Z'
type: string
- name: rail
required: false
in: query
description: Filter by deposit rail.
schema:
type: string
enum:
- sepa
- sepa_instant
- faster_payments
- swift
- internal
- target
- ach
- fedwire
- bitcoin
- bitcoin_testnet4
- ethereum
- ethereum_sepolia
- solana
- solana_devnet
- polygon
- polygon_amoy
- name: currencies
required: false
in: query
description: Filter to these currency codes. Use a separate `currencies` query parameter for each value (e.g. `?currencies=EUR¤cies=USD`).
schema:
minItems: 1
type: array
items:
type: string
enum:
- EUR
- GBP
- USD
- USDC
description: Currency code (ISO 4217 or crypto).
example: USD
responses:
'200':
description: Paginated list of deposits
content:
application/json:
schema:
$ref: '#/components/schemas/ListDepositsResponseDto'
summary: List deposits
tags:
- Deposits
components:
schemas:
ListDepositsResponseDto:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier of the deposit.
example: 550e8400-e29b-41d4-a716-446655440004
type:
type: string
description: Resource type discriminator.
enum:
- deposit
status:
type: string
enum:
- settled
description: Current status of the deposit.
example: settled
account_id:
type: string
format: uuid
description: ID of the account that was credited with the deposit.
example: 550e8400-e29b-41d4-a716-446655440001
amount:
type: string
description: Amount as a string decimal (e.g. "100.50").
example: '100.50'
currency:
type: string
enum:
- EUR
- GBP
- USD
- USDC
description: Currency code (ISO 4217 or crypto).
example: USD
counterparty_id:
type: string
format: uuid
description: ID of the counterparty that sent the money, or null when not known.
example: 550e8400-e29b-41d4-a716-446655440000
nullable: true
unstructured_remittance_information:
type: string
maxLength: 140
description: Unstructured remittance information attached to the transfer. Not all rails support this field.
example: INV-2026-0042
nullable: true
tracking_reference:
type: object
properties:
type:
type: string
enum:
- uetr
- imad
- trace_number
description: 'Tracking reference type: UETR, IMAD, or ACH trace number.'
value:
type: string
minLength: 1
description: Rail-provided tracking identifier.
example: 550e8400-e29b-41d4-a716-446655440000
required:
- type
- value
additionalProperties: false
example:
type: uetr
value: 550e8400-e29b-41d4-a716-446655440000
description: 'Rail network tracking identifier with its type: UETR for SWIFT, IMAD for Fedwire, or the 15-digit trace number for ACH. Null when unavailable.'
nullable: true
rail:
type: string
enum:
- sepa
- sepa_instant
- faster_payments
- swift
- internal
- target
- ach
- fedwire
- bitcoin
- bitcoin_testnet4
- ethereum
- ethereum_sepolia
- solana
- solana_devnet
- polygon
- polygon_amoy
- null
description: Payment scheme or blockchain used for the deposit, or null when unknown.
example: ach
nullable: true
tx_hash:
type: string
description: Transaction hash for crypto deposits, or null when not known. Only blockchain rails support this field.
example: null
nullable: true
returns:
type: array
items:
type: string
format: uuid
description: Array of deposit return IDs associated with this deposit.
example: []
settled_at:
type: string
format: date-time
description: ISO 8601 UTC timestamp when the deposit was settled.
example: '2026-01-15T10:30:00Z'
required:
- id
- type
- status
- account_id
- amount
- currency
- counterparty_id
- unstructured_remittance_information
- tracking_reference
- rail
- tx_hash
- returns
- settled_at
additionalProperties: false
has_more:
type: boolean
next_cursor:
type: string
example: eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0
nullable: true
has_previous:
type: boolean
previous_cursor:
type: string
example: eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0
nullable: true
required:
- data
- has_more
- next_cursor
- has_previous
- previous_cursor
additionalProperties: false
DepositResourceDto:
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier of the deposit.
example: 550e8400-e29b-41d4-a716-446655440004
type:
type: string
description: Resource type discriminator.
enum:
- deposit
status:
type: string
enum:
- settled
description: Current status of the deposit.
example: settled
account_id:
type: string
format: uuid
description: ID of the account that was credited with the deposit.
example: 550e8400-e29b-41d4-a716-446655440001
amount:
type: string
description: Amount as a string decimal (e.g. "100.50").
example: '100.50'
currency:
type: string
enum:
- EUR
- GBP
- USD
- USDC
description: Currency code (ISO 4217 or crypto).
example: USD
counterparty_id:
type: string
format: uuid
description: ID of the counterparty that sent the money, or null when not known.
example: 550e8400-e29b-41d4-a716-446655440000
nullable: true
unstructured_remittance_information:
type: string
maxLength: 140
description: Unstructured remittance information attached to the transfer. Not all rails support this field.
example: INV-2026-0042
nullable: true
tracking_reference:
type: object
properties:
type:
type: string
enum:
- uetr
- imad
- trace_number
description: 'Tracking reference type: UETR, IMAD, or ACH trace number.'
value:
type: string
minLength: 1
description: Rail-provided tracking identifier.
example: 550e8400-e29b-41d4-a716-446655440000
required:
- type
- value
additionalProperties: false
example:
type: uetr
value: 550e8400-e29b-41d4-a716-446655440000
description: 'Rail network tracking identifier with its type: UETR for SWIFT, IMAD for Fedwire, or the 15-digit trace number for ACH. Null when unavailable.'
nullable: true
rail:
type: string
enum:
- sepa
- sepa_instant
- faster_payments
- swift
- internal
- target
- ach
- fedwire
- bitcoin
- bitcoin_testnet4
- ethereum
- ethereum_sepolia
- solana
- solana_devnet
- polygon
- polygon_amoy
- null
description: Payment scheme or blockchain used for the deposit, or null when unknown.
example: ach
nullable: true
tx_hash:
type: string
description: Transaction hash for crypto deposits, or null when not known. Only blockchain rails support this field.
example: null
nullable: true
returns:
type: array
items:
type: string
format: uuid
description: Array of deposit return IDs associated with this deposit.
example: []
settled_at:
type: string
format: date-time
description: ISO 8601 UTC timestamp when the deposit was settled.
example: '2026-01-15T10:30:00Z'
required:
- id
- type
- status
- account_id
- amount
- currency
- counterparty_id
- unstructured_remittance_information
- tracking_reference
- rail
- tx_hash
- returns
- settled_at
additionalProperties: false
securitySchemes:
BearerAuth:
scheme: bearer
bearerFormat: JWT
type: http
description: Bearer token for authentication with Augustus Banking API
x-provenance:
method: harvested
publisher: Augustus
source: https://api.augustus.com/openapi/2026-05-01.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)