latestSwagger 2.0ShopBase Dev 1.02026-08-10153268547.4 KB

353ccde6240d

Payment Simulator

Get transaction

get/admin/payment-simulator/transaction.json

Query parameters

x_account_idstring required

x_referencestring required

Unique token for current checkout

x_signaturestring required

Signed signature

x_testboolean required

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

x_transaction_typestring required

The valid values are capture, refund, void, get. <ul><li>capture: Capture the payment.</li><li>refund: Refund the payment.</li><li>void: Cancel the payment.</li><li>get: Get the payment.</li></ul>

x_gateway_referencestring required

This will only be present in order management

Response

x_account_idstring

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."}