Gateway-Specific Requirements

This page is part of the REST API Guides. Using the JavaScript library instead? See Payments Library Guides.

Some payment gateways require additional parameters or have unique configuration requirements. This page documents gateway-specific details you may need when integrating.

These requirements apply when using the REST API directly. The Payments Library handles most of these automatically.

Adyen

The ShopperInteraction parameter specifies the sales channel and whether the customer is returning.

{
  "paymentGatewayAccount": {
    "paymentGatewayName": "Adyen",
    "credentials": [
      { "Key": "ApiKey", "Value": "..." },
      { "Key": "MerchantAccount", "Value": "..." },
      { "Key": "ShopperInteraction", "Value": "Ecommerce" }
    ]
  }
}

For POS accounts, set ShopperInteraction to "Ecommerce".

AMEX

The myRef parameter is required and must contain 6 or more characters.

{
  "myRef": "ORDER123456"
}

Authorize.net

The ECCenabled parameter controls refund behavior:

Value	Behavior
`true`	Full card details sent with refund requests
`false`	Refunds not possible after 120 days from original charge

{
  "paymentGatewayAccount": {
    "paymentGatewayName": "AuthorizeNet",
    "credentials": [
      { "Key": "ApiLoginId", "Value": "..." },
      { "Key": "TransactionKey", "Value": "..." },
      { "Key": "ECCenabled", "Value": "true" }
    ]
  }
}

Cardstream

Cardstream uses the OrderDesc parameter to provide additional order description.

{
  "orderDesc": "Premium subscription - 12 months"
}

Caterpay

Caterpay uses the OrderDesc parameter to provide additional order description.

{
  "orderDesc": "Premium subscription - 12 months"
}

Credorax

Credorax requires integration certification. Orchestra’s integration is certified with Credorax. Contact support@orchestrasolutions.com if you need certification documentation.

Elavon

Include the RebatePWD (rebate password) in your credentials:

{
  "paymentGatewayAccount": {
    "paymentGatewayName": "Elavon",
    "credentials": [
      { "Key": "MerchantId", "Value": "..." },
      { "Key": "Password", "Value": "..." },
      { "Key": "RebatePWD", "Value": "your_rebate_password" }
    ]
  }
}

First Data (FirstDataIPG)

First Data requires:

Client certificate authentication - Upload your certificate through the Orchestra Portal
Client IP address - Provide in the PayerDetails object

{
  "payerDetails": {
    "clientIPAddress": "192.168.1.1"
  },
  "certificateName": "your-uploaded-certificate-name"
}

Gateline

Gateline has the same requirements as First Data:

Client certificate authentication - Upload via portal
Client IP address - Required in PayerDetails

{
  "payerDetails": {
    "clientIPAddress": "192.168.1.1"
  },
  "certificateName": "your-uploaded-certificate-name"
}

Global Payments WebPay

The myRef parameter must be a 15-digit numeric value.

{
  "myRef": "123456789012345"
}

Heartland

Heartland has two requirements:

myRef must be numeric only (no letters or special characters)
Integration certification required - Orchestra’s integration is certified

{
  "myRef": "123456789"
}

Kortapay

Void and Refund operations on Kortapay need the original transaction amount. This is configured with Orchestra rather than passed as a request field.

Contact Support

Email support@orchestrasolutions.com to set up Kortapay Void/Refund requirements for your account.

PayGate

Your PayGate merchant account must have the “auto-settle” flag set to “off”. Configure this in your PayGate merchant dashboard before integrating.

Pesopay

Pesopay has two requirements:

myRef must be unique on every submission
Void operations must use the GatewayReference from the PreAuth response, not Capture

{
  "myRef": "UNIQUE-REF-20240115-001"
}

Stripe (PaymentIntent)

3D Secure Support

To enable 3DS transactions, contact Stripe and request enabling the payment_method_options.card.request_three_d_secure option on your account.

Subscriptions

Use the SetupFutureUsage parameter to enable Stripe Subscriptions:

{
  "paymentGatewayAccount": {
    "paymentGatewayName": "StripePaymentIntent",
    "credentials": [
      { "Key": "SecretKey", "Value": "sk_live_..." },
      { "Key": "SetupFutureUsage", "Value": "off_session" }
    ]
  }
}

Value	Use Case
`on_session`	Customer present during future charges
`off_session`	Recurring/subscription charges without customer

Wirecard

Wirecard uses the OrderDesc parameter to provide additional order description.

{
  "orderDesc": "Premium subscription - 12 months"
}

Worldpay

Worldpay has two requirements:

IsDigital parameter - Required, defaults to true
Integration certification required - Orchestra’s integration is certified

{
  "isDigital": true
}

Zeamster

Zeamster uses the OrderDesc parameter to provide additional order description.

{
  "orderDesc": "Premium subscription - 12 months"
}

Zoop

Zoop supports splitting payments into installments (micro credit). This is configured with Orchestra rather than passed as a request field.

Contact Support

Email support@orchestrasolutions.com to set up Zoop installment support for your account.

Payment Operations

Full endpoint documentation

Payment Gateway Accounts

Configure gateway credentials

Start Here

Beyond the Quickstart

Concepts

Orchestra Payments Library Guides

Orchestra REST API Guides

Utilities

Merchant Account Setup

Support

Changelog

Adyen

AMEX

Authorize.net

Cardstream

Caterpay

Credorax

Elavon

First Data (FirstDataIPG)

Gateline

Global Payments WebPay

Heartland

Kortapay

Contact Support

PayGate

Pesopay

Stripe (PaymentIntent)

3D Secure Support

Subscriptions

Wirecard

Worldpay

Zeamster

Zoop

Contact Support

Payment Operations

Payment Gateway Accounts

​Adyen

​AMEX

​Authorize.net

​Cardstream

​Caterpay

​Credorax

​Elavon

​First Data (FirstDataIPG)

​Gateline

​Global Payments WebPay

​Heartland

​Kortapay

Contact Support

​PayGate

​Pesopay

​Stripe (PaymentIntent)

​3D Secure Support

​Subscriptions

​Wirecard

​Worldpay

​Zeamster

​Zoop

Contact Support

​Related

Payment Operations

Payment Gateway Accounts

Adyen

AMEX

Authorize.net

Cardstream

Caterpay

Credorax

Elavon

First Data (FirstDataIPG)

Gateline

Global Payments WebPay

Heartland

Kortapay

PayGate

Pesopay

Stripe (PaymentIntent)

3D Secure Support

Subscriptions

Wirecard

Worldpay

Zeamster

Zoop

Related