Rebilly API Docs

Retrieve a list of tokens

Retrieve a list of tokens.

SecuritySecretApiKey or JWT

Request

query Parameters

limit	integer [ 0 .. 1000 ] The collection items limit.
offset	integer >= 0 The collection items offset.

Responses

200

A list of tokens was retrieved successfully.

Response Headers
Pagination-Total	integer Total items count. Example: 332
Pagination-Limit	integer Items per page limit. Example: 100
Pagination-Offset	integer Pagination offset. Example: 2

Response Schema: application/json

Array

method

required

string

The token payment method.

required

object

The payment card instrument details.

expMonth required	integer Payment Card expiration month.
expYear required	integer Payment Card expiration year.
bin	string <bin> Payment Card BIN (the PAN's first 6 digits).
last4	string Payment Card PAN's last 4 digits.
brand	string Payment Card brand. Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" … 4 more

object

The billing address object. Required to perform payments. For payment-card updates, billingAddress can be ignored.

firstName	string or null <= 45 characters ^[\w\s\-\pL,.']+$ The contact first name.
lastName	string or null <= 45 characters ^[\w\s\-\pL,.']+$ The contact last name.
organization	string or null <= 255 characters ^[\w\s\-\pL,.'&]+$ The contact organization.
address	string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact street address.
address2	string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact street address (second line).
city	string or null <= 45 characters ^[\w\s\-\pL,.']+$ The contact city.
region	string or null <= 45 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact region (state).
country	string or null <= 2 characters ^[A-Z]{2}$ The contact country ISO Alpha-2 code.
postalCode	string or null <= 10 characters ^[\w\s\-]+$ The contact postal code.
	Array of objects (ContactPhoneNumbers) The list of phone numbers.
	Array of objects (ContactEmails) The list of emails.
dob	string or null <date> The contact's date of birth in ISO-8601 format (yyyy-mm-dd).
jobTitle	string or null <= 255 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact's job title.
hash	string <= 40 characters A hash that can be used to compare multiple contacts for identical attribute values.

string <= 50 characters

The token identifier string.

isUsed

boolean

Default: false

Whether the token was already used.

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

ipAddress	string <ipv4 or ipv6> The customer's IP.
fingerprint	string <= 50 characters The fingerprint.
	object (HttpHeaders) The HTTP headers.
	object (Browser data) Browser data used for 3DS and risk scoring.
	object (Extra data) Third party data used for risk scoring.
isProxy	boolean True if customer's ip address is related to proxy.
isVpn	boolean True if customer's ip address is related to VPN.
isTor	boolean True if customer's ip address is related to TOR.
isHosting	boolean True if customer's ip address is related to hosting.
vpnServiceName	string VPN service name, if available.
isp	string Internet Service Provider name, if available.
country	string <= 2 characters Country ISO Alpha-2 code for specified ipAddress.
region	string Region for specified ipAddress.
city	string City for specified ipAddress.
latitude	number <double> Latitude for specified ipAddress.
longitude	number <double> Longitude for specified ipAddress.
postalCode	string <= 10 characters Postal code for specified ipAddress.
timeZone	string Time zone for specified ipAddress.
accuracyRadius	integer Accuracy radius for specified ipAddress (kilometers).
distance	integer Distance between IP Address and Billing Address geolocation (kilometers).
hasMismatchedBillingAddressCountry	boolean True if the billing address country and geo-IP address are not the same.
hasMismatchedBankCountry	boolean True if the bank country and geo-IP address are not the same.
hasMismatchedTimeZone	boolean True if the browser time zone and IP address associated time zone are not the same.
hasMismatchedHolderName	boolean True if the customer's name from billing address and from customer's primary address are not the same.
hasFakeName	boolean True if the holder name seems fake.
isHighRiskCountry	boolean True if geo-IP country or the customer's billing country is considered a high risk country.
paymentInstrumentVelocity	integer Number of transactions for this payment instrument (based on fingerprint) in the last 24 hours.
deviceVelocity	integer Number of transactions for this device (based on fingerprint) in the last 24 hours.
ipVelocity	integer Number of transactions for this ip address in the last 24 hours.
emailVelocity	integer Number of transactions for this email address in the last 24 hours.
billingAddressVelocity	integer Number of transactions for this billing address in the last 24 hours.
score	integer Risk score computed per all the factors.

createdTime

string <date-time>

Token created time.

updatedTime

string <date-time> (UpdatedTime)

Read-only timestamp updates when the resource is updated.

usageTime

string <date-time>

Token usage time.

expirationTime

string <date-time>

Token expiration time.

Array of objects (Self) non-empty

The links related to resource.

Array (non-empty)

href required	string The link URL.
rel required	string The link type. Value: "self"

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/tokens

Request samples

$paymentCardTokens = $client->paymentCardTokens()->search([
    'filter' => 'token:string',
]);

Response samples

application/json

[{"method": null
}
]

➔ Next to Retrieve a token