Sign in

v6

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0161197504.7 KB
payments

Retrieve a deposit

Retrieve a deposit by ID.

get/accounts/{account_id}/deposits/{deposit_id}

Path parameters

account_idstring required
deposit_idstring required

Response

OK

accountstring required

The ID of the parent account.

advanced_atstring date-time nullable

The time the deposit was advanced as unsettled cash.

amountstring required

The amount of the deposit.

completed_atstring date-time nullable

The time the deposit was completed.

created_atstring date-time required

The timestamp (in ISO-8601 format) of when the resource was created.

currency'EUR' | 'USD' | 'GBP' required
idstring required

Unique resource identifier.

modified_atstring date-time required

The timestamp (in ISO-8601 format) of when the resource was last modified.

payment_referencestring required

The reference used to identify the inbound payment.

status'open' | 'completed' required
was_advancedboolean required

Whether the deposit was advanced as unsettled cash.

Example response

{
  "advanced_at": "2026-07-14T09:32:00Z",
  "amount": "100.00",
  "completed_at": "2026-07-14T09:34:12Z",
  "payment_reference": "202512161234"
}