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"
    }
  }
}

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.

​
accountNumber
string
required

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

​
asset
string
required

The settlement asset of the user's bank account.

​
amount
string
required

The amount to be deposited into the destination account.

​
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.

​
remitter
object

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

Response

Bank deposit simulated.

​
bankDeposit
object
required