Creating an order

Create an order for payment

Creating an order

POSThttps://app.apollopayment.io/api-gateway/make-order

Header parameters

Body

application/json

advancedBalanceId*string

Identifier of the advance balance for writing off commissions

Example: "f9565f73-eb15-4246-9954-169eeb9475fc"

currency*string

Ticker of the coins in which the payment will be made

Example: "USDT"

network*string

The network of the coin in which the payment will be made

Example: "ethereum"

amount*string

Payment amount

Example: "123.12"

paymentTolerancePercentstring

Acceptable underpayment percentage. For example, you created an order for 100 USDT. If the parameter is set to 1.5%, the order will be completed successfully after payment of 98.5 USDT

Example: "1.5"

errorWebhookstring

URL to send webhook on error or order expiration

Example: "https://merchant.domain/webhooks/fail"

successWebhookstring

URL to send webhook on successful payment

Example: "https://merchant.domain/webhooks/success"

returnUrlstring

URL to be placed on the payment page as "Return to Store" links

Example: "https://merchant.domain/"

order*string

Order ID in the merchant system

Example: "Order #123456"

descriptionstring

Order Description

Example: "Payment by order #123456"

lifetime*integer

Order lifetime in seconds, available values from 1800 (30 minutes) to 43200 (12 hours)

checkRisksboolean

Whether to check incoming transactions for this order

externalUserIdstring

The external user ID in your system. When specifying the identifier, the functionality of the "Personal addresses" section will be used - a static address will be reserved for this user, but the webhook will be sent to the URL specified in this request

Example: "10099"

payerEmailstring

Payer's email address. If it is specified alongside with the 'externalUserId' parameter, a user with such an email will be created in the "Personal addresses" section

Example: "[e-mail]"

Response

200

Body

application/json

success*boolean

Request success indicator

response*MakeOrderResponse (object)

Response body when requesting to create an order

Request

JavaScriptCurlPython

const response = await fetch('https://app.apollopayment.io/api-gateway/make-order', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "advancedBalanceId": "f9565f73-eb15-4246-9954-169eeb9475fc",
      "currency": "USDT",
      "network": "ethereum",
      "amount": "123.12",
      "order": "Order #123456",
      "lifetime": 0
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "response": {
    "status": "pending",
    "link": "https://payment.domain/d73adeb9-0d7d-4b4a-8b5d-3e92eac70297",
    "amount": "123.12",
    "paymentTolerancePercent": "1.5",
    "advancedBalanceId": "f9565f73-eb15-4246-9954-169eeb9475fc",
    "currency": "USDT",
    "network": "ethereum",
    "address": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
    "addressId": "21d8a948-5b69-45b9-8a4d-898be4df18e6",
    "tag": null,
    "orderId": "d73adeb9-0d7d-4b4a-8b5d-3e92eac70297",
    "clientOrderId": "Order #123456",
    "externalUserId": "10099",
    "payerEmail": "[e-mail]",
    "description": "Payment by order #123456",
    "successWebhook": "https://merchant.domain/webhooks/success",
    "errorWebhook": "https://merchant.domain/webhooks/fail",
    "returnUrl": "https://merchant.domain/",
    "expiresAt": "2024-12-26T08:51:53.353Z",
    "createdAt": "2024-12-26T08:21:53.353Z"
  }
}