Tillwire Read the guide
API reference

Payments. 8 operations.

8 of them work. Each needs a bearer token with its scope. All operations.

Operations

GET/api/v1/payments/gatewayspayments.gatewayspayments.read

Answer

array of GatewayInfo

Errors: 401, 403, 405, 422, 429

curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/payments/gateways

POST/api/v1/payments/gateways/{gateway}payments.set-gatewaypayments.write

Parameters

gatewaypathstring
gatewaypathstring
Idempotency-KeyheaderstringSee common parameters

Errors: 401, 403, 404, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/payments/gateways/{gateway}

POST/api/v1/payments/gateways/{gateway}/keypayments.set-gateway-keypayments.write

Parameters

gatewaypathstring
gatewaypathstring
Idempotency-KeyheaderstringSee common parameters

Request body

GatewayKeyRequest

Errors: 401, 403, 404, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/payments/gateways/{gateway}/key

POST/api/v1/payments/livepayments.set-livepayments.write

Parameters

Idempotency-KeyheaderstringSee common parameters

Request body

LiveRequest

Errors: 401, 403, 405, 409, 413, 422, 429

curl -X POST -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/payments/live

GET/api/v1/payments/settingspayments.settingspayments.read

Errors: 401, 403, 405, 422, 429

curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/payments/settings

GET/api/v1/payments/unmatchedpayments.unmatchedpayments.read

Answer

array of UnmatchedNotification

Errors: 401, 403, 405, 422, 429

curl -X GET -H "Authorization: Bearer $TOKEN" https://yourshop.example/api/v1/payments/unmatched

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.

capabilitiesrequiredarray of string
liverequiredboolean
namerequiredstring
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.

fieldrequiredstring
last4string
moderequiredstring
saved_atstring (date-time)
saved_bystring
setrequiredboolean
GatewayKeyRequest

GatewayKeyRequest sets a gateway's key of a mode, test or live, and a field; an empty value clears it.

fieldrequiredstring
moderequiredstring
valuerequiredstring
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.

capabilitiesrequiredarray of string
enabledrequiredboolean
keysrequiredarray of GatewayKey
labelrequiredstring
logorequiredstring
moderequiredstring
namerequiredstring
not_offered_reasonstring
offeredrequiredboolean
positionrequiredinteger
saved_atstring (date-time)
saved_bystring
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.

enabledboolean
labelstring
positioninteger
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.

confirmrequiredboolean
liverequiredboolean
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.

gatewaysrequiredarray of GatewaySettings
liverequiredboolean
live_savedrequiredboolean
live_saved_atstring (date-time)
live_saved_bystring
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.

eventrequiredstring
gatewayrequiredstring
idrequiredinteger
reasonrequiredstring
receivedrequiredstring (date-time)
referencerequiredstring

Made from engine/internal/openapi/openapi.json at commit 6c4cbd921. The contract-only operations come from the engine’s stub file, engine/internal/ops.