Developer docs
/
Rebilly API
/
Payment instruments
/
Retrieve payment instruments

Retrieve payment instruments

Retrieves a list of payment instruments.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
query Parameters
filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array 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 ,.

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.

q
string

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

expand
string

Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.

For more information, see Expand to include embedded objects.

get
/payment-instruments
Request samples
$paymentInstruments = $client->paymentInstruments()->search([
    'filter' => 'status:active;method:payment-card',
]);
Responses

200

List of payment instruments 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
id
string <= 50 characters

ID of the payment instrument.

customerId
string (CustomerId) <= 50 characters

ID of the customer resource.

method
required
string

Method of payment instrument.

status
string

Status of the payment instrument. An active status means that a payment instrument has been used at least once for an approved transaction. To remove an instrument from use, set this value to deactivated.

For more information, see Deactivate a payment instrument.

Enum: "active" "inactive" "expired" "deactivated" "verification-needed"
fingerprint
string

Unique value that is used to identify the payment instrument. This value is generated from the bin and the last4 values. This value contains alphanumeric characters.

bin
string <bin>

Bank Identification Number (BIN) of the payment card. This value is the same as the first 6 digits of the associated Primary Account Number (PAN).

last4
string

Last 4 digits of the associated Primary Account Number (PAN).

expYear
integer

Expiration year of the payment card.

expMonth
integer

Expiration month of the payment card.

brand
string

Brand of payment card.

Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" "Switch" "Laser" "China UnionPay" "AstroPay Card"
bankCountry
string or null

Bank country of the payment instrument.

bankName
string

Bank name of the payment instrument.

object (ContactObject)

Contact's information.

useAsBackup
boolean (UseAsBackup)

Specifies if this payment instrument can be used as a backup for invoice payment retries.

billingPortalUrl
string

URL of the billing portal where the card can be updated.

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.

customFields
object (ResourceCustomFields)

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

stickyGatewayAccountId
string or null

ID of the sticky gateway account. All future payments are processed by this gateway account.

For more information, see Gateway routing.

expirationReminderTime
string or null <date-time>

Date and time when an expiration reminder event is triggered.

expirationReminderNumber
integer or null

Number of expiration reminder events that have triggered.

object

Payment instrument reference data.

digitalWallet
string or null

Digital wallet type.

Enum: "Apple Pay" "Google Pay" null
Risk metadata (object) or null
revision
integer

Number of times the payment instrument data has been modified.

Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.

Array of objects

Related links.

object

Embedded objects that are requested by the expand query parameter.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

Response samples
application/json
[
{
"id": "inst_0YVB8KPKNXCBR9EDX7JHSED75N",
"customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
"method": "payment-card",
"status": "active",
"fingerprint": "string",
"bin": "string",
"last4": "string",
"expYear": 0,
"expMonth": 0,
"brand": "Visa",
"bankCountry": "string",
"bankName": "string",

"useAsBackup": false,
"billingPortalUrl": "string",
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",

"stickyGatewayAccountId": "string",
"expirationReminderTime": "2019-08-24T14:15:22Z",
"expirationReminderNumber": 0,

"digitalWallet": "Apple Pay",

"revision": 0,


}
]