Integration

Integration: Redeem

Information

Item Value
Method POST
Permission Required? Loyalty
URL https://api.eber.co/v3/public/integration/redeem

Fields

Item Required? Type Description
redeem_code Yes String Redeem Code
verify_only No 1 | 0 To verify a redeem code, no actual transaction
amount No Decimal Current transaction amount
custom_store_id No String Custom Store Id
custom_staff_id No String Custom Staff Id
transaction_no No String Transaction reference
note No String

Result

pos_redeem_method = amount
{
    "redeem_code": "RLG5362",
    "user_id": 2466,
    "user_qr_code": "eSTbgSrdbXA28IRRPxSpDvZmQfPrW626iDNiBhYa",
    "redeem_type": "issued_reward",
    "verify_only": true,
    "redeem_name": "POS (TESTING)",
    "pos_redeem_method": "amount",
    "pos_redeem_amount": "13.00",
    "pos_redeem_amount_after_tax": false,
    "pos_redeem_amount_currency": "SGD",
    "pos_redeem_sku": "234",
    "pos_redeem_category": "234234",
    "pos_redeem_extra": "2342432",
    "start_date": "2021-03-04 16:44:48",
    "friendly_start_date": "4 Mar 2021",
    "expiry_date": "2022-03-04 16:44:48",
    "friendly_expiry_date": "4 Mar 2022",
    "image_url": "https://s3-ap-southeast-1.amazonaws.com/igift-test/resized/1571739650_RB9mUVv5HnaXzqQiQcyHEz7IuR6RCukeUkzH0JQK_600.jpg",
    "issued_reward": {
        "id": 1886,
        "coupon_id": 284,
        "user_id": 2466,
        "hash": "RLG5362",
        "status": "valid",
        "created_at": "2020-04-09 10:34:48",
        "updated_at": "2020-04-09 10:34:48",
        "quantity": 1,
        "type": "standard",
        "ecom_discount_code_status": false,
        "store_id": null,
        "void": false,
        "base_type": "CouponIssued",
        "friendly_created_at": "2020-04-09 10:34:48"
    },
    "print": {
        "default": "RLG5362\r\nRedeem Code Used"
    }
}
pos_redeem_method = percentage
{
    "redeem_code": "RLG5362",
    "user_id": 2466,
    "user_qr_code": "eSTbgSrdbXA28IRRPxSpDvZmQfPrW626iDNiBhYa",
    "redeem_type": "issued_reward",
    "verify_only": true,
    "redeem_name": "POS (TESTING)",
    "pos_redeem_method": "percentage",
    "pos_redeem_percentage": "10.00",
    "pos_redeem_sku": "234",
    "pos_redeem_category": "234234",
    "pos_redeem_extra": "2342432",
    "start_date": "2021-03-04 16:44:48",
    "friendly_start_date": "4 Mar 2021",
    "expiry_date": "2022-03-04 16:44:48",
    "friendly_expiry_date": "4 Mar 2022",
    "image_url": "https://s3-ap-southeast-1.amazonaws.com/igift-test/resized/1571739650_RB9mUVv5HnaXzqQiQcyHEz7IuR6RCukeUkzH0JQK_600.jpg",
    "issued_reward": {
        "id": 1886,
        "coupon_id": 284,
        "user_id": 2466,
        "hash": "RLG5362",
        "status": "valid",
        "created_at": "2020-04-09 10:34:48",
        "updated_at": "2020-04-09 10:34:48",
        "quantity": 1,
        "type": "standard",
        "ecom_discount_code_status": false,
        "store_id": null,
        "void": false,
        "base_type": "CouponIssued",
        "friendly_created_at": "2020-04-09 10:34:48"
    },
    "print": {
        "default": "RLG5362\r\nRedeem Code Used"
    }
}
pos_redeem_method = card
{
    "redeem_code": "CVFFYL6",
    "user_id": 2354,
    "user_qr_code": "51zclXw7ofDwVEo3QBgy9BvoE9UW56amM9uUp6Ev",
    "redeem_type": "card",
    "verify_only": false,
    "redeem_name": "u",
    "pos_redeem_method": "card",
    "pos_redeem_amount": "1.2",
    "pos_redeem_amount_after_tax": true,
    "pos_redeem_amount_currency": "SGD",
    "pos_redeem_balance_before": "7.50",
    "pos_redeem_balance": "6.30",
    "pos_redeem_useall": false,
    "start_date": "2021-03-04 16:44:48",
    "friendly_start_date": "4 Mar 2021",
    "expiry_date": "2022-03-04 16:44:48",
    "friendly_expiry_date": "4 Mar 2022",
    "image_url": "https://s3-ap-southeast-1.amazonaws.com/igift-test/resized/1491373417_u8fmZeMtjc6v6ZR0hYfUQqsjZzx7nKOk6Sr8AOtw_c600.jpg",
    "card": {
        "id": 990,
        "started_at": "2021-03-04 08:44:48",
        "expired_at": null,
        "linked_at": "2021-03-04 08:44:48",
        "balance": "6.30",
        "status": "active",
        "user_id": 2354,
        "card_setting_id": 44,
        "release_type": "digital",
        "type": "card",
        "amount": "4.00",
        "order_id": 3804,
        "serial": 80010958,
        "currency": "USD",
        "claim_free": false,
        "reference_number": "CVFFYL6",
        "activated_store_id": null,
        "partner_id": null,
        "base_type": "Card",
        "friendly_expiry_date": null
    },
    "print": {
        "default": "CVFFYL6\r\nRedeem Code Used"
    }
}