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"
}
}
}Test helpers
Simulate bank deposit
Simulate an incoming bank deposit for testing purposes.
POST
/
core
/
accounts
/
test-helpers
/
bank-deposits
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.
The request body is a discriminated union on the
network field. Required fields vary by network:
| Network | Required fields |
|---|---|
fps | sortCode, accountNumber, reference, asset, amount, remitter (name, sortCode, accountNumber) |
sepa | iban, asset, amount, remitter (name, bic, iban) |
ach | accountNumber, routingNumber, amount |
fednow | accountNumber, amount |
rtp | accountNumber, amount |
wire | accountNumber, amount |
Authorizations
OAuth 2.0 authentication.
Body
application/json
- FPS
- SEPA
- ACH
- FedNow
- RTP
- Wire
The network used to process the bank transfer.
Available options:
fps The six-digit sort code of the destination bank account where funds will be deposited.
Pattern:
^\d{6}$The account number of the destination bank account where funds will be deposited.
Pattern:
^(?!0+$)[0-9]{6,8}$The user's account settlement asset.
Pattern:
^\S.*\S$|^\S$The amount to be deposited into the destination account.
Pattern:
^(?!0+(\.0+)?$)\d+(\.\d+)?$A unique identifier indicating the specific account where the funds should be credited. If omitted, funds will be credited to the user's default account.
Pattern:
^\S.*\S$|^\S$Information about the bank deposit sender.
Show child attributes
Show child attributes
Response
Bank deposit simulated.
- FPS
- SEPA
- ACH
- FedNow
- RTP
- Wire
Show child attributes
Show child attributes
Was this page helpful?