Search Payment Methods by External Reference

Returns the payment methods in your organization carrying the given external reference, which is the identifier your own system holds against a Root payment method.

External references are not required to be unique, so this is a search and returns a list. A reference that matches nothing returns 200 with an empty list and X-Total-Count: 0, not a 404. Any payment method type can carry a reference, so the search is not restricted by type.

Use this to find a payment method's payment_method_id when your system holds only the reference, for example before correcting it with PATCH /payment-methods/{payment_method_id}. A reference containing characters that are significant in a URL, such as a forward slash, must be percent encoded in the path.

Dismissed payment methods are left out unless you ask for them with dismissed=true. A dismissed payment method keeps the reference it was created with, so a reference that was reused after a dismissal would otherwise return both and leave you to guess which one to act on. This differs from GET /payment-methods, which returns both unless you filter.

Path Params
string
required

The external reference to search for. Matched in full, not as a prefix.

Query Params
boolean
Defaults to false

Set to true to return only dismissed payment methods carrying the reference. Omit it to return only payment methods that are not dismissed, which is the default for this endpoint.

integer
Defaults to 1

The page number to retrieve.

integer
Defaults to 20

The number of items to retrieve per page.

Response

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json