Skip to content

CustomerCreditHistory_Insert#


Description#

This function allows you to add customer credit to a customer account. This function takes one of three input parameters to identify the customer: Customer_ID, Customer_Login, or Edit_Customer.

Request Body Parameters#

Parameter
Type Description
customer_id
edit_customer
customer_login
Number
String
String
The customer id
The customer login
The customer login
Amount Number Positive amount of credit to add to the customer account
Description Number Credit Description
TransactionReference Number Optional Value to link the credit to a specific order number

Response Parameters#

Parameter
Type Description
success Boolean Boolean Value if the request was successful

Example Request#

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "CustomerCreditHistory_Insert",
    "Customer_Login": "bheyde",
    "Amount": "10.50",
    "Description": "Credit For Order 12345",
    "TransactionReference": "12345"
}

Example Response#

{
    "success": 1
}