Sign in
Simulations

Simulate an incoming deposit

Initiates an incoming deposit through the sandbox provider pipeline. This endpoint is unavailable in live production.

post/v1/simulations/deposits

Headers

Idempotency-Keystring required

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Request body

account_idstring uuid required

ID of the account to credit with the simulated deposit.

amountstring required

Amount as a decimal string in the account currency (e.g. "100.50").

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

Currency of the simulated deposit.

unstructured_remittance_informationstring

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

rail'sepa' | 'sepa_instant' | 'faster_payments' | 'ach' | 'fedwire' | 'swift'

Payment rail the simulated deposit arrives on.

Example request

{
  "currency": "EUR",
  "counterparty": {
    "financial_address": {
      "type": "iban",
      "iban": "DE89370400440532013000",
      "account_holder_name": "Acme Sandbox Ltd.",
      "bic": "COBADEFFXXX"
    },
    "physical_address": {
      "country_code": "DE"
    }
  }
}

Response

The deposit simulation acknowledgement

type'deposit_simulation' required

Resource type discriminator.

successboolean required

Whether the simulation submission was successful.

account_idstring uuid required

Account receiving the simulated deposit.

amountstring required

Simulated amount as a decimal string.

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

Currency of the receiving account.

unstructured_remittance_informationstring nullable required

ISO 20022 unstructured remittance information (<RmtInf>/<Ustrd>), or null when omitted.

rail'sepa' | 'sepa_instant' | 'faster_payments' | 'ach' | 'fedwire' | 'swift' | 'null' nullable required

Payment rail the simulated deposit arrived on, or null when not known.

Example response

{
  "currency": "EUR"
}

Changes

Changed in 4 of the 38 revisions of this API.328

  • e0010b51834a1See the full diff
    • ○

      added to the / request property anyOf list

      request-property-any-of-added

  • 4549ed68144b213See the full diff
    • ▲

      removed the enum value sepa_credit_transfer of the request property

      request-property-enum-value-removed

    • ▲

      removed the enum value t2 of the request property

      request-property-enum-value-removed

    • ●

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

      response-property-enum-value-added

    • ○

      added the new sepa enum value to the request property

      request-property-enum-value-added

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

  • 8e304f78f67e113See the full diff
    • ▲

      removed from the / request property anyOf list

      request-property-any-of-removed

    • ●

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

      response-property-enum-value-added

    • ○

      added to the / request property anyOf list

      request-property-any-of-added

    • ○

      the request property / became optional

      request-property-became-optional

    • ○

      added the new swift enum value to the request property

      request-property-enum-value-added

  • 79d607871de91See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog