List payment methods

GET/v1/api/store/{team_slug}/setting/payment_method

v1Operation ID v1_public_payment_method_index

Returns all the team's payment methods in one list, including deleted ones (trashed: true).

Payment methods are the labels for payments you record yourself, such as Cash, Check or Bank Transfer. A manual payment on a sales order and a customer credit deposit name one with payment_method_id, and payment webhooks report it as payment_method_name. Card payments through a payment gateway are separate.

Permission

Any team member can call it. Reading needs no extra permission.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (5)

  • created_atstring (date-time)required
  • defaultbooleanrequired

    Whether it is the team's default payment method.

  • idstringrequired
  • namestringrequired
  • trashedbooleanrequired

    True for a deleted payment method.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Related

• POSTCreate a payment method/v1/api/store/{team_slug}/setting/payment_method
• POSTRecord a payment on a sales order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/setting/payment_method' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": [
    {
      "created_at": "2026-11-03T15:00:00+00:00",
      "default": false,
      "id": "XbLngLA87AC5t5",
      "name": "Bank Transfer",
      "trashed": false
    }
  ],
  "status": 200,
  "success": true
}