JOjoinsophic
payments

Create a deposit

Changed on

Create a deposit, funded by bank transfer. The deposit amount can be optionally advanced, to increase the account's buying power before the deposit is funded.

post/accounts/{account_id}/deposits

Request

  • Base URL
    https://api.engine.usesophic.com
  • Auth
    HTTP bearer

Path parameters

account_idstring required

Request body

currency'EUR' | 'USD' | 'GBP' required
payment_referencestring

Reference used to match the inbound payment; generated when omitted and unique per funding batch when provided.

request_advanceboolean

Request that the deposit amount is credited in advance as unsettled cash, which will settle once the deposit is funded.

Response

Created

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' | 'pending' | 'held' | 'returning' | 'completed' | 'returned' | 'cancelled' 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"
}

Changes

  • 6a63920239d8Revision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from no type to string

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • warning

      removed from the request property allOf list

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      added the new EUR enum value to the request property

    • info

      added the new GBP enum value to the request property

    • info

      added the new USD enum value to the request property

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

  • aa43bab6253cRevision changes
    • breaking

      response property context/additionalProperties/ list-of-types was widened by adding types array to media type application/json of response 400