Transactions

Returns a specific transaction

get

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

400

Functional Error

application/json

get

/v1/gift-cards/transactions/{uid}

HTTPcURLJavaScriptPython

GET /v1/gift-cards/transactions/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "transaction": {
      "type": "payment",
      "status": "applied",
      "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

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

post

/v1/gift-cards/transactions/{uid}/send-otp

HTTPcURLJavaScriptPython

POST /v1/gift-cards/transactions/{uid}/send-otp HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "params": {
    "lang": "text"
  }
}

{
  "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": "F",
      "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

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

patch

/v1/gift-cards/transactions/apply-with-otp

HTTPcURLJavaScriptPython

PATCH /v1/gift-cards/transactions/apply-with-otp HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "params": {
    "token": "text",
    "otp": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}