Sign in

v1

latestOpenAPI 3.0.02026-07-26355499.1 KB
Deposits

Retrieve Deposit Status

Retrieve the status of a previously created deposit. This endpoint allows you to retrieve the status of a deposit request.

get/deposits/{deposit_id}

Path parameters

deposit_idinteger required

Directa24 deposit_id. It is obtained when creating the deposit.

Headers

Content-Typestring required

Media type of the body sent to the API. (Note: For GET, typically no request body)

X-Datestring date-time required

ISO8601 Datetime with Timezone. Example: 2020-06-24T17:13:21Z

X-Loginstring required

Merchant X-Login API Key

Authorizationstring required

Authentication signature hash

X-Idempotency-Keystring

Unique idempotency key for ensuring that the same request is not processed more than once. (Typically for state-changing requests)

Response

Deposit status successfully retrieved

user_idstring

ID generated for the user on D24 end

deposit_idinteger

ID of the deposit on D24 end

subscription_idinteger nullable

ID of the Subscription that triggered the deposit

invoice_idstring

ID of the deposit on the merchant end

countrystring nullable

Country ISO code

currencystring

Local currency code

local_amountnumber float nullable

Amount in local currency

usd_amountnumber float nullable

Amount in USD

amountnumber float nullable

Amount in local currency (may appear in PENDING/CREATED status responses; prefer 'local_amount' or 'usd_amount' where available)

bonus_amountnumber float nullable

The amount specified as bonus in the request

bonus_relativeboolean nullable

Specifies if the bonus_amount is absolute or relative. Only shown if bonus_amount is not null.

payment_methodstring nullable

Payment method code specified on the deposit request or selected by the user. Only shown if payment method is selected.

payment_typestring nullable

Type of the payment method. Only shown if payment method is selected.

status'COMPLETED' | 'PENDING' | 'CREATED' | 'DECLINED' | 'CANCELLED' | 'EXPIRED' | 'EARLY_RELEASED' | 'FOR_REVIEW'

Status of the deposit

fee_amountnumber float nullable

Fee of the deposit in the currency of your balance. Only shown if payment_method was sent or selected.

fee_currencystring nullable

Currency of your balance. Only shown if payment_method was sent or selected.

refundedboolean nullable

Shows if the deposit was refunded or not

current_payer_verification'MATCH' | 'UNMATCH' | 'NO_CLIENT_DOCUMENT' | 'NO_CURRENT_PAYER_DATA' nullable

Shows if the current payer is the same person who creates the deposit. Only shown if not null.

completed_payment_method_codestring nullable

Payment method used by the client to complete the transaction