Integration Guide
Start typing to search…

Gateway playground SERVER-TO-SERVER

This page describes how to use the gateway playground for SERVER-TO-SERVER requests.

If you are going to create a SERVER-TO-SERVER integration, you must have your own PCI DSS-compliant environment.

🚧

PCI -DSS 4.x

Your website payment pages must comply with PCI DSS v4.x.
For more details, see Gateway PCI documentation


Make a request in the gateway playground for SERVER-TO-SERVER

To use the test environment for SERVER-TO-SERVER integrations to perform a standard request.

  1. Go to the documentation at Gateway SERVER-TO-SERVER documentation
  2. Select Synchronous
  3. Select Preauthorization and Capture or Debit
  4. Select VISA or MASTER
  5. Select Playground
    1. After Bearer enter your own API Auth key.
    2. For the entityId enter your own channel ID.
    3. You can use the other parameters from the sample requests linked below.
    4. Click Try it Out.

3DS verification

To perform 3DS verification in the gateway test environment, you must make a standalone 3DS request before you make the payment.

  1. Use the Gateway standalone 3DS request with the parameters for a payment with gateway 3DS, but remove the paymentType parameter.
  2. Get the results of the 3DS verification to use in the payment request. You will need the dsTransactionId, acsTransactionId, and verificationId.
  3. After you process the 3DS request, use the standard payment request at Gateway SERVER-TO-SERVER documentation with the parameters for merchant 3DS.

Get the payment status and manage payments

To get the payment status, use the request to get a payment at Gateway documentation asynchronous payment under section 3. Get the payment status.

To manage payments, use the Back office API. See Backoffice API operations


Example gateway playground ata

Single or initial payment with gateway 3DS

SERVER-TO-SERVER request to create a single payment using the gateway MPI for 3DS. You must include additional parameters for instalments, subscriptions, or metered payments.

See Single or initial payment with gateway 3DS

Single or initial payment with merchant 3DS

SERVER-TO-SERVER request to create a single payment when using your own MPI for 3DS. You must include additional parameters for instalments, subscriptions, or metered payments.

See Single or initial payment with merchant 3DS

Repeated payments base parameters

SERVER-TO-SERVER requests to collect a repeated payment for instalments, subscriptions, and metered payments.

See Repeated payment

Single payment without 3DS

Here is an example of a SERVER-TO-SERVER request to create a single payment without 3DS.

👍

We recommend that you always use a 3DS challenge

entityId={non-3DS_or_MOTO_channelId}
amount=20.00
currency=EUR
paymentType=DB
merchantTransactionId=P223
paymentBrand=MASTER
card.number=5200000000000049
card.holder=Joe Smith
card.expiryMonth=05
card.expiryYear=2030
card.cvv=123
billing.street1=Calle Principal 123
billing.city=Barcelona
billing.country=ES
billing.postcode=08123
[email protected]
customer.ip=2001:8a0:7f4b:1b00:dd4e:2bf6:1fb8:56af
customer.givenName=Joe
customer.surname=Smith
customer.phone=34667666666
customer.merchantCustomerId=CUST11
threeDSecure.exemptionFlag=01
customParameters[3DS2_flow]=frictionless
shopperResultUrl=https://example.com/
testMode=EXTERNAL

For the entityId, use your non-3DS channel ID or MOTO channel ID.

For values of the threeDSecure.exemptionFlag, see https://cardcorp.docs.oppwa.com/integrations/server-to-server/standaloneexemption.

Save the customer's card in the gateway

Use the following additional parameter to save a customer card in the gateway.

createRegistration=true

When the payment is approved, get the registrationId from the response object and the 3DS data.

Repeated payment with saved card

See Repeated payment in the SERVER-TO-SERVER section.