WePay logo
      Nothing Found

Get a collection of rbits

get/rbits

The GET /rbits call allows your platform to look up a collection of rbits. The rbits resource provides a way to communicate risk-related account and transaction level information between an application and WePay. An rbit contains risk related information about your users, their accounts, and their transactions.

SecurityappIdAuth and appTokenAuth
Request
query Parameters
page
string

Return elements from this page.

page_size
integer [ 1 .. 50 ]
Default: 10

Return no more than this many elements per page. If not specified, page_size defaults to 10. Maximum value allowed is 50.

create_time_start
integer <int64> >= 0

The timestamp for the start of the search window.

create_time_end
integer <int64> >= 0

The timestamp for the end of the search window.

owner_id
string

Return elements owned by this owner ID.

owner_type
string

Return elements owned by a resource of this type. Required if owner_id is provided.

Enum: Description
legal_entities

rBits associated with a Legal Entity.

accounts

rBits associated with an Account

… 6 more
header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
required
Array of objects

An array of rbit objects.

next
required
string or null

An opaque path for the next page of results. You can perform an HTTP GET to obtain the next page.

previous
required
string or null

An opaque path for the previous page of results. You can perform an HTTP GET to obtain the previous page.

api_version
string
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "next": "/rbits?page=AQQHAAEX8yf1HDkrXqO7R-wy2joNU6ooRNCyDb-sSbbvR-8J6jKeFgpqprcIsuEnBh4fqImpR2eYjKIgSCirw2mhEFR7m5AsSj1OkG9emNFWhXQvreOczuQU7UzZ",
  • "previous": null,
  • "api_version": "3.0",
  • "results": [
    • {
      • "create_time": 1390656130,
      • "id": "f48cd8e6-e802-4500-a0f9-3ab6228c6f23",
      • "owner": {
        • "id": "d7608b20-fea5-4eb5-bd30-d3f58435e78b",
        • "path": "/accounts/d7608b20-fea5-4eb5-bd30-d3f58435e78b",
        • "resource": "accounts"
        },
      • "path": "/rbits/f48cd8e6-e802-4500-a0f9-3ab6228c6f23",
      • "phone": {
        • "country_code": "+1",
        • "phone_number": "5556667777",
        • "phone_type": "business"
        },
      • "receive_time": 1367958263,
      • "resource": "rbits",
      • "source": "guidestar",
      • "state": "active",
      • "type": "phone",
      • "api_version": "3.0"
      }
    ]
}