v1

latestOpenAPI 3.0.02026-07-26355499.1 KB

[POST] Create a deposit

Create a deposit request

Create a deposit request collecting and sending the information needed. We will return you with the information required to create the checkout on your own website or redirect the user to the checkout page .

post/v3/deposits

Headers

Content-Typestring required

Media type of the body sent to the API.

X-Datestring date-time required

ISO8601 Datetime with Timezone (yyyy-MM-dd'T'HH:mm:ssZ)

X-Loginstring required

Merchant X-Login API Key.

Authorizationstring required

Authorization control hash.

X-Idempotency-Keystring

Unique idempotency key for ensuring that the same request is not processed more than once.

Request body

countrystring required

Country of the deposit.

amountnumber double required

Amount of the deposit.

invoice_idstring required

Unique deposit ID on your side.

currencystring required

Currency of the deposit.

payment_methodstring required

Payment method code. Codes can be obtained from payment methods endpoint, or our coverage page

token_requestedstring

Used to define if merchant want to receive the checkout_token in response in order to display Fragments SDK all-in-one.

card_identifierstring

Used to generate a transaction in the payer's card stored in our vault.

allow_installmentsboolean

Used to indicate if the deposit should allow installments (in a credit card transaction). The options will be displayed to the user.

sub_merchant_idinteger

Used to specify for which SubMerchant ID the deposit will be created.

back_urlstring url

HTTPS URL used to redirect the customer in case of cancelling the deposit.

success_urlstring url

HTTPS URL used to redirect the customer in case of success.

error_urlstring url

HTTPS URL used to redirect the customer in case of error while generating the payment.

notification_urlstring url

HTTPS URL used to send the notifications about deposit's change of status.

payment_typesstring[]

request_payer_data_on_validation_failureboolean

Flag specifying if you want to ignore errors because of invalid phone, zip_code and/or city's state.

bonus_amountnumber double

Used to show the customer a bonus amount (Pay 100, receive 120).

bonus_relativeboolean

Used to define if the bonus_amount was specified as an absolute value or as a percentage.

strikethrough_pricenumber double

Used to show the customer a strikethrough amount.

descriptionstring

Description of the deposit.

client_ipstring ip

Valid IPv4/6 Address of the customer.

device_idstring

Unique customer's device ID created using our JS library.

languagestring

Language of the view page.

logostring url

HTTPS URL used as the Merchant logo on our cashier page.

testboolean

Used to mark a deposit as test. If true, the deposit will not affect the merchant's balance.

mobileboolean

Used to specify if the redirection will be made on a mobile device.

expirationnumber

Used to express, in minutes, how long after its creation the deposit should expire. Cannot be more than the default expiration of the payment method.

early_releaseboolean

Used to specify if the deposit should be released earlier.

fee_on_payerboolean

Used to specify if you want to let the customer assume the deposit fee.

Response

Deposit successfully initiated. The response structure varies based on the checkout type (e.g., HOSTED or ONE_SHOT).