redeem_points_transaction
POST /redeem_points_transaction
To create a redeem points transactions and updating the customer points balance with the new value after the redemption transaction.
{
"api_credentials": {
"token": "XXXX"
},
"redeem_points_transaction": {
"customer_code_365": "10000322",
"transaction_date_utc0": "2024-09-09 12:56:00",
"document_type": "Voucher",
"document_number": "V09092024001",
"billing_amount": 30.00,
"number_of_points_redeemed": 300,
"loyalty_schema_code_365": "V10",
"comments": "here some additional comments of the transaction"
}
}
| field |
type |
description |
| api_credentials
|
| token |
string |
Credentials provided by Powersoft that allow access to the API |
| redeem_points_transaction
|
| customer_code_365 |
string |
The code of the customer in 365. Required. |
| transaction_date_utc0 |
string |
The Coordinated Universal Time (UTC) of the transaction date. ie at time zone +0. Required. |
| document_type |
string |
Document Type. Allowed value: Sale, SaleReturn, ManuallyRedemption, Voucher365, Voucher, SaleOrder. Required. |
| document_number |
string |
Document Number. Your document number (sale, sale return, voucher, sale order). If the document type is Voucher365, 365 voucher number is required. If the document type is ManuallyRedemption, document number is not required. Maximum length for the document number is 50 characters. |
| billing_amount |
string |
Billing Amount. The equivalent amount of the number of points redeemed. Required if the document type is not ManuallyRedemption. |
| number_of_points_redeemed |
string |
Number of points to be redeemed. |
| loyalty_schema_code_365 |
string |
365 loyalty schema code used. |
| comments |
string |
Additional comments of the transaction. |
Returns
Returns the standard api_response object. The Powersoft365 loyalty transaction id is returned in the response_id field.