List Users

Velo Payments Sandbox for testing

https://api.sandbox.velopayments.com/

GET

/v2/users

Get a paginated response listing the Users

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.sandbox.velopayments.com//v2/users'

Response Example

200 - Example 1

{
    "content": [
        {
            "email": "foo@example.com",
            "entityId": "7fffa261-ac68-49e6-b605-d24a444d9206",
            "firstName": "John",
            "id": "8bbf301c-948f-4445-b411-357eec53e441",
            "lastName": "Doe",
            "lockedOut": true,
            "lockedOutTimestamp": "2000-01-23T04:56:07.000+00:00",
            "mfaStatus": "REGISTERED",
            "mfaType": "TOTP",
            "primaryContactNumber": "11235555555",
            "roles": [
                "payor.admin"
            ],
            "secondaryContactNumber": "11235555550",
            "smsNumber": "11235555555",
            "status": "ENABLED"
        },
        {
            "email": "foo@example.com",
            "entityId": "7fffa261-ac68-49e6-b605-d24a444d9206",
            "firstName": "John",
            "id": "8bbf301c-948f-4445-b411-357eec53e441",
            "lastName": "Doe",
            "lockedOut": true,
            "lockedOutTimestamp": "2000-01-23T04:56:07.000+00:00",
            "mfaStatus": "REGISTERED",
            "mfaType": "TOTP",
            "primaryContactNumber": "11235555555",
            "roles": [
                "payor.admin"
            ],
            "secondaryContactNumber": "11235555550",
            "smsNumber": "11235555555",
            "status": "ENABLED"
        }
    ],
    "links": [
        {
            "href": "https://api.sandbox.velopayments.com/v2/users??type=PAYOR&page=1&pageSize=10",
            "rel": "first"
        },
        {
            "href": "https://api.sandbox.velopayments.com/v2/users??type=PAYOR&page=1&pageSize=10",
            "rel": "first"
        }
    ],
    "page": {
        "numberOfElements": 12,
        "page": 1,
        "pageSize": 25,
        "totalElements": 33,
        "totalPages": 2
    }
}

Request

Query Params

Responses

🟢200Paginated list of Users filtered by query parameters

application/json

Body

🟠400Invalid request. See Error message payload for details of failure

🟠401Invalid access token. May be expired or invalid

🟠403The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions

Modified at 2022-09-11 21:50:18

Delete a source account by ID

Invite a User