IBitPay
🌐English
  • 🌐繁體中文
  • 🌐English
    IBitPay
    🌐English
    • 🌐繁體中文
    • 🌐English
    • IBitPay OpenApi Document Center
    • Encryption and Decryption
    • Callback
    • Global Error Codes
    • Sample Code
    • OpenApi
      • Create Buy Order
        POST
      • Get Buy Rate
        POST
      • Get Balance
        POST
      • Create Sell Order
        POST
      • Get Sell Rate
        POST
    • Schemas
      • 示例数据模型
        • Pet
        • Category
        • Tag
      • Schemas
        • ApiResult
        • ApplyTakenParamerter
        • ApplyWithdrawalParamerter
        • AssetFlowDto
        • AssetFlowDtoPageData
        • AssetFlowDtoPageDataApiResults
        • AssetsItem
        • BalanceViewDto
        • BalanceViewDtoApiResults
        • BankDto
        • BankEditDto
        • BankId
        • BasePageParameter
        • CalculateFeesDto
        • CalculateFeesDtoApiResults
        • CalculateFeesParamerter
        • ChangeWalletPasswordParameter
        • CreateBuyOrderInput
        • DepositOrderDto
        • CreateOrderInput
        • CreateSellOrderInput
        • DepositOrderDtoPageData
        • DepositOrderDtoPageDataApiResults
        • DepositeQueryParamerter
        • EnumItem
        • EnumItemListApiResults
        • FlowQueryParamerter
        • ForgetLoginPasswordParammeter
        • ForgetWalletPasswordParammeter
        • FundsViewDto
        • FundsViewDtoApiResults
        • IBPUser
        • IBPUserApi
        • IBPUserAssets
        • IBPUserBankCard
        • IBPUserBankCardListApiResults
        • IBPUserIdentity
        • IBPUserWalletAddress
        • IBPUserWalletAddressListApiResults
        • IBPUserWithdrawal
        • IBPUserWithdrawalPageData
        • IBPUserWithdrawalPageDataApiResults
        • InitWalletPasswordParameter
        • MerchantAPiKeyResult
        • MerchantAPiKeyResultApiResults
        • MerchantRegistionDto
        • MerchantWalletAddressAddDto
        • MerchantWalletAddressDeleteDto
        • MerchantWalletAddressEditDto
        • MerchantsApiDto
        • MerchantsApiDtoApiResults
        • MerchantsAssetsItem
        • MerchantsFreezeDto
        • MerchantsFreezeDtoPageData
        • MerchantsFreezeDtoPageDataApiResults
        • MerchantsInfoDto
        • MerchantsInfoDtoApiResults
        • MerchantsLoginParamerter
        • MerchantsTakenDto
        • MerchantsTakenDtoPageData
        • MerchantsTakenDtoPageDataApiResults
        • MerchantsVerificationCodeParameter
        • PostDepositInfo
        • PostRealNameParameter
        • SaleAd
        • SaleAdOrder
        • SaleAdOrderDto
        • SaleAdOrderPayment
        • SaleAdOrderPaymentDto
        • TakenViewDto
        • TakenViewDtoApiResults
        • TestCreateOrder
        • TranReport
        • TranReportApiResults
        • TwoFactorDto
        • TwoFactorDtoApiResults
        • UpdateLoginPasswordParammeter
        • UpdateSecurityParammeter
        • VerifyAuthenticatorParam
        • VerifyPasswordParamerter
        • ViewApiKeyRequest
        • WeekTranData
        • WeekTranDataItem
        • WithdrawalQueryParamerter
        • WithdrawalTemplateDto
        • WithdrawalTemplateDtoApiResults

    Callback

    Callback Notification
    When a deposit order or withdrawal order is successfully processed, the system will initiate a callback request to the merchant’s preconfigured callback endpoint for notification.
    1.
    Request Method: POST
    2.
    Parameter Format: JSON

    3. Parameters:#

    Parameter NameTypeDescription
    OrderNostringOrder ID
    MerchantNostringMerchant ID
    MerchantOrderNostringMerchant Order ID
    PayTimestringPayment timestamp
    StateintState(withdrawal order only, succes=4,refuse=5 )

    4. Examples:#

    Encrypted parameters (pre-decryption)
    {
      "encryptedData": "BQDDdGq...(Base64 string)"
    }
    Decrypted parameters
    {
      "OrderNo": "123",
      "MerchantNo": "456",
      "MerchantOrderNo": "no123",
      "PayTime": "2025-01-01 12:00:00"
    }

    5. Response:#

    {  
        "code": 200  
    }
    or
    success

    6. Notes:#

    Merchants must return {"code":200} or the string "success" upon receiving notifications. Failure to do so will be interpreted as an unsuccessful notification delivery, triggering the following retry strategy:
    15s‒3m‒10m‒30m‒1h‒2h‒6h‒15h (15 seconds, 3 minutes, 10 minutes, 30 minutes, 1 hour, 2 hours, 6 hours, 15 hours).
    If no successful response is received within the retry period, the merchant’s service will be deemed abnormal. Notification for this order will be terminated, and the order status can be queried on the Merchant Portal.
    Asynchronous notifications only occur after successful order completion. Thus, notification failure does not indicate payment failure.
    Modified at 2025-09-15 02:07:18
    Previous
    Encryption and Decryption
    Next
    Global Error Codes
    Built with