List payment methods

get

https://api.sandbox.rainforestpay.com/v1/payment_methods

Query a list of payment methods given optional search criteria.

Query Params

billable_merchant_id

string

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.

fingerprint

string

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

method_type

string

enum

Payment method type to filter by. Provide parameter multiple times to filter by multiple payment method types.

Allowed:

status

array of strings

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

status

metadata

string

Filter by metadata stored on the entity by passing a map of key-value pairs to filter on. The key should be valid JSONPath to a corresponding metadata key.

For example, an entity created with the following metadata

"account": {
  "id": "acct_123"
}

could have the following metadata filter to find entities with the metadata account id:

?metadata[$.account.id]=acct_123

created_at.start

date-time

Created on or after in UTC RFC 3339 format.

created_at.end

date-time

Created on or before in UTC RFC 3339 format.

updated_at.start

date-time

Last updated on or after in UTC RFC 3339 format.

updated_at.end

date-time

Last updated on or before in UTC RFC 3339 format.

replaced_at.start

date-time

Replaced on or after in UTC RFC 3339 format.

replaced_at.end

date-time

Replaced on or before in UTC RFC 3339 format.

replacement_disabled.start

date-time

Replacement disabled on or after in UTC RFC 3339 format.

replacement_disabled.end

date-time

Replacement disabled on or before in UTC RFC 3339 format.

sort_by

string

enum

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

Allowed:

sort_order

string

enum

Order in which to return the sorted results; ascending or descending. Default sort order is descending.

Allowed:

limit

number

≤ 1000

Defaults to 1000

The maximum number of results to return.

offset

number

≥ 0

Defaults to 0

The offset of the first result to return; zero-based.

Headers

Rainforest-Api-Version

string

enum

Defaults to 2024-10-16

Allowed:

Responses

200OK

400Bad request, check for validation errors.

401Authorization missing or invalid.

403Authorization insufficient for requested action.

5XXUnexpected error.