Retrieve a list of payment instruments

Retrieve a list of payment instruments.

SecuritySecretApiKey or 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 -.

limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

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.

Responses
200

A list of payment instruments was 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

Payment instrument identifier string.

method
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 the deactivation endpoint.

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

A unique value that is used to identify the payment instrument regardless of variable 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

Year in which the payment card expires.

expMonth
integer

Month in which the payment card expires.

brand
string

Payment card brand.

Enum: "Visa" "MasterCard" "American Express" "Discover" "Maestro" "Solo" "Electron" "JCB" "Voyager" "Diners Club" … 4 more
bankCountry
string

Payment instrument bank country.

bankName
string

Payment instrument bank name.

object

Contact's billing address.

firstName
string or null <= 45 characters ^[\w\s\-\pL,.']+$

Contact's first name.

lastName
string or null <= 45 characters ^[\w\s\-\pL,.']+$

Contact's last name.

organization
string or null <= 255 characters ^[\w\s\-\pL,.'&]+$

The contact's organization.

address
string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

First line of the contact's street address.

address2
string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

Second line of the contact's street address.

city
string or null <= 45 characters ^[\w\s\-\pL,.']+$

Contact's city of residence.

region
string or null <= 45 characters ^[\w\s\-\/\pL,.#;:()']+$

Contact's region of residence.

country
string or null <= 2 characters ^[A-Z]{2}$

Contact's country of residence in ISO 3166 alpha-2 country code. For examples, see ISO.org.

postalCode
string or null <= 10 characters ^[\w\s\-]+$

Contact's postal code.

Array of objects (ContactPhoneNumbers)

List of phone numbers associated with the contact.

Array of objects (ContactEmails)

List of email addresses associated with the contact.

dob
string or null <date>

Contact's date of birth in ISO-8601 YYYY-MM-DD format.

jobTitle
string or null <= 255 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact's job title.

hash
string <= 40 characters

Use this value to compare contacts for identical attribute values.

useAsBackup
boolean (UseAsBackup)
Default: false

Specifies whether 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>

Date and time at which the payment instrument was created.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp. This value updates when the resource is updated.

customFields
object (ResourceCustomFields)
Default: {}

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.

customerId
string (CustomerId) <= 50 characters

Customer resource ID. Defaults to UUID v4.

stickyGatewayAccountId
string or null

Sticky gateway account ID. All future payments will be processed by this gateway account.

For more information, see Gateway routing.

expirationReminderTime
string or null <date-time>

Date and time at which an expiration reminder event will be triggered.

expirationReminderNumber
integer or null

Number of expiration reminder events that have triggered.

object

Payment instrument reference data.

property name*
additional property
string
digitalWallet
string or null

Digital wallet type.

Enum: "Apple Pay" "Google Pay"
object (Risk metadata)

Risk metadata used for 3D Secure and risk scoring.

ipAddress
string <ipv4 or ipv6>

Customer's IP address.

fingerprint
string <= 50 characters

Customer's fingerprint.

object (HttpHeaders)

The HTTP headers.

object (Browser data)

Browser data used for 3D Secure and risk scoring.

object (Extra data)

Third party data used for risk scoring.

isProxy
boolean

Specifies whether the customer's IP address is related to a proxy.

isVpn
boolean

Specifies whether the customer's IP address is related to a VPN.

isTor
boolean

Specifies whether the customer's IP address is related to TOR.

isHosting
boolean

Specifies whether the customer's IP address is related to hosting.

vpnServiceName
string

VPN service name, if available.

isp
string

Internet Service Provider (ISP) name, if available.

country
string <= 2 characters

Country ISO Alpha-2 code of the specified IP address.

region
string

Region of the specified IP address.

city
string

City of the specified IP address.

latitude
number <double>

Latitude of the specified IP address.

longitude
number <double>

Longitude of the specified IP address.

postalCode
string <= 10 characters

Postal code of the specified IP address.

timeZone
string

Time zone of the specified IP address.

accuracyRadius
integer

Accuracy radius of the specified IP address, in kilometers.

distance
integer

Distance between the customer's IP address and the billing address geolocation, in kilometers.

hasMismatchedBillingAddressCountry
boolean

Specifies whether the customer's billing address country and geo-IP address are not the same.

hasMismatchedBankCountry
boolean

Specifies whether the customer's bank country and geo-IP address are not the same.

hasMismatchedTimeZone
boolean

Specifies whether the customer's browser time zone and the IP address associated time zone are not the same.

hasMismatchedHolderName
boolean

Specifies whether the customer's billing address name and primary address name are not the same.

hasFakeName
boolean

Specifies whether the holder name seems fake.

isHighRiskCountry
boolean

Specifies whether the 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.

declinedPaymentInstrumentVelocity
integer

Number of declined transactions for this payment instrument 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

Computed risk score based on all factors.

Array of Self (object) or CustomerLink (object) or AuthTransactionLink (object) or ApprovalUrlLink (object) non-empty

Related resource links.

Array (non-empty)
Any of:
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
Array of AuthTransactionEmbed (object) or CustomerEmbed (object) non-empty

Available embedded objects that are requested by the expand querystring parameter.

Array (non-empty)
Any of:

Auth transaction object.

object (Transaction)
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/payment-instruments
Request samples
$paymentInstruments = $client->paymentInstruments()->search([
    'filter' => 'status:active;method:payment-card',
]);
Response samples
application/json
[
  • {
    }
]