Skip to main content

Retrieve Order Details

Overview​

This interface allows merchants to retrieve detailed results of bank card transfer transactions. It provides comprehensive information about the transfer status, payment details, and transaction metadata.

API URL​

Request​

HTTP Headers​

Attributes

  • Content-Language String

    • The language in which the response message will be used, currently only English is supported.
    • Example value: en
    • Maximum length: 10

  • Content-Type String Required

    • The media type. Required for operations with a request body. The value is application/<format>, where format is json.
    • Example value: application/json

  • sign String Required

    Requests should be signed using private-key cryptography. This allows the payment gateway to verify that an incoming request is really from your application.

  • Partner-Id String Required

    • The merchant id of your account.
    • Example value: 200001200101
    • Maximum length: 12
|

HTTP Body​

  • Request Time

    • Parameter Name: requestTime
    • Required: Required
    • Type: Timestamp(3)
    • Example: 1581493898000
    • Description: Request timestamp in milliseconds

  • Business Content

    • Parameter Name: bizContent
      • Merchant Order Number
        • Parameter Name: merchantOrderNo
        • Required: Required
        • Type: String(64)
        • Example: Me23484
        • Description: Unique order identifier from merchant system
    • Required: Required
    • Type: GetTransferToBankOrderRequest
    • Example: -
    • Description: Business-specific request content

Request Sample​

HTTP Headers​

{
    "Content-Language": "en",
    "Content-Type": "application/json",
    "Partner-Id": "200000018128",
    "sign": "RXF8WmC67QSnr62l3oU33fjpUvAo6Yrgvk05c/vYLtmHRGMoAH4qSnap2pto3mY7KgyP5wkNUsyQXJ/ZwbfccSONLb5zA7Z7q74IsOwdJw3BKXxVWr4tfjkA02Pfcp0cZWjE/Y8jTcbtgdc5VI90LNmkgPWbrSlDbNW8p3NlhnKg+Xfl95SgMBPF9afttsU/2a5jLnZXSVcXoSthxpJ6XkZwd45+jhOjBguT+IC8uLVSNRvwDisRGgf9PYv39OH6ITEhbY2sgjkdzBZBOZlt7awy2vkMEsePsuafwrNhuz7xzjj55PzNzk8+zCUu/791OhC/eFUyGimtDw5mX9cyQw=="
}

HTTP Body​

{
    "body": {
        "bizContent": {
            "merchantOrderNo": "M536433721888"
        },
        "requestTime": 1585142880000
    }
}

Response​

HTTP Header​

Attributes

  • Request Status

    • Variable Name: applyStatus
    • Required: Yes
    • Type: String(16)
    • Example: SUCCESS
    • Description:
      • SUCCESS – Application successful
      • FAIL – Application failed
      • ERROR – Exception occurred

  • Return Error Code

    • Variable Name: code
    • Required: Yes
    • Type: String(10)
    • Example: 0
    • Description: Return code

  • Return Message

    • Variable Name: msg
    • Required: No
    • Type: String(200)
    • Example: -
    • Description: Return message

HTTP Body​

Attributes

TransferBankCardOrder

  • Request Time (requestTime)

    • Required: Yes
    • Type: Timestamp(3)
    • Example: 1581493898000

  • Merchant Order Number (merchantOrderNo)

    • Required: Yes
    • Type: String(64)
    • Example: S10000

  • PayBy Order Number (orderNo)

    • Required: Yes
    • Type: String(32)
    • Example: O1000

  • Product Name (product)

    • Required: Yes
    • Type: String(200)
    • Example: Transfer Bank Card

  • Order Status (status)

    • Required: Yes
    • Type: String
    • Example: CREATED, SUCCESS, FAILURE, BANK_FAIL
    • Description: The status of order

  • Amount (amount)

    • Required: Yes
    • Type: Money

  • Account Holder Type (accountHolderType)

    • Required: Yes
    • Type: String(16)
    • Example: INDIVIDUAL
    • Description: INDIVIDUAL or CORPORATE

  • First Name (firstName)

    • Required: Optional
    • Type: String(200)
    • Description: SHA256 of original text, required if INDIVIDUAL

  • Last Name (lastName)

    • Required: Optional
    • Type: String(200)
    • Description: SHA256 of original text, required if INDIVIDUAL

  • Middle Name (middleName)

    • Required: Optional
    • Type: String(200)
    • Description: SHA256 of original text

  • Company Name (companyName)

    • Required: Optional
    • Type: String(200)
    • Description: SHA256 of original text, required if CORPORATE

  • Card Number (cardNumber)

    • Required: Yes
    • Type: String(64)
    • Description: SHA256 of original text

  • Expiry Month (expiryMonth)

    • Required: Yes
    • Type: String(2)
    • Example: 09
    • Description: The card's expiration month of the expiration year. The number must between 1 and 12, and the year + month should be larger or equal to current month.

  • Expiry Year (expiryYear)

    • Required: Yes
    • Type: String(4)
    • Example: 2027
    • Description: The card's expiration year

  • Payment Memo (memo)

    • Required: Optional
    • Type: String(128)
    • Example: Bonus

  • Notification URL (notifyUrl)

    • Required: Optional
    • Type: String(200)
    • Example: http://yoursite.com/api/notification
    • Description: The URL where the merchant receives notifications

  • Failure Description (failDes)

    • Required: Optional
    • Type: String(200)
    • Example: -
    • Description: Cause of order failure

  • Bank Reference Number (bankReference)

    • Required: Optional
    • Type: String(128)

  • Payer Fee Amount (payerFeeAmount)

    • Required: Yes
    • Type: Money
    • Example: { "amount": 0, "currency": "AED" },
    • Description: The fee paid by the payer

  • Fee Payer ID (payerFeeMemberId)

    • Required: Yes
    • Type: String(32)
    • Example: 200000429066
    • Description: ID of the party paying the fee

  • Payment Time (paidTime)

    • Required: Yes
    • Type: Date
    • Description: Time of deduction

  • Refund Time (refundedTime)

    • Required: Optional
    • Type: Date
    • Description: Time of refund

