GET /merchant/users

Provides merchant access to users’ data via a REST API

Example URLs:

Authorization

To authorize your request use Basic Auth passing the Merchant Id as your username and API Key as your password.

Response

/merchant/users returns a JSON object with the following keys:

status

'ok' if the request was handled correctly, or 'error' if some problem occurred (such as an incorrect set of parameters).

data

A list of JSON objects containing user info data.

errors

A list of JSON objects containing error info.

Example responses:

{
    "status": "ok",
    "data": [
        {
            "country": "hu",
            "last_name": "test",
            "first_name": "test",
            "preferred_language": "en",
            "date_joined": "2019-12-12T12:19:17.193961+00:00",
            "zip_code": "10005",
            "street": "1111 brooklyn NY",
            "deactivated_at": "2020-01-07T04:56:05.550730+00:00",
            "city": "Budapest",
            "state": null,
            "agreed_to_terms_and_conditions": "2020-04-03T11:33:23.040172+00:00",
            "shared_user_id": "test-uuid",
            "agreed_to_marketing": "2020-02-14T13:01:50.286972+00:00",
            "email_address": test@laterpay.net"
        },
        ....
    ]
}

GET /merchant/users/<shared_user_id>

Provides a merchant access to a specific user’s info via a REST API.

Example URLs:

Authorization

To authorize your request use Basic Auth passing the Merchant Id as your username, and API Key as your password

Response

/merchant/users/<shared_user_id> returns a JSON object with the following keys:

status

'ok' if the request was handled correctly, or 'error' if some problem occurred (such as an incorrect set of parameters).

data

A JSON object containing the user’s info. The json object is wrapped in a list.

Example responses:

{
    "status": "ok",
    "data": [
        {
            "country": "hu",
            "last_name": "test",
            "first_name": "test",
            "preferred_language": "en",
            "date_joined": "2019-12-12T12:19:17.193961+00:00",
            "zip_code": "10005",
            "street": "1111 brooklyn NY",
            "deactivated_at": "2020-01-07T04:56:05.550730+00:00",
            "city": "Budapest",
            "state": null,
            "agreed_to_terms_and_conditions": "2020-04-03T11:33:23.040172+00:00",
            "shared_user_id": "test-uuid",
            "agreed_to_marketing": "2020-02-14T13:01:50.286972+00:00",
            "email_address": "test@laterpay.net"
        }
    ]
}