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

NameInTypeRequiredDescription
accountId path string yes

Unique identifier of the account.

Request body

application/json · CreateDepositRequest · required

FieldTypeRequiredDescription
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.
card DepositCard no
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.
expectedChargebackFee string no

Chargeback fee previously shown by the quote endpoint.
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

providerFee previously shown by the quote endpoint.
expectedRefundFee string no

Refund fee previously shown by the quote endpoint.
method FundingMethod yes
payer DepositPayer no
payerReference string no

Your own stable identifier of the payer, 1-128 characters. Required on an account that is not bound to a user, unless userId is sent: the payer is then not a PayCA user, nothing is created for them, and their details come in payer with every request. Send the same value for the same person every time, and a different value for every other person. Optional on a user's account. Returned on the deposit and in its webhooks.
userId string no

User the deposit is for. On an account bound to a user it may be omitted and, when sent, must be that user. On an account not bound to a user it names an existing user of yours; to top up for a payer who is not a PayCA user, send payerReference instead.

Responses

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