Status of connections

Some connection status are defined to follow the activity of user provider connections.

Three fields are available in connection status result:

• status
• status_code
• status_reason

Status

Status codes and reasons

Status codes are regrouping in 4 categories :

• 1xx: OK
• 2xx: User action required
• 3xx: Provider website error
• 4xx: Internal error

1xx - OK status codes

2xx - User action status codes

3xx - Provider error status codes

4xx - Internal error status codes

New status

We reserved us the right to add new status codes in the defined categories.

To be sure your application continue to give a correct message, check existent codes and add generic verification for the group number.

PHP example

/**
 * Get status reason.
 *
 * @param int $statusCode Status code
 *
 * @return string|null Message
 */
function getStatusReason(int $statusCode): ?string {
    // User action status codes
    if ($statusCode >= 100 && $statusCode < 200) {
        return null;
    }

    // User action status codes
    if ($statusCode >= 200) {
        switch ($statusCode) {
            // Login error
            case 201:
                return 'Incorrect login or password';
            // Generic error
            default:
                return 'An action is required on provider website';
        }
    }

    // ...

    return 'Unknown error';
}