Sign in
Payment Methods

List payment methods

Query a list of payment methods given optional search criteria.

get/v1/payment_methods

Query parameters

billable_merchant_idstring

The unique merchant identifier for the billable merchant, utilized in processes such as BIN Lookup and Card Account Updater.

Prefix is "mid" in production and "sbx_mid" in sandbox.

fingerprintstring

The unique identifier of a payment method across all platform merchants.

statusstring[]

One or more payment method statuses to filter by. Provide parameter multiple times to filter by multiple payin status types.

ACTIVE CANCELED CREATED DEACTIVATED FAILED PRESENTING REPLACED

[
  "ACTIVE"
]
updated_at.startstring date-time

Last updated on or after in UTC RFC 3339 format.

updated_at.endstring date-time

Last updated on or before in UTC RFC 3339 format.

replaced_at.startstring date-time
Example:2022-01-01T12:00:00Z

Replaced on or after in UTC RFC 3339 format.

replaced_at.endstring date-time
Example:2022-01-01T12:00:00Z

Replaced on or before in UTC RFC 3339 format.

replacement_disabled.startstring date-time
Example:2022-01-01T12:00:00Z

Replacement disabled on or after in UTC RFC 3339 format.

replacement_disabled.endstring date-time
Example:2022-01-01T12:00:00Z

Replacement disabled on or before in UTC RFC 3339 format.

sort_by'created_at' | 'status'

Optional value by which to sort the result set. Default sort by is created_at.

Parameters

#/paths/~1v1~1payins/get/parameters/0 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/3 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/7 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/8 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/9 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/13 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/14 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/15 — unresolved $ref
#/paths/~1v1~1payins/get/parameters/16 — unresolved $ref

Response

OK

statusStatus — unresolved $ref
errorsErrors — unresolved $ref

Changes