UploadOrders

This method is used to upload payment orders to SBR system

Request

Good to know: Please press ">" to see detail.

This method is used to upload payment orders to SBR system.

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

Request Body

Name	Type	Description
AuthID*	Text	User ID assigned by SBR
ProtocolData*	Array	Data request
Reference*	Text	ID of payment order
DelMode	Text(1)	Delivery mode (1;Home;2;Pickup;3;Bank Transfer)
AgentID*	Text(20)	Assigned by SBR, AgentID=UserID=AuthID
CurrencyID*	Text(10)	Currency (USD; EUR; JPY; CAD; VND…)
OrderedAmt*	Number	Amount
Beneficiary*	Text(300)	Beneficiary name
Phone*	Text(50)	Beneficiary phone
IDCardNo	Text(30)	ID card
IssuedOn	Date(yyyy-MM-dd)	Issued date
IssuedBy	Text(300)	Issue on
Address*	Text(500)	Address of beneficiary name
Sender*	Text(300)	Sender name
SenderPhone	Text(50)	Sender phone number
SenderAddress	Text(300)	Address of sender
SenderCountryID	Text(20)	Sender country code
Message	Text	Message from Sender
BankAcctNo	Text(30)	Bank account number of Beneficiary - Required with DelMode=3)
BankName	Text	Bank name of Beneficiary - Required with DelMode=3
BankGroup	Text(1)	Bank mode Sacombank = 1 Napas= 3 Citad =4 eWallet = 7
AccType	Text	Type of account transferring Account Deposit = ACC Pan Depost = PAN Sacombank Pay = PAY ZaloPay = Zalo VNPTPay= VNPTPay

200: OK Success

{
    // Response
}

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

406: Not Acceptable Require signature - Signature incorrect

Response Data

Parameters	Data Type	Description
Status	Number	Return status of request: 0;Fail;1;Success
Error Message	Text	Error description
ProtocolData	Object	List of payments has error

In case you receive a response "400 - Internal server error/Timeout", call the CheckOrderStatus or GetOrderDetail API to check the final status of the transaction. If the result is Payment not found, please re-send the new transaction or cancel on your side. If the result returns the status of the transaction => The transaction has been sent to SBR successfully and the status is compared according to the description of the API CheckOrderStatus or GetOrderDetail

Example: { "Status": 0, "Error": "400 - Internal server error/Timeout", }

Request Example

HomeDelivery

// Request Home Delivery
{
  "AuthID": "123",
  "ProtocolData": [
    {
      "Reference": "REF123456",
      "DelMode": "1",
      "AgentID": "123",
      "CurrencyID": "VND",
      "OrderedAmt": 1000000,
      "Beneficiary": "Beneficiary",
      "Phone": "0934256224",
      "IDCardNo": "1121212121",
      "IssuedOn": "2015-06-21",
      "IssuedBy": "HCM",
      "Address": "Address test",
      "ProvinceID": "HNi",
      "DistrictID": "CAUGIAY",
      "Sender": "Sender test"
    }
  ]
}

Cash Pickup at Sacombank

// Request Cash Pickup at Sacombank
// If BankName is null or Blank => Defaut set pickup at Sacombank
{
  "AuthID": "123",
  "ProtocolData": [
    {
      "Reference": "REF123456",
      "DelMode": "2",
      "AgentID": "123",
      "CurrencyID": "VND",
      "OrderedAmt": 1000000,
      "Beneficiary": "Beneficiary",
      "Phone": "0934256224",
      "IDCardNo": "1121212121",
      "IssuedOn": "2015-06-21",
      "IssuedBy": "HCM",
      "Address": "Address test",
      "ProvinceID": "HNi",
      "DistrictID": "CAUGIAY",
      "Sender": "Sender test",
      "BankName":"Sacombank"
    }
  ]
}

Cashpickup at OtherBank

// Request Cash Pickup at OtherBank
// Pls set BankName
// If BankName is null or Blank => Defaut set pickup at Sacombank
{
  "AuthID": "123",
  "ProtocolData": [
    {
      "Reference": "REF123456",
      "DelMode": "2",
      "AgentID": "123",
      "CurrencyID": "VND",
      "OrderedAmt": 1000000,
      "Beneficiary": "Beneficiary",
      "Phone": "0934256224",
      "IDCardNo": "1121212121",
      "IssuedOn": "2015-06-21",
      "IssuedBy": "HCM",
      "Address": "Address test",
      "ProvinceID": "HNi",
      "DistrictID": "CAUGIAY",
      "Sender": "Sender test",
      "BankName":"Agribank"
    }
  ]
}

Sacombank Deposit with Account Number

// Request Sacmbank Deposit with Account Number
{
  "AuthID": "123",
  "ProtocolData": [
    {
      "Reference": "REF123456",
      "DelMode": "3",
      "CurrencyID": "VND",
      "OrderedAmt": 10000,
      "AgentID": "123",
      "Beneficiary": "Beneficiary Name",
      "Phone": "123456789",
      "IDCardNo": "",
      "IssuedOn": "",
      "IssuedBy": "",
      "Address": "Vietnam",
      "Sender": "Sender Name",
      "SenderPhone": "",
      "SenderAddress": "Sender Address",
      "SenderCountryID": "JP",
      "BankAcctNo": "1234567890",
      "BankName": "Sacombank",
      "BankGroup": "1",
      "AccType": "ACC"
    }
  ]
}

Napas Deposit with PAN Number

