Skip to main content
POST
Create manual payment method

Authorizations

Authorization
string
header
required

Sign in to the admin dashboard and use the resulting ID token for a store and operation you can access. The authenticated dashboard cookie is accepted when the Authorization header is absent. Missing or insufficient access returns 401.

Body

application/json
name
string
required
description
string
required
payment_instructions
string
required
slug
string
mark_as_paid
boolean
default:false

When true, a payment with this method is recorded as paid as soon as it is created, as cash taken at the counter is. Use channels to keep it off channels where shoppers pay by themselves.

channels
string[]

IDs of the sales channels the store offers this method on; an empty list offers it on every channel. Each must be one of the store's storefront channels. When read, IDs of deleted channels are left out, unless all of them were deleted: the method then keeps their IDs and is offered on no channel.

status
enum<string>
default:active

An inactive method is not offered on any channel.

Available options:
active,
inactive

Response

OK

message
string
required
success
boolean
required
content
object
required