Flux (3.0)
Download OpenAPI specification:Download
Documentation for Flux API to be able to perform transactions using user's QR Wallet
Authenticates a client
Authenticates a client using a refresh token provided by Flux team. This endpoint will return an access token required to identify authenticated users and perform payment request
Request Body schema: application/jsonrequired
Parameters required to authenticate
| refreshToken required | string Refresh token provided by Flux Team |
| grantType | string Value: "accessToken" Grant type required. Only access token supported for now |
Responses
Request samples
- Payload
{- "grantType": "accessToken",
- "refreshToken": "F3GgY3dLYp3Y6Ca1XWoRL6tnqFN2NxwY7PCiQevklrowgc97Vf0UBENbMTAH4NJS8vQCx5xyjMOERENpQSSsTdSRXYl1ZRShL3uZIXsC7o4Xii5wHdbrwzEGurhY5vdF"
}Response samples
- 200
- 400
- 500
{- "data": {
- "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3N1ZXIiOiJzYW5kYm94LmZsdXhxci5jb20iLCJleHAiOjE1OTY3NDI2ODksInVzZXJJZCI6MTE4LCJzdG9yZUlkIjoxLCJpYXQiOjE1OTY3NDI2Nzl9.cig9KgXEo2OMvOjSQJ6C5N0AexOWU3wDzmga7RjbPd0",
- "expiresIn": 1596742689000
}
}Request a payment
Allow request a payment from User's wallet
Request Body schema: application/jsonrequired
Paremeters supported to request a payment
| qr required | string String decoded from user's QR |
| amount required | integer <int32> Transaction amount in cents |
| tip | integer <int32> Default: 0 Transaction tip in cents |
| reference | string An unique value per store that helps to indentify and trace the transaction |
| store required | string Store's name or identifier that request the payment |
| terminal | string Store's terminal identifier if is available |
| operator | string Operator's name if is available |
| table | string Table number if is available |
Responses
Request samples
- Payload
{- "qr": "{\"CT\":\"487321429838\",\"MT\":\"$203.50\"}",
- "amount": 18500,
- "tip": 1850,
- "reference": "2121596224565895",
- "store": "Flux Coffee CDMX",
- "terminal": "FQR001",
- "operator": "Rodrigo",
- "table": "42"
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "date": "2020-12-23:59:59.000Z",
- "issuer": "claropay",
- "authorization": "123456",
- "reference": "string",
- "type": "payment",
- "status": "ok",
- "amount": 0,
- "tip": 0,
- "total": 0,
- "store": "string",
- "terminal": "string",
- "operator": "string",
- "table": "strin",
- "affiliation": "string"
}
}Request a refund
Allow request a refund for user
path Parameters
| reference required | string Example: 1596477600447 Reference number |
Request Body schema: application/jsonrequired
Paremeters supported to request a refund
| amount required | integer <int32> Transaction amount in cents |
| message | string Message sent to customer via push notification (only RappiPay) |
| store | string Store's name or identifier that request the payment |
| terminal | string Store's terminal identifier if is available |
| operator | string Name of operator if is available |
| table | string Table number if is available |
Responses
Request samples
- Payload
{- "amount": 20350,
- "message": "Devolución a través de Flux",
- "operator": "Rodrigo"
}Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "date": "2020-12-23:59:59.000Z",
- "issuer": "claropay",
- "authorization": "123456",
- "reference": "string",
- "type": "payment",
- "status": "ok",
- "amount": 0,
- "tip": 0,
- "total": 0,
- "store": "string",
- "terminal": "string",
- "operator": "string",
- "table": "strin",
- "affiliation": "string"
}
}Transaction detail
Get transaction information
path Parameters
| reference required | string Example: 1596477600447 Reference number |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
{- "data": {
- "date": "2020-12-23:59:59.000Z",
- "issuer": "claropay",
- "authorization": "123456",
- "reference": "string",
- "type": "payment",
- "status": "ok",
- "amount": 0,
- "tip": 0,
- "total": 0,
- "store": "string",
- "terminal": "string",
- "operator": "string",
- "table": "strin",
- "affiliation": "string"
}
}