Finance
Finance module provides support for Customer Credit Note for product exchange and storefront System which encompasses a range of services, including accessing customer credit balances and more.
APIs associated with a Customer Credit Note/for product exchange and storefront System encompass a range of services, including accessing customer credit balances and more.
Operations
POST
# This API will provide customer's credit balance against phone number or email and seller*affiliate id
POST
# Lock or Unlock requested credit note.
POST
This API will provide customer's credit balance against phone number or email and seller*affiliate id
This API will provide customer's credit balance against phone number or email and seller*affiliate id
Parameters
No Parameters
Request body
data
object (CustomerCreditBalanceReqData)
oneOf Schema from below
Response
200
400
Success
CustomerCreditBalanceResponseSchema
success
boolean
Indicates whether the credit note balance request was successful.
data
object (CustomerCreditBalanceResData)
CustomerCreditBalanceResData
customer_mobile_number
string
Mobile number of the customer whose credit balance information is being returned.
customer_email
string
Email of the customer whose credit balance information is being returned.
total_credited_balance
number
Total amount of credit available to the customer.
total_locked_amount
number
Total amount of credit balance that is currently locked and unavailable for use.
allowed_redemption_amount
number
Total amount of credit balance that the customer is allowed to redeem.
Examples
Parameters
body:
body
Was this section helpful?
POST
Response
Parameters
No Parameters
Request body
data
object (LockUnlockRequestData)
LockUnlockRequestData
seller_id
integer
Required
The unique identifier for the seller.
affiliate_id
string
Required
The unique identifier of sale channels or application as affiliate_id associated with the seller.
ordering_channel
string
Required
The channel through which the order was placed.
Enum
credit_note_number
string
Required
A unique identifier for the credit note.
amount
number
Required
The total amount of credit originally available in the note.
request_type
string
Required
Type of request for which api is called. Either to lock credit note or unlock.
Enum
order_id
string
Required
A unique identifier of the order against which credit note is generated.
Response
200
400
Success
LockUnlockResponseSchema
success
boolean
Indicates whether the credit note lock/unlock request was successful.
data
object (LockUnlockResponseData)
LockUnlockResponseData
credit_note_number
string
A unique identifier for the credit note.
amount
number
The total amount of credit originally available in the note.
Examples
Parameters
body:
body
Was this section helpful?
POST
Response