/
Retrieve tokens

Retrieve tokens

Request

Retrieve a list of tokens.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/tokens?limit=0&offset=0' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of tokens retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
methodstringrequired

Payment method of the token.

Value:"payment-card"
Discriminator
paymentInstrumentobjectrequired

Payment card instrument details.

billingAddressobject(ContactObject)

Billing address object. This value is required to perform payments. For payment-card updates, billingAddress can be ignored.

idstring, <= 50 characters(ResourceId)read-only

ID of the token.

Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
isUsedbooleanread-only

Specifies if the token has been used.

Default:false
riskMetadataRisk metadata (object) or null
One of:

Risk metadata used for 3D Secure and risk scoring.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

usageTimestring or null, (date-time)read-only

Date and time when the token is used.

expirationTimestring or null, (date-time)read-only

Date and time when the token expired.

]
Response
[
  {
    "method": "payment-card",
    "paymentInstrument": { … },
    "billingAddress": { … },
    "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
    "isUsed": false,
    "riskMetadata": { … },
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "usageTime": "2019-08-24T14:15:22Z",
    "expirationTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]