Sign in
Deposit

Retrieve a deposit

Retrieves a deposit by its ID.

post/api/service/deposit/retrieve

Request body

idstring uuid required

The ID of the deposit

Response

Deposit retrieved successfully

idstring uuid required

The ID of the deposit

status'received' required

The status of the deposit

amountnumber required

The amount of the deposit

transactionIdstring uuid required

The ID of the transaction that initiated the deposit

currency'EUR' | 'GBP' | 'PLN' | 'SEK' | 'DKK' | 'USD' | 'USDC' | 'BTC' | 'ETH' | 'SOL' | 'POL' required

The currency of the deposit

receivedAtstring date-time required

The date and time the deposit was received

bankStatementReferencestring

The reference that appears on the bank statement

rail'sepa_instant' | 'faster_payments' | 'sepa' | 'elixir' | 'express_elixir' | 'sek_account_to_account' | 'sumclearing' | 'straksclearing' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'fednow' | 'rtp' | 'BTC' | 'BTC-TESTNET4' | 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY'

The payment rail or blockchain used for the deposit

txHashstring

The transaction hash for crypto deposits

Changes

Changed in 9 of the 52 revisions of this API.517

  • 0694d18875162See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

  • d9c9345c84796See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

      added the new ETH enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

      added the new POL enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

      added the new SOL enum value to the // response property for the response status

      response-property-enum-value-added

  • 103711f8bc3a8See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

      added the new BTC enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

      added the new BTC enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC-TESTNET4 enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC-TESTNET4 enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC-TESTNET4 enum value to the response property for the response status

      response-property-enum-value-added

  • 3ed3cb51802c8See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

      added the new BTC enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

      added the new BTC enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC-TESTNET4 enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC-TESTNET4 enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC-TESTNET4 enum value to the response property for the response status

      response-property-enum-value-added

  • 985fef88525b2See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

  • f133fdf6c9bd2See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 84194dfc43b44See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

      added the new USD enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new aba enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new aba enum value to the / response property for the response status

      response-property-enum-value-added

  • 999c91fe685d2See the full diff
    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

  • 102fab1c7e1a213See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

      added the new ETH-SEPOLIA enum value to the response property for the response status

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

      added the new MATIC-AMOY enum value to the response property for the response status

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

      added the new SOL-DEVNET enum value to the response property for the response status

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

      added the new USDC enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

      added the new wallet enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new wallet enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added