Skip to main content
POST
Create payment_methods

Authorizations

Authorization
string
header
required

API key from Developers → API Keys, sent as Authorization: Bearer .

Headers

Idempotency-Key
string

Any unique string (≤255 chars). A retry with the same key within 24 hours replays the original response (Idempotent-Replayed: true) instead of creating a second record.

Maximum string length: 255

Body

application/json
name
string
required

The method's display name — Cash, Bank Transfer, a custom method.

Maximum string length: 255
active
boolean

Only an active method can be recorded against a payment (422 payment_method_inactive otherwise). Deactivate instead of deleting — there is no DELETE.

sort_order
integer | null

Position in the app's payment method lists.

metadata
object

Integrator-owned key/value metadata (max 50 keys). Values are strings (≤500 chars), numbers or booleans and read back with the type they were written with. On write, a null value removes the key. Filter with metadata[key]=op:value; number operands compare numerically.

Response

The resource

data
object
Example: