Transactions

Returns a specific transaction

get
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /v1/gift-cards/transactions/{id} HTTP/1.1
Host: 
Accept: */*
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"
    }
  }
}

Sends a verification SMS to customer with OTP to authorize a specific transaction. OTP is used later with applyWithOTP.

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

{
  "params": {
    "transactionUid": "text",
    "lang": "text"
  }
}
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "token": "text",
    "customer": {
      "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"
        }
      ]
    }
  }
}

Applies a specific voucher transaction using a token and OTP.

patch
Body
Responses
200Success
application/json
patch
PATCH /v1/gift-cards/transactions/apply-with-top HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "params": {
    "token": "text",
    "otp": "text"
  }
}
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Was this helpful?