Flux (3.0)
Download OpenAPI specification:Download
E-mail: support@fluxqr.com
Documentation for Flux API to be able to perform transactions using user's QR Wallet
Gets Flux commerces catalog (TBD)
Gets Flux commeces catalog
Authorizations:
bearerToken
query Parameters
| type | string Enum: "group" "chain" "store" Filter commerces by type |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
Content type
application/json
{- "data": {
- "items": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "type": "group"
}
]
}
}Creates a new coupon
Creates a new coupon with information provided
Authorizations:
bearerToken
Request Body schema: application/jsonrequired
Parameters required to creates a new coupon
| commerce required | string <uuid> Flux commerce identifier |
| amount required | integer <int32> Amount for coupon in cents |
| expiration required | string <date-time> Expiration for coupon using ISO 8601 ( |
| isPayable required | boolean Flag that indicates if coupon need be payable to the commerce |
required | object |
Responses
Request samples
- Payload
Content type
application/json
{- "commerce": "fd3cf595-fb08-4770-ba6e-01167c98ff7a",
- "amount": 10000,
- "expiration": "2021-12-31T23:59:59.999Z",
- "isPayable": true,
- "customer": {
- "id": 0,
- "name": "string",
- "email": "string",
- "phone": "string"
}
}Response samples
- 201
- 400
- 401
- 403
- 500
Content type
application/json
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "qr": "string",
- "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
- "amount": 0,
- "balance": 0,
- "isPayable": true,
- "expiration": "2019-08-24T14:15:22Z"
}
}Gets coupon information
Gets coupon information
Authorizations:
bearerToken
path Parameters
| couponId required | string <uuid> Coupon identifier |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
Content type
application/json
{- "data": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "qr": "string",
- "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
- "amount": 0,
- "balance": 0,
- "isPayable": true,
- "expiration": "2019-08-24T14:15:22Z"
}
}Updates a coupon
Update a coupon. For now only can enable or disable a coupon
Authorizations:
bearerToken
path Parameters
| couponId required | string <uuid> Coupon identifier |
Request Body schema: application/jsonrequired
Parameters required to creates a new coupon
| enabled | boolean Flag that indicates if coupon is enabled (true) or disabled (false) |
Responses
Request samples
- Payload
Content type
application/json
{- "enabled": true
}Response samples
- 400
- 401
- 403
- 500
Content type
application/json
Example
{- "error": {
- "code": "ERR_CLIENT",
- "message": ""
}
}