Payments. 8 operations.
8 of them work. Each needs a bearer token with its scope. All operations.
Operations
POST/api/v1/payments/gateways/{gateway}/logo/deletepayments.clear-gateway-logopayments.write
GET/api/v1/payments/gatewayspayments.gatewayspayments.read
POST/api/v1/payments/gateways/{gateway}payments.set-gatewaypayments.write
POST/api/v1/payments/gateways/{gateway}/keypayments.set-gateway-keypayments.write
POST/api/v1/payments/gateways/{gateway}/logopayments.set-gateway-logopayments.write
POST/api/v1/payments/livepayments.set-livepayments.write
GET/api/v1/payments/settingspayments.settingspayments.read
Schemas 8
GatewayInfo
GatewayInfo is one enabled payment gateway as the owner sees it: its name, as store.yaml's payment.gateways names it; whether it takes real money (payment.live); and the capabilities it declares, as names them and in its order. A reserved capability never shows.
capabilitiesrequired | array of string |
liverequired | boolean |
namerequired | string |
GatewayKey
GatewayKey is one key field of a gateway in one mode, test or live: whether it is set, its last four characters when it is long enough, and who saved it and when. A key is write-only: no operation gives it back.
fieldrequired | string |
last4 | string |
moderequired | string |
saved_at | string (date-time) |
saved_by | string |
setrequired | boolean |
GatewayKeyRequest
GatewayKeyRequest sets a gateway's key of a mode, test or live, and a field; an empty value clears it.
fieldrequired | string |
moderequired | string |
valuerequired | string |
GatewaySettings
GatewaySettings is one gateway's settings: its name; whether it is enabled; its position on the checkout, from 1; its mode, test or live, which the live switch sets, or offline for a gateway that takes no money online and so has no test or live keys (ModeOffline); the label buyers see in place of its own ("" for its own); its keys; who saved its settings and when (none while store.yaml's rules); and, for the cash on delivery gateway, whether the checkout can offer it now.
capabilitiesrequired | array of string |
enabledrequired | boolean |
keysrequired | array of GatewayKey |
labelrequired | string |
logorequired | string |
moderequired | string |
namerequired | string |
not_offered_reason | string |
offeredrequired | boolean |
positionrequired | integer |
saved_at | string (date-time) |
saved_by | string |
GatewaySettingsRequest
GatewaySettingsRequest changes a gateway's settings: each field it sets; one it leaves out stays as it is. A move to a position moves the others along.
enabled | boolean |
label | string |
position | integer |
LiveRequest
LiveRequest sets the store's live switch; Confirm must be true, either way: on, real cards are charged; off, no real money is taken.
confirmrequired | boolean |
liverequired | boolean |
PaymentSettings
PaymentSettings are the payment settings as the owner sees them: the store's live switch (payment.live), whether the owner saved it, by whom and when (none while store.yaml's rules), and every gateway the engine knows, by position.
gatewaysrequired | array of GatewaySettings |
liverequired | boolean |
live_savedrequired | boolean |
live_saved_at | string (date-time) |
live_saved_by | string |
UnmatchedNotification
UnmatchedNotification is one payment event, of a notification the store accepted, that named no order the store holds: the notification's id and gateway, when it came, the event, the reference it named, and why it matched nothing. It holds no secret and no body.
eventrequired | string |
gatewayrequired | string |
idrequired | integer |
reasonrequired | string |
receivedrequired | string (date-time) |
referencerequired | string |
Made from engine/internal/openapi/openapi.json at commit 6c4cbd921. The contract-only operations come from the engine’s stub file, engine/internal/ops.