The GET /rbits/{id} call allows your platform to look up a single rbit. 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
path Parameters
id
required
string [ 1 .. 255 ] characters
ID of the rbit, generated by WePay when the rbit is created.
header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
id
required
string [ 1 .. 255 ] characters
ID of the rbit, generated by WePay when the rbit is created.
path
required
string
Path of resource and resource ID.
required
object
Details the owner resource and owner path.
resource
required
string
Helps organize information by identifying the resource type of the object data.
Value:
Description
rbits
create_time
required
integer <int64> >= 0
The time (in UNIX) when the rbit was created.
receive_time
required
integer <int64> >= 0
The time (in UNIX) when the data in this rbit was first obtained.
type
required
string
The type of rBit. Use type to define how the rBit will be used.
Enum:
Description
address
Send this enum value when the rBit is describing an address related to the merchant or transaction.
auto_billing
Send this enum value when the rBit is describing auto billing related to a transaction.
… 19 more
source
required
string
Enum:
Description
user
Indicates that the information in this rBit was submitted directly by the user (merchant or payer).
guidestar
Indicates that the information in this rBit was collected by the partner from GuideStar.
… 10 more
state
required
string
State of the rbit. Possible values include: active, deleted.
Enum:
Description
active
Identifies the rBit as current information pertinent to the account or transaction.
deleted
Identifies the rBit as removed or outdated information no longer relevant to the account or transaction.
object
A mailing address associated with a user or account.
api_version
string
object
The user's card is charged automatically every month.
object
Text description of the business.
object
The full name of the business.
object
rbit to store Event information
object
rbit to store Expected Volume information
object
The user’s external accounts
object
Information about an event related to a donation transaction or donation account.
object
object
A code from one of several sources that indicates the industry associated with the business.
object
Information about the landlord of the property listed in the rental marketplace platform.
object
object
This describes one type of service or product the user signed up for on the partner site. This should be passed as a related rbit of the external_account rbit that contains partner site information.
object
Information about a person associated with a user or account.
object
A phone number associated with a user or account.
object
Information about a project that an invoice or transaction is related to.
object
Information about a rented/owned home/commercial property that a payment is made for.
object
rbit to store rental contract information
object
revenue information.
object
Information regarding a specific transaction.
object
The URI to the campaign/website for the associated object.
Clear
Core
Link