This page describes the response returned by the IDMobile Billing retrieval endpoint.
Related IDMobile Billing documentation:
- ID Mobile introduction
- Billing Consent response
- Billing Retrieval GET request
- Billing Retrieval POST request
- IDMobile Billing Swagger documentation
Billing retrieval success response
The response is a JSON object whose keys are defined below:
| Key | Description | Format |
|---|---|---|
| status |
success: indicates that the information was successfully retrieved. |
STRING |
| scope | billing |
STRING |
| billing | Proof of address in Base64 encoding. | STRING |
Example:
{
"status": "success",
"scope": "billing",
"billing": "N0YXJ0eHJlZgo0OTg2MQolJUVPRgoKLS1ZS0xJNTYpPUlSeFdNUzEoYXJpOWI/UklzLkRXZ1dwUF9FLS0K"
}Billing retrieval pending response
The response is a JSON object whose keys are defined below:
| Key | Description | Format |
|---|---|---|
| status |
pending: indicates that DQE is waiting for the operator response. |
STRING |
| scope | billing |
STRING |
Example:
{
"status": "pending",
"scope": "billing"
}Billing retrieval error response
The response is a JSON object whose keys are defined below:
| Key | Description | Format |
|---|---|---|
| status |
error: indicates that the request failed. |
STRING |
| error_type | Error label. Details are provided in the table below. | STRING |
| error_id | Error code. Details are provided in the table below. | STRING(2) |
Error code details:
| Error ID | Error type | Description |
|---|---|---|
| 01 | invalid request | The request is not valid. |
| 02 | invalid licence key | The licence is not valid. |
| 04 | invalid scope | Invalid scope. |
| 18 | failed to retrieve data from operator | No data was received after OTP validation. |
| 20 | OTP incorrect | OTP validation was not completed. |
| 21 | access denied | OTP validation was declined. |
| 30 | invalid or expired token | The token has expired. |
| 99 | internal server error | Server error. |
Example:
{
"status": "error",
"error_type": "internal server error",
"error_id": "99"
}Related to