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 |
Body
application/json
- FPS
- SEPA
- ACH
- FedNow
- RTP
- Wire
Was this page helpful?