Response Sample​

HTTP Headers​

{
    "sign": "Yv+C2lOQmfERdm5GF9b2V4Y98HmX/6CFyconeOW36AoPqcb7InRcP9E5GnvJLfMoCScuNP4FBdJ5tJpL0A7yPHUMfxARi05jFRSMG97JJazDbWTbRkNM1ZupmTubhUvxvRCgvJp1k0c5yrHph+F+++W5eYho92xnkNgd62BS27i0iDRGzGSmsaPpK7MFcdlvnbbnmDZZJ0LH6RhYiJLYKl+znllQx3jNfCRjV28o22FZ35Q43mZTsS4uAZWbZ/KfaqWoV3sN62Cjj8DSg3mD6GCGWSVbxLq58DUxAq+6GwJ7Gj0Dc9nMXP3gnFW7dodQ9AjL2iHnH6Zh1Pw2D5/ung=="
}

HTTP Body​

{
    "body": {
        "transferToBankCard": {
            "amount": {
                "amount": 0.1,
                "currency": "AED"
            },
            "partnerId": "200000429066",
            "notifyUrl": "http://yoursite.com/api/notification",
            "memo": "Bonus",
            "createdTime": 1741917501666,
            "payerFeeAmount": {
                "amount": 0,
                "currency": "AED"
            },
            "payerFeeMemberId": "200000429066",
            "orderNo": "131741917501042130",
            "merchantOrderNo": "7a5b47a4-1824-4a4d-b581-9b0ebd5dd436",
            "product": "Transfer Bank Card",
            "status": "CREATED",
            "paidTime": 1741917502000,
            "accountHolderType": "INDIVIDUAL",
            "cardNumber": "6b59af6dcc4fb841d5f053a852ed917fd5eecad0cc2c3e3507540c065f520a4c",
            "expiryMonth": "08",
            "expiryYear": "2028",
            "firstName": "c6f27629d041725bb227a0d718641d220d69356cd82b3b7230f1d0dff950de5f",
            "lastName": "15d6dacb4fbda825195e5873c175a9b093daa32345c708ac18411365f6fc6038",
            "middleName": "15d6dacb4fbda825195e5873c175a9b093daa32345c708ac18411365f6fc6038"
        }
    },
    "head": {
        "applyStatus": "SUCCESS",
        "code": "0",
        "msg": "SUCCESS",
        "traceCode": "974825"
    }
}

Response Codes​

CodeMessageCauseWorkaround
0SUCCESSRequest processed successfully-
400INVALID_PARAMETERInvalid request parametersReview and correct request parameters
400REQUESTTIME_TOO_EARLYRequest time is too early compared to current timeAdjust request timestamp
400REQUESTTIME_TOO_LATERRequest time is too late compared to current timeAdjust request timestamp
402RATE_LIMIT_REJECTRequest frequency exceeds allowed limitReduce request frequency
403UNAUTHORIZEDAPI access not authorizedContact PayBy for authorization
404SERVICE_NOT_AVAILABLEAPI service is unavailableContact PayBy support
500SYSTEM_ERRORInternal system errorContact PayBy support and retry later
504SERVICE_TIMEOUTService request timeoutRetry the request
601RISK_FAILRisk control validation failedReview and adjust business parameters
62004MERCHANT_ORDER_NO_NOT_EXISTMerchant order number does not existVerify and correct merchant order number