Sign in
latestSwagger 2.0ShopBase Dev 1.02026-08-10153268547.4 KB

353ccde6240d

Payment Simulator

Capture, refund or void handler

post/admin/payment-simulator/action.json

Request body

x_account_idstring

Login id of merchant in payment settings

x_amountnumber

Order's amount

x_currencystring

Order's currency

x_gateway_referencestring

Unique reference for payment issued by the payment processor.

x_invoicestring

Only available on request type = capture

x_referencestring

Unique token for current checkout

x_signaturestring

See Signing mechanism

x_transaction_typestring

The valid values are capture, refund, void, get.

x_url_callbackstring

URL to which a callback notification should be sent asynchronously.

Response

OK

x_account_idstring

Login id of merchant in payment settings

x_amountnumber

Order's amount

x_currencystring

Order's currency

x_error_codestring

An error code to be log on Shopbase

x_gateway_referencestring

Unique reference for payment issued by the payment processor.

x_intentstring
x_messagestring

A custom error message displayed to the customer.

x_referencestring

Unique token for current checkout

x_resultstring

Valid values are completed or failed

x_signaturestring

Signed signature

x_testboolean

Indicates whether or not this request should be processed in test mode (if supported).

x_timestampstring

Time of transaction completion. UTC Time: YYYY-MM-DDTHH:MM:SSZ

{"stackTrail":"components:schemas:PaymentResponseDto:properties:x_transaction_type","oasType":"schema","type":"unknown","description":"The valid values are `capture`, `refund`, `void`, `get`.\n* **capture**: Capture the payment.\n* **refund**: Refund the payment.\n* **void**: Cancel the payment.\n* **get**: Get the payment."}