Create a payment method

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

v1Operation ID v1_public_payment_method_store

Creates a payment method and returns it. default: true makes it the team default.

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

Needs the Manage Settings permission.

Business rules

• name is required. Names don't have to be unique.

Path parameters

• team_slugstringrequired

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

  • Example your-team

Request body

application/json, required.

• namestringrequired
• defaultboolean

  true makes it the team's default payment method. false does nothing.

Response

200Successful response.

• dataobjectrequired
  Child fields (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).

  When

  The API key is missing or wrong.

  Fix

  Send your personal API key as Authorization: Bearer YOUR_API_KEY.

• 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.

  When

  Your permission group lacks Manage Settings. This 403 has a short body, {"message": "Insufficient Permission"}, without success or error.

  Fix

  Ask the team owner to give your permission group Manage Settings.

• 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.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  name is missing. error.code is validation_failed, and error.fields names each field with its messages.

  Fix

  Fix the fields listed in error.fields and send the request again.

Related

• GETList payment methods/v1/api/store/{team_slug}/setting/payment_method

Example request

curl

curl -X POST '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' \  -H 'Content-Type: application/json' \  -d '{    "name": "Check"  }'

Example response 200

Response

{
  "data": {
    "created_at": "2026-11-03T15:00:00+00:00",
    "default": false,
    "id": "LOB1scuXDnIQbo",
    "name": "Check",
    "trashed": false
  },
  "status": 200,
  "success": true
}