Developer docs
/
Rebilly API
/
Payment tokens
/
Retrieve tokens

Retrieve tokens

Retrieve a list of tokens.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer [ 0 .. 1000 ]

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

get
/tokens
Request samples
$paymentCardTokens = $client->paymentCardTokens()->search([
    'filter' => 'token:string',
]);
Responses

200

List of tokens retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

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
Response Schema: application/json
Array
method
required
string

Payment method of the token.

required
object

Payment card instrument details.

object (ContactObject)

Contact's information.

id
string (ResourceId) <= 50 characters

Unique resource ID.

isUsed
boolean
Default: false

Specifies if the token has been used.

Risk metadata (object) or null
createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

usageTime
string or null <date-time>

Date and time when the token is used.

expirationTime
string or null <date-time>

Date and time when the token expired.

Array of objects (SelfLink)

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

Response samples
application/json
[
{
"method": "payment-card",


"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"isUsed": false,

"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"usageTime": "2019-08-24T14:15:22Z",
"expirationTime": "2019-08-24T14:15:22Z",

}
]