POST PPOB/OpenPayment
Request Information
URI Parameters
None.
Body Parameters
PPOBOpenPaymentRequestName | Description | Type | Additional information |
---|---|---|---|
billingReferenceID | string |
None. |
|
productCode | string |
None. |
|
customerID | string |
None. |
|
customerMSISDN | string |
None. |
|
agentPayment | decimal number |
None. |
|
userID |
user API |
string |
None. |
accessToken |
access code getting from login |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "billingReferenceID": "sample string 1", "productCode": "sample string 2", "customerID": "sample string 3", "customerMSISDN": "sample string 4", "agentPayment": 5.0, "userID": "sample string 6", "accessToken": "sample string 7" }
application/xml, text/xml
Sample:
<PPOBOpenPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models"> <accessToken>sample string 7</accessToken> <userID>sample string 6</userID> <agentPayment>5</agentPayment> <billingReferenceID>sample string 1</billingReferenceID> <customerID>sample string 3</customerID> <customerMSISDN>sample string 4</customerMSISDN> <productCode>sample string 2</productCode> </PPOBOpenPaymentRequest>
Response Information
Resource Description
PPOBOpenPaymentResponseName | Description | Type | Additional information |
---|---|---|---|
additionalMessage | string |
None. |
|
productCode | string |
None. |
|
customerID | string |
None. |
|
customerName | string |
None. |
|
period | string |
None. |
|
billingReferenceID | string |
None. |
|
sellPrice | decimal number |
None. |
|
cashBackProfit | decimal number |
None. |
|
transactionStatus | string |
None. |
|
respTime |
describe time in sending response |
date |
None. |
userID |
user ID to access API |
string |
None. |
accessToken |
access token that needed to access API |
string |
None. |
status |
SUCCESS or FAILED |
string |
None. |
respMessage |
detail message of response status |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "additionalMessage": "sample string 1", "productCode": "sample string 2", "customerID": "sample string 3", "customerName": "sample string 4", "period": "sample string 5", "billingReferenceID": "sample string 6", "sellPrice": 7.0, "cashBackProfit": 8.0, "transactionStatus": "sample string 9", "respTime": "2025-01-22T22:39:43.745362+07:00", "userID": "sample string 11", "accessToken": "sample string 12", "status": "sample string 13", "respMessage": "sample string 14" }
application/xml, text/xml
Sample:
<PPOBOpenPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models"> <accessToken>sample string 12</accessToken> <respMessage>sample string 14</respMessage> <respTime>2025-01-22T22:39:43.745362+07:00</respTime> <status>sample string 13</status> <userID>sample string 11</userID> <additionalMessage>sample string 1</additionalMessage> <billingReferenceID>sample string 6</billingReferenceID> <cashBackProfit>8</cashBackProfit> <customerID>sample string 3</customerID> <customerName>sample string 4</customerName> <period>sample string 5</period> <productCode>sample string 2</productCode> <sellPrice>7</sellPrice> <transactionStatus>sample string 9</transactionStatus> </PPOBOpenPaymentResponse>