Payment UCOF

Process

Merchant sends a request to Baokim to create a UCOF payment transaction

API Information

Method: POST

URL:

Request

Main Parameters

No	Field Name	Data Type	Required	Description
1	request_id	String(100)	✅	Unique request ID
2	request_time	String(20)	✅	Request send time. Format: YYYY-MM-DD H:i:s
3	master_merchant_code	String(50)	✅	Unique identifier for master merchant
4	sub_merchant_code	String(50)	✅	Unique identifier for sub merchant
5	amount	Number	✅	Order amount
6	card	Object	✅	Contains card_token
7	url_success	String(255)	✅	URL Baokim redirect to on successful authentication
8	extend	Object	❌	Extended data

Card Information

No.	Field Name	Data Type	Required	Description
1	card_token	String(255)	✅	Card token

Extend Information

No.	Field Name	Data Type	Required	Description
1	billing	Object	❌	Payer information

Extend.billing Information

No.	Field Name	Data Type	Required	Description
1	firstname	String(255)	❌	Payer first name
2	lastname	String(255)	❌	Payer last name
3	address	String(500)	❌	Payer address
4	city	String(50)	❌	City (Example: HANOI)
5	state	String(255)	❌	State/Province
6	country	String(2)	❌	Country ISO2 (Example: VN)
7	email	String(255)	❌	Payer email
8	phone	String(10)	❌	Phone number
9	postal_code	String(6)	❌	Postal code

{
"request_id":"MERCHANT050015588AXE00",
"request_time":" 2020-08-11 14:41:00 ",
"master_merchant_code": "MASTER_MERCHANT",
"sub_merchant_code": "SUB_MERCHANT",
"amount": 20000,
"card": {
"card_token": "4b92221b0216e488d3eb2a0a75a30f30171f231f5164f82b9395f57726392ff2",
},
"extend": {
  "billing": {
    "firstname": "A",
    "lastname":  "NGUYEN VAN",
    "address":  "313 Truong Chinh, Dong Da",
    "city":  "HANOI",
    "state":  null,
    "country":  "VN",
    "email":  "[email protected]",
    "phone":  "0394899999",
    "postal_code":  "10000",
    }
  }
}

Response

Main Parameters Table

No.	Field Name	Data Type	Required	Description
1	code	Number(3)	✅	Baokim error code
2	message	String(200)	✅	Baokim error message
3	data	Object	✅	Data returned by Baokim

Card Information

No.	Field Name	Data Type	Required	Description
1	order_code	String	✅	Baokim order code
2	amount	Number	✅	Order amount
3	status	Number	✅	Order status
4	created_at	Datetime	✅	Creation time
5	updated_at	Datetime	✅	Update time

{
  "code": 0,
  "message": "Success",
  "data": {
    "order_code": "VLAD_1753867524",
    "amount": 1000000,
    "status": 1,
    "created_at": "2020-08-11 14:41:00",
    "updated_at": "2020-08-11 15:41:00"
  }
}

Error Code Table

Error Code	Description
100	Success
11	Failed
101	Baokim system error
104	OAuth authentication error
105	Signature authentication error
422	Validation error: RequestId invalid
422	Validation error: RequestTime invalid
422	Validation error: PartnerCode invalid
422	Card_data invalid
422	Amount invalid
301	Order not found by order_code
302	Card issue (does not exist, expired)
303	Card declined
304	Insufficient card balance
305	User cancelled transaction
306	Incorrect OTP
308	Transaction has not completed Authentication
309	Transaction has not completed Authorization
310	Transaction already reversed — cannot capture
311	Transaction already captured — cannot reverse
313	Bank-side processing error