// Request Napas Deposit with PAN Number
{
  "AuthID": "123",
  "ProtocolData": [
    {
      "Reference": "REF123456",
      "DelMode": "3",
      "CurrencyID": "VND",
      "OrderedAmt": 10000,
      "AgentID": "123",
      "Beneficiary": "Beneficiary Name",
      "Phone": "123456789",
      "IDCardNo": "",
      "IssuedOn": "",
      "IssuedBy": "",
      "Address": "Vietnam",
      "Sender": "Sender Name",
      "SenderPhone": "",
      "SenderAddress": "Sender Address",
      "SenderCountryID": "JP",
      "BankAcctNo": "1234567890",
      "BankName": "Dong A Bank",
      "BankGroup": "3",
      "AccType": "PAN"
    }
  ]
}

CITAD transfer

// Request CITAD transfer - BankName = BankName + "CTIAD"
{
  "AuthID": "123",
  "ProtocolData": [
    {
      "Reference": "REF123456",
      "DelMode": "3",
      "CurrencyID": "VND",
      "OrderedAmt": 10000,
      "AgentID": "123",
      "Beneficiary": "Beneficiary Name",
      "Phone": "123456789",
      "IDCardNo": "",
      "IssuedOn": "",
      "IssuedBy": "",
      "Address": "Vietnam",
      "Sender": "Sender Name",
      "SenderPhone": "",
      "SenderAddress": "Sender Address",
      "SenderCountryID": "JP",
      "BankAcctNo": "1234567890",
      "BankName": "Dong A Bank CTIAD"
    }
  ]
}

// Request CITAD transfer - BankGroup= 4
{
  "AuthID": "123",
  "ProtocolData": [
    {
      "Reference": "REF123456",
      "DelMode": "3",
      "CurrencyID": "VND",
      "OrderedAmt": 10000,
      "AgentID": "123",
      "Beneficiary": "Beneficiary Name",
      "Phone": "123456789",
      "IDCardNo": "",
      "IssuedOn": "",
      "IssuedBy": "",
      "Address": "Vietnam",
      "Sender": "Sender Name",
      "SenderPhone": "",
      "SenderAddress": "Sender Address",
      "SenderCountryID": "JP",
      "BankAcctNo": "1234567890",
      "BankName": "Dong A Bank",
      "BankGroup":"4"
    }
  ]
}

Sacombank Pay eWallet

// Request Sacombank Pay eWallet
{
  "AuthID": "123",
  "ProtocolData": [
    {
      "Reference": "REF123456",
      "DelMode": "3",
      "CurrencyID": "VND",
      "OrderedAmt": 10000,
      "AgentID": "123",
      "Beneficiary": "Beneficiary Name",
      "Phone": "0912345678",
      "IDCardNo": "",
      "IssuedOn": "",
      "IssuedBy": "",
      "Address": "Vietnam",
      "Sender": "Sender Name",
      "SenderPhone": "",
      "SenderAddress": "Sender Address",
      "SenderCountryID": "JP",
      "BankAcctNo": "1234567890",
      "BankName": "Sacombank",
      "BankGroup": "1",
      "AccType": "PAY"
    }
  ]
}

ZaloPay

// Request Zalo Pay
{
  "AuthID": "123",
  "ProtocolData": [
    {
      "Reference": "REF123456",
      "DelMode": "3",
      "CurrencyID": "VND",
      "OrderedAmt": 10000,
      "AgentID": "123",
      "Beneficiary": "Beneficiary Name",
      "Phone": "0912345678",
      "Address": "Vietnam",
      "Sender": "Sender Name",
      "SenderPhone": "",
      "SenderAddress": "Sender Address",
      "SenderCountryID": "JP",
      "BankAcctNo": "1234567890",
      "BankName": "Zalo or ZaloPay",
      "BankGroup": "7",
      "AccType": "Zalo"
    }
  ]
}

Response Example

Order is error

//#1 Order is error: AgentID is not null! / AgentID() not equal User(123)!:
{
  "Status": 0,
  "Error": "Orders is error!",
  "ProtocolData": [
    {
      "Error": "AgentID is not null!\r\nAgentID() not equal User(123)!\r\n",
      "Data": {
        "Reference": "REF00000007",
        "DelMode": "1",
        "AgentID": "",
        "CurrencyID": "VND",
        "OrderedAmt": 1000000,
        "Beneficiary": "Beneficiary",
        "Phone": "123456789",
        "IDCardNo": "123456789",
        "IssuedOn": "2015-06-21",
        "IssuedBy": "HCM",
        "Address": "Address test",
        "ProvinceID": "HNi",
        "DistrictID": "CAUGIAY",
        "Sender": "Sender test"
      }
    }
  ]
}

Service error/timeout

{
    "Error": "Internal server error! Execution Timeout Expired. The timeout period elapsed prior to completion of the operation or the server is not responding",
    "Data": {
      "Reference": "REF123456",
      "DelMode": "3",
      "CurrencyID": "VND",
      "OrderedAmt": 10000,
      "AgentID": "123",
      "Beneficiary": "Beneficiary Test",
      "Phone": "123456789",
      "IDCardNo": "",
      "IssuedOn": "",
      "IssuedBy": "",
      "Address": "Vietnam",
      "Sender": "Sender Test",
      "BankAcctNo": "123456789",
      "BankName": "Sacombank"
    }
  }

Success

{
  "Status": 1,
  "Error": ""
}