API Reference

List payment methods

get
https://app.shuttleglobal.com/c/api/instances/{instance_key}/payment_methods

Search and list payment method objects with various filtering criteria.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Search criteria for filtering payment methods. Available fields:

  • id
  • account
  • bin
  • code
  • created
  • expiry
  • failing_since
  • gateway
  • last4
  • last_used
  • mandate_reference
  • source
  • status
  • sub_status
  • token
  • type
  • updated

Examples:

  • account=acc_12345_67890
  • status=ACTIVE
  • type=VISA
  • expiry<>2024-01;2024-12
string

Sort order for results. Supports any field that criteria supports. Defaults to created;desc if not specified. Append ;desc for descending order. Separate multiple order fields with commas.

Examples:

  • order=last_used;desc
  • order=type,created;desc
string

Fields to expand into full objects. Separate multiple fields with commas.

Available fields:

  • account (account object)
  • bin (card BIN object)
  • gateway (gateway object)
  • created_session (session object)
  • updated_session (session object)

Example: expand=account,gateway

integer

Maximum number of records to return

integer

Offset from first record

Responses

Updated about 2 months ago

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

Updated about 2 months ago