Charge Status API

GET https://services.onlinesales.ai/osBillingServiceV2/marketplace/chargeStatus

Query Parameters

Name	Type	Description
token*	String	Valid app token shared by Onlinesales.ai *note: do not use this token in any application on the client side.
partnerTransactionId*	String	Transaction id for this transaction at marketplace side. OS will handle duplicates with this id valid string. Maximum of 128 characters
marketplaceClientId*	Integer	Unique client id defined by OS for marketplace. It will be different for staging and production. Expected Values Shared by OS
merchantId*	String	Marketplace merchant Id

200: OK

{
    "clientId": 92172,
    "marketplaceClientId": <Marketplace Client Id>,
    "merchantId": "KAKASJ-123",
    "partnerTransactionId": "87645364",   
    "id": 2434, // transaction id generated by OS  
    "status" : "SUCCESS" 
    "details" : {}
}

Request Body

{
    "partnerTransactionId": "87645364",    
    "marketplaceClientId":<Marketplace Client Id>, 
    "token": <token>,  //token shared by onlinesales.  
    "merchantId": <merchant id>
}

Sample Request

curl --location --request GET 
'https://services.onlinesales.ai/osBillingServiceV2/marketplace/chargeStatus?
partnerTransactionId=1632750004000&marketplaceClientId=110600&token=376eae4b770b0efe50b6242bfd4aac47
&merchantId=APS-18826'

Response Field

Field	Data Type	Description
clientId	Integer	OS created id for merchants
merchantId	String	Marketplace merchant Id
merchantType	String	Expected Values (case insensitive) brand OR seller
id	Integer	OS transaction id
status	String	Status of the request SUCCESS, FAILED
partnerTransactionId	String	Transaction id for this transaction at marketplace side. OS will handle duplicates with this id
marketplaceClientId	Integer	Unique client id defined by OS for marketplace. It will be different for staging and production.
details	JSON	Any details regarding the transaction "details": { "error": { "code": "IP0000", "message": "Invalid Parameters Error", "description": [ ""value" must contain at least one of [token, merchantId]" ] }