Verify if hoopoints issuing is possible.​
Verify if hoopoints issuing is possible.
Header Parameters
- Accept stringExample: application/json
- application/json
Request Body
- recipients string[]
List of emails you want to send hoopoints.
- amount integer
Amount of hoopoints
Responses
- 200
- 400
OK
- application/json
- Schema
- Example (from schema)
- Example
Schema
- success boolean
Check if the request is a success or not
data object
validated booleanIf the transaction is permitted.
error stringExplain why the transaction is not permitted.
errors object nullable
Errors in the api request
property name* object nullable
Array [string]additional_data object nullable
Additional data
property name* object nullable
Array [string]
{
"success": true,
"data": {
"validated": true,
"error": "Not enought hoopoints"
},
"errors": {
"field_1": [
"required"
],
"field_2": [
"minimum 6 chars"
]
},
"additional_data": {
"version": "1.0.0"
}
}
{
"success": true,
"data": {
"validated": true,
"error": null
},
"errors": null,
"additional_data": null
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- sucess boolean
Check if the request is a success or not
- data object nullable
Data of the request
errors object nullable
Errors
property name* object nullable
Array [string]
{
"sucess": false,
"data": null,
"errors": {
"field_1": [
"required"
],
"field_2": [
"minimum 6 chars"
]
}
}
{
"success": false,
"data": null,
"errors": {
"amount": [
"The amount field is required."
],
"recipient": [
"The recipient field is required when recipients is not present."
],
"recipients": [
"The recipients field is required when recipient is not present."
]
},
"additional_data": null
}
Loading...