GetOrderDetails

This method is used to get orders details.

Good to know: Press ">" to see detail.

Request

This method is used to get orders details.

POST https://{SERVER}/Api/SBR/GetOrderDetails

Request Body

Name	Type	Description
AuthID*	Text	UserID assigned by SBR
ProtocolData*	Object	Data request
Reference*	Text	ID of payment order
StatusType*	Text(1)	Status of request (Default =1)

200: OK Success

{
    // Response
}

401: Unauthorized Invalid username or password. Please try again!

{
    // Response
}

406: Not Acceptable Require signature - Signature incorrect

{
    // Response
}

Response

Parameters	Data type	Description
Status	Number	Return status of request: 0;Fail;1;Success
ProtocolData	Object	List of orders
OrderNo	Text	SBR’s TransactionID
OrderDate	Date(yyyy-MM-dd)	Date of transaction
Reference	Text	ID of payment order from Agent
ReferenceDate	Date(yyyy-MM-dd)	Agent Date of transaction
DelMode	Text(1)	Delivery mode (1;Home delivery;2;Pickup;3;Bank transfer)
AgentID	Text(20)	ID of Agent
CurrencyID	Text(20)	Currency (USD;EUR;JPY;CAD;VND…)
OrderedAmt	Number	Amount
Beneficiary	Text(300)	Beneficiary name
Phone	Text(50)	Phone number
IDCardNo	Text(50)	ID card
IssuedOn	Date (yyyy-MM-dd)	Issued date
IssuedBy	Text(300)	Issued by
Address	Text(300)	Address of beneficiary name
ProvinceID	Text(20)	Provice code
DistrictID	Text(20)	District code
Sender	Text(300)	Sender name
BankAcctNo	Text	Bank account number of Beneficiary
BankName	Text	Bank name of Beneficiary
CancelStatus	Text	Showing whether transaction is cancelled
Note	Text	Note from SBR (EX: Wrong phone number, please kindly amend)
FeedbackDate	Date (yyyy-MM-dd H:i:s)	Day of payment (DelMode=1 - Home Delivery)
PayUpdated	Date (yyyy-MM-dd H:i:s)	Day of payment (DelMode=2 -Cash pickup & DelMode=3 -Bank Transfer)
AMLStatus	Text	AML Status (0: New; 1: AML processing; 2: 3: Suspect; 4: Pass)
ErrorLog	Text	Error code for bank transfer (EX: 101 - Transaction timeout, 110 - Transaction fail, 120 – Suspect, 118 - Transaction is processing, 114 - Refer to card issuer,…)
Status	Text	Status of orders (1: New; 2: Canceled; 3: Paid; 4: Processing)

Request Example

Example

//Please set default: StatusType=1
{
  "AuthID": “123”,
  "ProtocolData": {
    "Reference": "REF123456",
    "StatusType": "1"
  }
}

Response Example

Success

{
  "Status": 1,
  "ProtocolData": {
    "Count": 1,
    "Data": [
      {
        "OrderNo": "20420061600002",
        "OrderDate": "2020-06-16T00:00:00+07:00",
        "OrderedAmt": 3000000.0,
        "CurrencyID": "VND",
        "Reference": "APP00001",
        "ReferenceDate": "2020-06-16T19:45:53.857+07:00",
        "DelMode": "3",
        "AgentID": "204",
        "Sender": "Sender test",
        "Beneficiary": "Beneficiary 33",
        "IDCardNo": "11223333",
        "IssuedOn": "2015-06-23T00:00:00+07:00",
        "IssuedBy": "HCM",
        "Phone": "09322233333",
        "Address": "Address test",
        "ProvinceID": "HNi",
        "DistrictID": "CAUGIAY",
        "CancelStatus": "",
        "Fees": 0.0,
        "Memo2": null,
        "Note": null,
        "FeedbackDate": null,
        "PayUpdated": null,
        "AMLStatus": "0",
        "ErrorLog": "110 - Transaction failed",
        "Status": "4"
      }
    ]
  }
}

Success with no return

{
  "Status": 1,
  "ProtocolData": {
    "Count": 0,
    "Data": [],
  }
}