Skip to content
Sencai Logo Sencai Logo Sencai Docs

Create a payment-gateway

POST
/payment-gateways

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
data
object
users_permissions_user
One of:

DocumentId reference to plugin::users-permissions.user

string
amount
required
number
currency
required
string
Allowed values: EUR USD CZK PLN HUF RON BGN SEK DKK NOK
state
required
string
Allowed values: pending processing completed failed cancelled refunded
payment_method
required
string
Allowed values: stripe free bank_transfer
stripe_session_id
string
stripe_payment_intent_id
string
transaction_id
string
gateway_response

Arbitrary JSON value (object, array, string, number, boolean, or null)

error_message
string
processed_at
string format: date-time
refunded_at
string format: date-time
refund_amount
number

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Created

object
data
object
users_permissions_user
One of:

DocumentId reference to plugin::users-permissions.user

string
amount
required
number
currency
required
string
Allowed values: EUR USD CZK PLN HUF RON BGN SEK DKK NOK
state
required
string
Allowed values: pending processing completed failed cancelled refunded
payment_method
required
string
Allowed values: stripe free bank_transfer
stripe_session_id
string
stripe_payment_intent_id
string
transaction_id
string
gateway_response

Arbitrary JSON value (object, array, string, number, boolean, or null)

error_message
string
processed_at
string format: date-time
refunded_at
string format: date-time
refund_amount
number
documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
nullable

400

Section titled “400 ”

Validation error

401

Section titled “401 ”

Missing or invalid authentication

403

Section titled “403 ”

Not authorized (tenant scope or capability)