Skip to main content

Create a deposit order

POST 
/api/v1/order/deposit

Create a new deposit order for a specific integration. This endpoint allows the client to decide how much money they want to deposit into their balance. .

Once the first transaction from the client is detected, the payment is considered complete, and the status is updated to completed after 19 transaction confirmations from the network.

The order is valid for 20 minutes. During this time, the payer must complete the payment.

Request​

Body

Details of the deposit order to create.

    integrationId stringrequired

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    The ID of the integration for which the deposit order is created. Retrieve it from the Retrieve a list of integrations endpoint.

Responses​

Deposit order created successfully.

Schema
    orderId stringrequired

    The unique identifier of the created order.

    paymentLink stringrequired

    The URL to the payment page where the client needs to be redirected to complete the payment.

    widgetCode stringrequired

    The HTML code for embedding the payment widget on your site.

Loading...