API Transactions with Magento

  How to access

  1. Sign in to your Store Admin.
  2. On the Admin Sidebar, click the Trust Payments logo.
  3. Navigate to Stores > Configuration.
  4. On the next page, navigate to Sales > Payment Methods.
  5. On the next page, expand the "OTHER PAYMENT METHODS" section, then click the "Configure" button next to the Trust Payments extension.
  6. Expand the "API" section.


Screenshot of Trust Payments extension settings


  This plug-in only supports 3-D Secure versions 1 & 2 using the CardinalCommerce MPI provider. Please ensure that your Trust Payments account is configured to process EMV 3-D Secure.


Required settings

Expand "Required Settings" to view the settings you can configure.


Enabled: Set to “Yes” to enable this payment method to be displayed in checkout.

Animated card: When enabled, this will display an illustration of the card on screen that updates in real time as the customer fills out their card details.


Title: Enter the title of this payment method to be displayed on the checkout.


AccountCheck: An Account Check request allows a card to be validated by checking the cardholder’s first line of address, the cardholder’s postcode and the security code, to ensure the details entered by the customer match those stored on the issuing bank's records.

Test Environment: Use this setting to switch between test and live environments.

Site Reference: You must enter your unique Trust Payments site reference.

  When setting up the Magento extension for the first time, it is strongly recommended that you specify your test site reference (e.g. “test_site12345”) in the "Site Reference" field. This allows you to process test payments to our test bank to ensure your implementation works as expected. When you are ready to go live, you will need to change this to be your live site reference (e.g. “site24680”).

Web Services Username and Web Services Password: Enter your Webservices username and password in these fields. This is required to authenticate your requests with Trust Payments. If you do not have a Webservices user account, click here for instructions on how to register one.

JWT Username and JWT Secret Key: You will need a user account with the role “Webservices JWT” to create the token. If this user account has not already been provided, please request that one is created for your site reference by contacting our Support Team.

  The contents of fields "Web Services Password", "JWT Secret Key" & "Site Security Password" are masked with * for security reasons.


Optional settings

Expand "Optional Settings" to view the settings you can configure.


Alternative Payment Methods (APM)



To configure PayPal, first click here and follow the instructions provided to enable this on your site reference. Once configured, set “Enable PayPal Payment” to “Yes” and enter your “Merchant Id”.


  Apple Pay

To start processing Apple Pay transactions, first click here and the instructions provided to generate the Payment Processing Certificate and Merchant Identity Certificate, and also to enable Apple Pay on your site reference.

Once the above has been completed, set “Enable Apple Pay” to “Yes” and enter your “Merchant Id”.

Follow the instructions provided here to register and verify your domain with Apple. This process requires signing in to the Apple Developer site and downloading a txt file provided by Apple, then uploading it to the "Domain Association" found in the Apple Pay settings in Magento.


  Google Pay

To begin your integration with Google Pay, you will need to confirm/request the following details from
our Support Team.

  • Confirm your acquiring bank supports Google Pay as a payment option.
  • Ensure Google Pay is enabled on your site reference.
  • Ensure you have a valid JWT username and Secret.

To start testing Google Pay transactions, follow the steps below:

  • Set “Enable Google Pay" to “Yes”.
  • Provide your "Merchant Id" (this is provided by Google).
  • Set your "Merchant Name" to be your company name (e.g. "My Company Ltd.").
  • Select your "Allowed Payment Types." If you do not know this, please contact our Support Team to confirm.
  • Finally, customise the appearance of the Google Pay button by selecting the options available within "Button Type" and "Button Color".

When configured correctly, the Google Pay button will be displayed on your checkout.


Tokenization Settings

Use Tokenization: Enabling this feature allows your customers to store their card for future use.


To enable this, please select “Yes”. When enabled, this will display a tick box on the selected payment method to give the customer the option to store their payment card for future purchases on your site reference.


Following a successful transaction when the customer opted to save their card for later, the saved card(s) should look like this on their next checkout:



Other Settings


Application Countries: This payment method can be enabled for all countries or for a specified subset of countries.

Payment Action: Gives you the ability to allow Authorize Only payments or Authorize & Capture.
If Authorize Only is selected, processed payments will initially be shown as “Pending” in the Store Admin (and “Suspended" in MyST) until actioned.

  The transaction will be suspended in MyST and will not be captured by your acquiring bank unless action is taken. Admin must manually create the invoice to capture. If action is not taken after 7 days, the transaction will be cancelled. Click here to learn more about Payment Action types.

Settle Status and Settle Due Date: If Authorize & Capture is the selected "Payment action", you will need to set a value for “Settle Status” and “Settle Due Date”. This means the invoice will be created following a successful transaction.


Subscription URL Notification: Enter the URL to which a URL notification will be sent from Trust Payments, containing information on the scheduled subscription. The URL will follow the format: siteURL/securetrading/subscription/notificationresponse (i.e: https://www.example.com/url?q=https://mysite.com/securetrading/subscription/notificationresponse)


Show Icon: When enabled, a payment extension logo will be displayed next to the API payment method (this logo is defined in the "API Secure Trading Logo" setting described below).

API Secure Trading Logo: Choose an image you wish to display next to the API payment method on your checkout.

Sort Order: The ordering of the payment methods on your checkout. The value ‘1’ will cause the API payment method to be displayed first.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request