Debit API
POST
services.onlinesales.ai/osBillingServiceV2/marketplace/debit
Request Body
Name | Type | Description |
---|---|---|
String | ||
amount* | Double | The amount for which the transaction is done. The amount should be a non-negative number greater than or equal to 1. |
merchantId* | String | Merchant id of seller/brand. The merchant should be a valid merchant in OS systems |
currency* | String | Currency of the amount specified in the request:Valid currency format : INR, USD, AED Currency cannot be null or empty.Should be a 3 letter valid value. |
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ās side. OS will handle duplicates with this id. valid string. Maximum of 128 characters |
merchantType* | String | Merchant type of the merchant for which the transaction is being carried out. Expected Values (case insensitive) brand OR seller |
transactionTime(epoch time)* | Integer | The time at which the transaction for this merchant took place. The transaction time will be a epoch time (in milliseconds) |
Description | String | description of the transaction if any The description should not be greater than 128 character |
marketplaceClientId* | Integer | Unique client id defined by OS for the marketplace. It will be different for staging and production. Expected Values Shared by OS |
debitType | String | This indicates the type of charge. Should be one of Spend, Commissions. Default Value: Spend |
String |
Request Body
Response Field Description
Field | Data Type | Description |
---|---|---|
clientId | Integer | OS created id for merchant |
merchantId | String | Marketplace merchant id |
merchantType | String | Expected Values (case insensitive) brand OR seller |
id | Integer | OS transaction ID |
partnerTransactionId | String | Transaction ID for this transaction at Marketplaceās side. OS will handle duplicates with this id. valid string. Maximum of 128 characters |
status | String | Status of the request SUCCESS, FAILED details JSON |
details | JSON | Any details regarding the transaction "details": { "error": { "code": "IP0000", "message": "Invalid Parameters Error", "description": [ ā<error message>ā ] } |
marketplaceClientId | Integer | Unique client id defined by OS for the marketplace. It will be different for staging and production. |
Last updated