Batch update order's payments

Update order's payments endpoint supports multiple scenario as followed

Normal order

With normal, the endpoint supports approve or reject on payment slip (attachment) which should be included in your order information

Approve action

Approve payment amount for normal order, system will then send message back to customer with receipt

Example approve request parameter

{

"orderPayments": [

{

"orderNumber": "__ORDER__NUMBER__",

"amount": 100,

"action": "approve",

"paymentAt": "2021-09-20 00:00:00.000000+00",

"paymentBankName": "__PAYMENT_BANK_NAME__",

"paymentMethodType": "BANK_TRANSFER",

"remark": "__REMARK__"

}

]

}

Reject action

Reject payment amount for normal order, system will then send message back to customer requesting for new proof of payment

Example reject request parameter

{

"orderPayments": [

{

"orderNumber": "__ORDER__NUMBER__",

"action": "reject"

}

]

}

Cash on delivery order

With COD, the endpoint supports both approval status of deposit amount and final paymentAmount once customer received packages

Approve action (COD - deposit amount)

Approve deposit amount for COD order, system will then send message back to customer letting them know to that package will be shipped soon

Example approve request parameter

{

"orderPayments": [

{

"orderNumber": "__ORDER__NUMBER__",

"amount": 100,

"action": "approve",

"paymentAt": "2021-09-20 00:00:00.000000+00",

"paymentBankName": "__PAYMENT_BANK_NAME__",

"paymentMethodType": "BANK_TRANSFER",

"remark": "__REMARK__"

}

]

}

Reject action (COD - deposit amount)

Reject payment amount for COD order, system will then send message back to customer requesting for new proof of payment

Example approve request parameter

{

"orderPayments": [

{

"orderNumber": "__ORDER__NUMBER__",

"action": "reject"

}

]

}

Approve action (COD - payment)

Approve payment amount for COD order, system will then send message back to customer with final receipt

Example approve request parameter

{

"orderPayments": [

{

"orderNumber": "__ORDER__NUMBER__",

"amount": 100,

"action": "approve"

}

]

}

Reject action (COD - payment)

Reject COD order, system will then send message back to customer letting them know that they rejected an order

Example approve request parameter

{

"orderPayments": [

{

"orderNumber": "__ORDER__NUMBER__",

"action": "reject"

}

]

}

Endpoint

/v1/orders/payments

Resource method

POST

Parameters

Body parameters

Field name	Types	Required/Optional	Description
orderPayments	list of order payment	R	Order's payments

Order payment information

Maximum number of batch order is 5

Field name	Types	Required/Optional	Description
orderNumber	string(12)	R	Order's number
action	string(10)	R	Action for order payment either 'approve' or 'reject'
amount	number(10)	R	payment amount required for 'approve' action
paymentBankName	string(50)	O	Payment bank name
paymentAt	string(50)	O	Payment at (ISO string)
paymentMethodType	string(50)	O	Payment method type
remark	string(50)	O	Order payment remark

Support payment method type in our system

{

"BANK_TRANSFER": "BANK_TRANSFER", // Bank transfer

"CHILL_PAY_OTHER_METHOD": "CHILL_PAY_OTHER_METHOD", // Chill pay

"CREDIT_CARD_K_BANK": "CREDIT_CARD_K_BANK", // Credit card by K bank

"ELECTRONIC_PAYMENT_LINE_PAY": "ELECTRONIC_PAYMENT_LINE_PAY", // LINE Pay

"PROMPT_PAY": "PROMPT_PAY" // Prompt pay

}

Example payment bank name

Deeple system usually generates payment bank name based on payment method type. But it's just string information which you can send anything. Here are few example from our system when it's generated automatically.

BBL (Bank transfer): XXXXXXXXXX // From BANK_TRANSFER payment method type with "BBL" as bank name and "XXX" as account number

Credit card KBank (2C2P): XXXXX // From CREDIT_CARD_K_BANK payment method type with "2C2P" provider and ref code

Other method (Chill Pay): XXXXXX // From CHILL_PAY_OTHER_METHOD payment method type

Deeple store (HQ) (PromptPay): XXXXXXXXXX // From PROMPT_PAY payment method type with "Prompt Pay" name and number

Example request parameter

{

"orderPayments": [

{

"orderNumber": "__ORDER__NUMBER__",

"amount": 100,

"action": "approve",

"paymentAt": "2021-09-20 00:00:00.000000+00",

"paymentBankName": "__PAYMENT_BANK_NAME__",

"paymentMethodType": "BANK_TRANSFER",

"remark": "__REMARK__"

}

]

}

Example expected response object

200 - OK status code