Deposits

Retrieve deposit

Changed on

Retrieves a deposit by ID.

get/v1/deposits/{id}

Request

  • Base URL
    https://api.augustus.com
  • URL
    https://api.augustus.com/v1/deposits/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:550e8400-e29b-41d4-a716-446655440004

Unique identifier of the deposit.

Response

The deposit resource

idstring uuid required

Unique identifier of the deposit.

type'deposit' required

Resource type discriminator.

status'settled' required

Current status of the deposit.

account_idstring uuid required

ID of the account that was credited with the deposit.

amountstring required

Amount as a string decimal (e.g. "100.50").

currency'EUR' | 'GBP' | 'USD' | 'USDC' required

Currency code (ISO 4217 or crypto).

counterparty_idstring uuid nullable required

ID of the counterparty that sent the money, or null when not known.

unstructured_remittance_informationstring nullable required

Unstructured remittance information attached to the transfer. Not all rails support this field.

rail'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | 'null' nullable required

Payment scheme or blockchain used for the deposit, or null when unknown.

tx_hashstring nullable required

Transaction hash for crypto deposits, or null when not known. Only blockchain rails support this field.

returnsstring[] required

Array of deposit return IDs associated with this deposit.

settled_atstring date-time required

ISO 8601 UTC timestamp when the deposit was settled.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440004",
  "status": "settled",
  "account_id": "550e8400-e29b-41d4-a716-446655440001",
  "amount": "100.50",
  "currency": "USD",
  "counterparty_id": "550e8400-e29b-41d4-a716-446655440000",
  "unstructured_remittance_information": "INV-2026-0042",
  "tracking_reference": {
    "type": "uetr",
    "value": "550e8400-e29b-41d4-a716-446655440000"
  },
  "rail": "ach",
  "returns": [],
  "settled_at": "2026-01-15T10:30:00Z"
}

Changes

  • f7ded6c181abRevision changes
    • info

      endpoint added

  • 79d607871de9Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      added the new bitcoin enum value to the response property for the response status

    • warning

      added the new bitcoin_testnet4 enum value to the response property for the response status

    • warning

      added the new ethereum enum value to the response property for the response status

    • warning

      added the new ethereum_sepolia enum value to the response property for the response status

    • warning

      added the new polygon enum value to the response property for the response status

    • warning

      added the new polygon_amoy enum value to the response property for the response status

    • warning

      added the new settled enum value to the response property for the response status

    • warning

      added the new solana enum value to the response property for the response status

    • warning

      added the new solana_devnet enum value to the response property for the response status

    • info

      removed the btc enum value from the response property for the response status

    • info

      removed the btc_testnet4 enum value from the response property for the response status

    • info

      removed the elixir enum value from the response property for the response status

    • info

      removed the eth enum value from the response property for the response status

    • info

      removed the eth_sepolia enum value from the response property for the response status

    • info

      removed the express_elixir enum value from the response property for the response status

    • info

      removed the in_return enum value from the response property for the response status

    • info

      removed the matic enum value from the response property for the response status

    • info

      removed the matic_amoy enum value from the response property for the response status

    • info

      removed the received enum value from the response property for the response status

    • info

      removed the return_failed enum value from the response property for the response status

    • info

      removed the return_returned enum value from the response property for the response status

    • info

      removed the returned enum value from the response property for the response status

    • info

      removed the sek_account_to_account enum value from the response property for the response status

    • info

      removed the sol enum value from the response property for the response status

    • info

      removed the sol_devnet enum value from the response property for the response status

    • info

      removed the straksclearing enum value from the response property for the response status

    • info

      removed the sumclearing enum value from the response property for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status