Opens a deposit and returns it, including the `checkoutUrl` the payer must be sent to. The deposit is NOT money yet: it becomes `completed` only once the payment settles and the balance credit is recorded. Requires an `Idempotency-Key` header. A repeat of the same key returns the original deposit untouched rather than opening a second checkout the payer could also pay. Redirect URLs must match the prefixes allow-listed for the calling client. Both are required by the acquirer.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
accountId |
path | string |
yes | Unique identifier of the account. |
Request body
application/json
· CreateDepositRequest
· required
| Field | Type | Required | Description |
|---|---|---|---|
amount |
string |
yes | Amount to deposit, in the account's own currency. A deposit is never converted on the way in. |
cancelRedirectUrl |
string |
yes | Where the payer returns after cancelling. Must match a prefix allow-listed for the calling client. |
completeRedirectUrl |
string |
yes | Where the payer returns after a completed checkout. Must match a prefix allow-listed for the calling client. |
country |
string |
yes | ISO 3166-1 alpha-2 billing country of the payer. |
expectedChargedAmount |
string |
no | Total previously shown by the quote endpoint. Create returns 409 if it changed. |
expectedCreditedAmount |
string |
no | Credited amount previously shown by the quote endpoint. |
expectedDeclineFee |
string |
no | Decline fee previously shown by the quote endpoint. |
expectedPaycaFee |
string |
no | Processing fee previously shown by the quote endpoint. |
expectedProviderFee |
string |
no | Acquiring fee previously shown by the quote endpoint. |
expectedRefundFee |
string |
no | Refund fee previously shown by the quote endpoint. |
method |
FundingMethod |
yes | |
payer |
DepositPayer |
no | |
userId |
string |
no | User the deposit is for. Required when the account is not itself bound to a user, and it must belong to the same account. |
Responses
| Status | Body | Description |
|---|---|---|
201 |
Deposit |
Deposit created. |
400 |
Error |
Invalid request. |
403 |
Error |
Deposits are not enabled for this client. |
404 |
Error |
Account not found. |
409 |
Error |
The idempotency key was already used for a different request, or the expected quote no longer matches the live tariff. |
Specification
This page is generated from the OpenAPI specification, which remains the authoritative machine-readable source.