Gormic.com

Vouchers

Lists all vouchers associated with a specific customer

get
Path parameters
customerIdstringRequired
Responses
200Success
application/json
get
GET /v1/gift-cards/vouchers/{customerId} HTTP/1.1
Host: 
Accept: */*
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "vouchers": [
      {
        "amount": 1,
        "activatedAt": "text",
        "sharedAt": "text",
        "activationEndDate": "text",
        "validity": 1,
        "createdAt": "text",
        "createdVia": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "uid": "text",
        "productId": "text",
        "customerId": "text",
        "holderId": "text",
        "sharedTo": {
          "firstName": "text",
          "lastName": "text",
          "email": "text",
          "phone": "text",
          "cityId": "text",
          "birthDate": "text",
          "gender": 1,
          "passcode": "text",
          "sequence": 1,
          "number": "text",
          "createdAt": "text",
          "createdVia": "text",
          "updatedAt": "text",
          "updatedVia": "text",
          "id": "text",
          "roleAssignments": [
            {
              "endDate": "text",
              "id": "text"
            }
          ]
        },
        "expiresAt": "text",
        "expired": true,
        "balance": 1,
        "accountUid": "text"
      }
    ],
    "next": "text"
  }
}

Returns a specific voucher

get
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /v1/gift-cards/vouchers/{id} HTTP/1.1
Host: 
Accept: */*
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "voucher": {
      "amount": 1,
      "activatedAt": "text",
      "sharedAt": "text",
      "activationEndDate": "text",
      "validity": 1,
      "createdAt": "text",
      "createdVia": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "uid": "text",
      "productId": "text",
      "customerId": "text",
      "holderId": "text",
      "sharedTo": {
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "phone": "text",
        "cityId": "text",
        "birthDate": "text",
        "gender": 1,
        "passcode": "text",
        "sequence": 1,
        "number": "text",
        "createdAt": "text",
        "createdVia": "text",
        "updatedAt": "text",
        "updatedVia": "text",
        "id": "text",
        "roleAssignments": [
          {
            "endDate": "text",
            "id": "text"
          }
        ]
      },
      "expiresAt": "text",
      "expired": true,
      "balance": 1,
      "accountUid": "text"
    }
  }
}

Activates a specific voucher

patch
Path parameters
idstringRequired
Body
Responses
200Success
application/json
patch
PATCH /v1/gift-cards/vouchers/{id}/activate HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "params": {
    "voucherUid": "text",
    "customerId": "text",
    "orderId": "text",
    "message": "text"
  }
}
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Initiates a redemption transaction using a specific voucher.

post
Path parameters
idstringRequired
Body
Responses
200Success
application/json
post
POST /v1/gift-cards/vouchers/{id}/pay HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "params": {
    "voucherUid": "text",
    "amount": 1,
    "reference": "text"
  }
}
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "transaction": {
      "type": 1,
      "status": 1,
      "time": "text",
      "amount": 1,
      "description": "text",
      "reversed": true,
      "reference": "text",
      "createdAt": "text",
      "createdVia": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "uid": "text",
      "accountUid": "text",
      "transferToAccountUid": "text"
    }
  }
}

Redeem a specific voucher using its voucher code

post
Body
Responses
200Success
application/json
post
POST /v1/gift-cards/vouchers/pay-with-code HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "params": {
    "code": "text",
    "amount": 1,
    "reference": "text"
  }
}
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "transaction": {
      "type": 1,
      "status": 1,
      "time": "text",
      "amount": 1,
      "description": "text",
      "reversed": true,
      "reference": "text",
      "createdAt": "text",
      "createdVia": "text",
      "updatedAt": "text",
      "updatedVia": "text",
      "uid": "text",
      "accountUid": "text",
      "transferToAccountUid": "text"
    }
  }
}
PreviousGift CardsNextTransactions

Was this helpful?