/
Retrieve payment instrume...

Retrieve payment instruments

Request

Retrieves a list of payment instruments.

Security
CustomerJWT
Query
filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

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

qstring

Use this field to perform a partial search of text fields.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/storefront/payment-instruments?filter=string&sort=string&limit=1000&offset=1000&q=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of payment instruments retrieved.

Headers
Pagination-Totalinteger

Total number of items.

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 [
One of:

Payment card information.

]
Response
[
  {
    "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
    "method": "payment-card",
    "status": "active",
    "fingerprint": "string",
    "bin": "string",
    "last4": "string",
    "expYear": 0,
    "expMonth": 0,
    "digitalWallet": "Apple Pay",
    "brand": "Visa",
    "bankCountry": "string",
    "bankName": "string",
    "isPayoutable": true,
    "billingAddress": { … },
    "useAsBackup": false,
    "billingPortalUrl": "string",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "lastPaymentTime": "2019-08-24T14:15:22Z",
    "customFields": { … },
    "token": "string",
    "_links": [ … ]
  }
]