Skip to main content
POST
/
core
/
accounts
/
test-helpers
/
bank-deposits
Simulate bank deposit
curl --request POST \
  --url https://api.enterprise.sandbox.uphold.com/core/accounts/test-helpers/bank-deposits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "network": "fps",
  "sortCode": "123456",
  "accountNumber": "12345678",
  "reference": "UH12345678",
  "asset": "GBP",
  "amount": "100",
  "remitter": {
    "name": "John Doe",
    "sortCode": "654321",
    "accountNumber": "87654321"
  }
}
'
{
  "bankDeposit": {
    "network": "fps",
    "sortCode": "123456",
    "accountNumber": "12345678",
    "reference": "UH12345678",
    "asset": "GBP",
    "amount": "100",
    "remitter": {
      "name": "John Doe",
      "sortCode": "654321",
      "accountNumber": "87654321"
    }
  }
}
This endpoint allows you to simulate a bank deposit based on the details returned by the Setup Account Deposit Method endpoint. It is useful for testing how your application handles incoming deposits without needing to perform an actual bank transfer.
This is a Test Helper endpoint and can only be used in Sandbox.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication.

Body

application/json
​
network
enum<string>
required

The network used to process the bank transfer.

Available options:
fps
​
sortCode
string
required

The six-digit sort code of the destination bank account where funds will be deposited.

Pattern: ^\d{6}$
​
accountNumber
string
required

The account number of the destination bank account where funds will be deposited.

Pattern: ^\d{6,8}$
​
asset
string
required

The settlement asset of the user's bank account.

Pattern: ^\S.*\S$|^\S$
​
amount
string
required

The amount to be deposited into the destination account.

Pattern: ^\d+(\.\d+)?$
​
reference
string

A unique identifier indicating the specific account where the funds should be credited. If omitted, funds will be credited to the default account for the specified asset.

Pattern: ^\S.*\S$|^\S$
​
remitter
object

The information about the external bank account holder who is sending the funds.

Response

Bank deposit simulated.

​
bankDeposit
FPS · object
required