Preamble

This API enables PCI-compliant merchants to send transactions containing card data directly, without requiring them to use the payment.js tokenization or hosted payment page.

The API solely supports card transactions. For any other kind of payment method (e.g. PayPal, DirectDebit etc.) please refer to the Regular API.

TransactionWithCard - Request

The TransactionWithCard Gateway API expects an HTTP POST request with XML Payload and an Authentication header containing a Hash HMAC signature (see Signing Requests below).

The destination URL is: https://secure.ixopay.com/transaction

Basic scheme

<?xml version="1.0" encoding="utf-8"?>
<transactionWithCard xmlns="https://secure.ixopay.com/Schema/V2/TransactionWithCard">
  <username>YOUR_USERNAME</username>
  <password>SHA1 HASHED PASSWORD</password>
  <cardData>
    <cardHolder>test test</cardHolder>
    <pan>4111111111111111</pan>
    <cvv>123</cvv>
    <expirationMonth>12</expirationMonth>
    <expirationYear>2021</expirationYear>
  </cardData>
  <debit>
    <transactionId>Your Transaction ID</transactionId>
    <customer>
      <!-- refer to Transaction Data for all available fields -->
      <identification>Customer ID</identification>
      <billingCountry>2-letter country code of your customer</billingCountry>
      <email>email address of your customer</email>
      <ipAddress>127.0.0.1</ipAddress>
    </customer>
    <amount>9.99</amount>
    <currency>EUR</currency>
    <description>Transaction Description</description>
    <successUrl>https://link.to/your/payment-successful-page</successUrl>
    <cancelUrl>https://link.to/your/payment-canceled-page</cancelUrl>
    <errorUrl>https://link.to/your/payment-failed-page</errorUrl>
    <callbackUrl>https://link.to/your/notification-handler</callbackUrl>
    <withRegister>false</withRegister>
  </debit>
</transactionWithCard>

The examples show the basic data most connector requires. Depending on the connector type more data could be necessary. Please refer to the Connector Types documentation for concrete requirements.

To see all available fields please refer to Transaction Data.

For some languages we already provide a ready-to-use client implementation on GitHub.

For password hashing please see chapter Authentication

Debit

<?xml version="1.0" encoding="utf-8"?>
<transactionWithCard xmlns="https://secure.ixopay.com/Schema/V2/TransactionWithCard">
  <username>API_USER</username>
  <password>5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8</password>
  <cardData>
    <cardHolder>test test</cardHolder>
    <pan>4111111111111111</pan>
    <cvv>123</cvv>
    <expirationMonth>12</expirationMonth>
    <expirationYear>2021</expirationYear>
  </cardData>
  <debit>
    <transactionId>transaction-00001</transactionId>
    <customer>
      <identification>1111</identification>
      <firstName>John</firstName>
      <lastName>Smith</lastName>
      <billingCountry>AT</billingCountry>
      <email>[email protected]</email>
      <ipAddress>123.123.123.123</ipAddress>
    </customer>
    <merchantMetaData>my-category-1</merchantMetaData>
    <amount>4.99</amount>
    <currency>EUR</currency>
    <description>Transaction Description</description>
    <successUrl>https://link.to/your/payment-successful-page</successUrl>
    <cancelUrl>https://link.to/your/payment-canceled-page</cancelUrl>
    <errorUrl>https://link.to/your/payment-failed-page</errorUrl>
    <callbackUrl>https://link.to/your/notification-handler</callbackUrl>
    <withRegister>false</withRegister>
    <transactionIndicator>SINGLE</transactionIndicator>
  </debit>
</transactionWithCard>

curl https://secure.ixopay.com/transaction \
  -d "PUT_XML_HERE" \
  -H "Authorization: Gateway ConnectorKey:Signature" \
  -H "Content-Type: text/xml"

A Debit performs a complete customer-to-merchant payment

POST /transaction/{apiKey}/debit

Path parameters

Recurring Debits (and Preauthorizations)

<?xml version="1.0" encoding="utf-8"?>
<transactionWithCard xmlns="https://secure.ixopay.com/Schema/V2/TransactionWithCard">
  <username>API_USER</username>
  <password>5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8</password>
  <debit>
    <transactionId>transaction-00002</transactionId>
    <customer>
      <identification>1111</identification>
      <firstName>John</firstName>
      <lastName>Smith</lastName>
      <billingCountry>AT</billingCountry>
      <email>[email protected]</email>
      <ipAddress>123.123.123.123</ipAddress>
    </customer>
    <referenceTransactionId>ID-FROM-FIRST-TRANSACTION</referenceTransactionId>
    <amount>4.99</amount>
    <currency>EUR</currency>
    <description>Transaction Description</description>
    <successUrl>https://link.to/your/payment-successful-page</successUrl>
    <cancelUrl>https://link.to/your/payment-canceled-page</cancelUrl>
    <errorUrl>https://link.to/your/payment-failed-page</errorUrl>
    <callbackUrl>https://link.to/your/notification-handler</callbackUrl>
    <transactionIndicator>RECURRING</transactionIndicator> <!-- or CARDONFILE -->
  </debit>
</transactionWithCard>

For recurring charges the initial transaction must either be a Register, or a Debit resp. Preauthorize with the withRegister flag set to true.

You must store the returned referenceId and use for recurring transactions in the field referencedTransactionId.

Preauthorize

<?xml version="1.0" encoding="utf-8"?>
<transactionWithCard xmlns="https://secure.ixopay.com/Schema/V2/TransactionWithCard">
  <username>API_USER</username>
  <password>5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8</password>
  <cardData>
    <cardHolder>test test</cardHolder>
    <pan>4111111111111111</pan>
    <cvv>123</cvv>
    <expirationMonth>12</expirationMonth>
    <expirationYear>2021</expirationYear>
  </cardData>
  <preauthorize>
    <transactionId>transaction-00001</transactionId>
    <customer>
      <identification>1111</identification>
      <firstName>John</firstName>
      <lastName>Smith</lastName>
      <billingCountry>AT</billingCountry>
      <email>[email protected]</email>
      <ipAddress>123.123.123.123</ipAddress>
    </customer>
    <merchantMetaData>my-category-1</merchantMetaData>
    <amount>4.99</amount>
    <currency>EUR</currency>
    <description>Transaction Description</description>
    <successUrl>https://link.to/your/payment-successful-page</successUrl>
    <cancelUrl>https://link.to/your/payment-canceled-page</cancelUrl>
    <errorUrl>https://link.to/your/payment-failed-page</errorUrl>
    <callbackUrl>https://link.to/your/notification-handler</callbackUrl>
    <withRegister>false</withRegister>
  </preauthorize>
</transactionWithCard>

A Preauthorize reserves the payment amount on the customer's payment instrument.

Depending on the payment method you have up to 7 days until you must Capture the transaction before the authorization expires.

POST /transaction/{apiKey}/preauthorize

Path parameters

Capture

<?xml version="1.0" encoding="utf-8"?>
<transactionWithCard xmlns="https://secure.ixopay.com/Schema/V2/TransactionWithCard">
  <username>API_USER</username>
  <password>5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8</password>
  <capture>
    <transactionId>transaction-00002</transactionId>
    <referenceTransactionId>UUID of preauthorize transaction</referenceTransactionId>
    <amount>4.99</amount>
    <currency>EUR</currency>
  </capture>
</transactionWithCard>

A Capture completes the payment which was previously authorized with the Preauthorize method.

Depending on the payment method you can even capture only a partial amount of the authorized amount.

POST /transaction/{apiKey}/capture

Path parameters

Void

<?xml version="1.0" encoding="utf-8"?>
<transactionWithCard xmlns="https://secure.ixopay.com/Schema/V2/TransactionWithCard">
  <username>API_USER</username>
  <password>5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8</password>
  <void>
    <transactionId>transaction-00002</transactionId>
    <referenceTransactionId>UUID of preauthorize transaction</referenceTransactionId>
  </void>
</transactionWithCard>

A Void cancels a previously performed authorization made with the Preauthorize method.

POST /transaction/{apiKey}/void

Path parameters

Refund

<?xml version="1.0" encoding="utf-8"?>
<transactionWithCard xmlns="https://secure.ixopay.com/Schema/V2/TransactionWithCard">
  <username>API_USER</username>
  <password>5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8</password>
  <refund>
    <transactionId>transaction-00002</transactionId>
    <referenceTransactionId>UUID of debit or capture transaction</referenceTransactionId>
    <amount>4.99</amount>
    <currency>EUR</currency>
  </refund>
</transactionWithCard>

A Refund reverses a payment which was previously performed with Debit or Capture.

Depending on the payment method you can even refund only a partial amount of the original transaction amount.

POST /transaction/{apiKey}/refund

Path parameters

Payout

<?xml version="1.0" encoding="utf-8"?>
<transactionWithCard xmlns="https://secure.ixopay.com/Schema/V2/TransactionWithCard">
  <username>API_USER</username>
  <password>5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8</password>
  <payout>
    <transactionId>transaction-00001</transactionId>
    <referenceTransactionId>UUID of first transaction</referenceTransactionId> <!-- this is optional but may be required for certain methods -->
    <customer>
      <identification>1111</identification>
      <firstName>John</firstName>
      <lastName>Smith</lastName>
      <billingCountry>AT</billingCountry>
      <email>[email protected]</email>
      <ipAddress>123.123.123.123</ipAddress>
    </customer>
    <amount>4.99</amount>
    <currency>EUR</currency>
    <description>Transaction Description</description>
  </payout>
</transactionWithCard>

A Payout credits the customer's account with the given amount.

Depending on the connector, either referenceUuid or cardData will be required.

POST /transaction/{apiKey}/payout

Path parameters

Register

<?xml version="1.0" encoding="utf-8"?>
<transactionWithCard xmlns="https://secure.ixopay.com/Schema/V2/TransactionWithCard">
  <username>API_USER</username>
  <password>5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8</password>
  <cardData>
    <cardHolder>test test</cardHolder>
    <pan>4111111111111111</pan>
    <cvv>123</cvv>
    <expirationMonth>12</expirationMonth>
    <expirationYear>2021</expirationYear>
  </cardData>
  <register>
    <transactionId>transaction-00001</transactionId>
    <customer>
      <identification>1111</identification>
      <firstName>John</firstName>
      <lastName>Smith</lastName>
      <billingCountry>AT</billingCountry>
      <email>[email protected]</email>
      <ipAddress>123.123.123.123</ipAddress>
    </customer>
    <description>Transaction Description</description>
    <successUrl>https://link.to/your/payment-successful-page</successUrl>
    <cancelUrl>https://link.to/your/payment-canceled-page</cancelUrl>
    <errorUrl>https://link.to/your/payment-failed-page</errorUrl>
    <callbackUrl>https://link.to/your/notification-handler</callbackUrl>
  </register>
</transactionWithCard>

Registers a customer's payment instrument for future charges (Debits or Preauthorizations)

POST /transaction/{apiKey}/register

Path parameters

Deregister

<?xml version="1.0" encoding="utf-8"?>
<transactionWithCard xmlns="https://secure.ixopay.com/Schema/V2/TransactionWithCard">
  <username>API_USER</username>
  <password>5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8</password>
  <deregister>
    <transactionId>transaction-00002</transactionId>
    <referenceTransactionId>UUID of register transaction</referenceTransactionId>
  </deregister>
</transactionWithCard>

A Deregister deletes a previously registered payment instrument using Register.

POST /transaction/{apiKey}/deregister

Path parameters

Debit with starting a schedule

<!-- Request -->
<?xml version="1.0" encoding="utf-8"?>
<transactionWithCard xmlns="https://secure.ixopay.com/Schema/V2/TransactionWithCard">
  <username>API_USER</username>
  <password>5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8</password>
  <language>en</language>
  <cardData>
    <cardHolder>test test</cardHolder>
    <pan>4111111111111111</pan>
    <cvv>123</cvv>
    <expirationMonth>12</expirationMonth>
    <expirationYear>2021</expirationYear>
  </cardData>
  <debit>
    <transactionId>transaction-00001</transactionId>
    <customer>
      <identification>1111</identification>
      <firstName>John</firstName>
      <lastName>Smith</lastName>
      <billingCountry>AT</billingCountry>
      <email>[email protected]</email>
      <ipAddress>123.123.123.123</ipAddress>
    </customer>
    <amount>9.99</amount>
    <currency>EUR</currency>
    <description>Transaction Description</description>
    <successUrl>https://link.to/your/payment-successful-page</successUrl>
    <cancelUrl>https://link.to/your/payment-canceled-page</cancelUrl>
    <errorUrl>https://link.to/your/payment-failed-page</errorUrl>
    <callbackUrl>https://link.to/your/notification-handler</callbackUrl>
    <withRegister>true</withRegister>
    <startSchedule>
      <amount>4.99</amount>
      <currency>EUR</currency>
      <periodLength>1</periodLength>
      <periodUnit>MONTH</periodUnit>
      <startDateTime>2018-06-05 10:54:51 UTC</startDateTime>
    </startSchedule>
  </debit>
</transactionWithCard>

You can start a transaction with a schedule on the fly, the transaction must be either a Register, a Debit with-register or a Preauthorize with-register.

The field startDateTime is optional and can be used to set a differing length for the first period (e.g. as trial period).

If your customer is already registered, and you can provide the registrationId, then it is recommended to use the Schedule API instead (see Schedule API).

Transaction Response

As response to the API call the gateway answers with a Result XML with the status and further instructions.

Generally there are 4 possible results:

FINISHED

<?xml version="1.0" encoding="utf-8"?>
<result xmlns="https://secure.ixopay.com/Schema/V2/Result">
  <success>true</success>
  <referenceId>12345678901234567890</referenceId>
  <purchaseId>20170101-12345678901234567890</purchaseId>
  <returnType>FINISHED</returnType>
</result>

The transaction completed and was processed successfully. You can deliver the ordered goods.

ERROR

<?xml version="1.0" encoding="utf-8"?>
<result xmlns="https://secure.ixopay.com/Schema/V2/Result">
  <success>false</success>
  <referenceId>12345678901234567890</referenceId>
  <purchaseId>20170101-12345678901234567890</purchaseId>
  <returnType>ERROR</returnType>
  <errors>
    <error>
      <message>Card number invalid</message>
      <code>2008</code>
      <adapterMessage>Invalid card number</adapterMessage>
      <adapterCode>200</adapterCode>
    </error>
  </errors>
</result>

The transaction failed or was declined. See the error code and message for further details.

You will find the native error message and code from the payment provider/acquiring bank in the fields adapterMessage and adapterCode.

REDIRECT

<result xmlns="https://secure.ixopay.com/Schema/V2/Result">
  <success>true</success>
  <referenceId>12345678901234567890</referenceId>
  <purchaseId>20170101-12345678901234567890</purchaseId>
  <returnType>REDIRECT</returnType>
  <redirectUrl>https://secure.ixopay.com/redirect/12345678901234567890/ABCDEF01234567890ABCDEF01234567890=</redirectUrl>
</result>

You must redirect the user to the URL defined in redirectUrl to proceed with the transaction. Afterwards the user will be back redirected to your shop (one of the URLs you defined in the API call in successUrl, cancelUrl or errorUrl). In parallel the gateway sends a status notification to you callbackUrl with the final result.

PENDING

<?xml version="1.0" encoding="utf-8"?>
<result xmlns="https://secure.ixopay.com/Schema/V2/Result">
  <success>true</success>
  <referenceId>12345678901234567890</referenceId>
  <purchaseId>20170101-12345678901234567890</purchaseId>
  <returnType>PENDING</returnType>
</result>

The transaction was accepted for processing, but is not yet completed. You will receive a status notification to the URL you defined in callbackUrl once it reaches a final state.

Depending on the payment method, this can take from seconds up to several days.

Response with Schedule

<?xml version="1.0" encoding="utf-8"?>
<result xmlns="https://secure.ixopay.com/Schema/V2/Result">
  <success>true</success>
  <referenceId>12345678901234567890</referenceId>
  <purchaseId>20170101-12345678901234567890</purchaseId>
  <registrationId>aab69791ddedcaeae4ae</registrationId>
  <returnType>FINISHED</returnType>
  <scheduleId>SC-7AA3-37B8-0F27-8BCA-5B3D-90DB</scheduleId>
  <scheduleStatus>ACTIVE</scheduleStatus>
  <scheduledAt>2018-07-05 16:22:06 UTC</scheduledAt>
</result>

If you have started a Schedule please store the received scheduleId for further schedule handling, the scheduleId is required for operating with the Schedule API (see Schedule API).

Postback Notifications

The Gateway sends you an asynchronous notification once a transaction reaches its final state. Per default, the format of the notification will be in the same format as your request.

Please consider the namespace host name for postback notifications is: gateway.ixopay.com

A typical success notification looks like this (the element returnData can differ depending on the payment method):

<?xml version="1.0" encoding="utf-8"?>
<callback xmlns="https://gateway.ixopay.com/Schema/V2/Callback">
  <result>OK</result>
  <referenceId>edcba123456789012345</referenceId>
  <transactionId>YOUR_TRANSACTION_ID</transactionId>
  <purchaseId>20170120-edcba123456789012345</purchaseId>
  <transactionType>DEBIT</transactionType>
  <merchantMetaData>YOUR_OPTIONAL_META_DATA</merchantMetaData>
  <amount>4.99</amount>
  <currency>USD</currency>
  <returnData type="creditcardData">
    <creditcardData>
      <type>visa</type>
      <cardHolder>Max Mustermann</cardHolder>
      <expiryMonth>10</expiryMonth>
      <expiryYear>2020</expiryYear>
      <firstSixDigits>411111</firstSixDigits>
      <lastFourDigits>1111</lastFourDigits>
      <fingerprint>ABCXYZ...</fingerprint>
      <threeDSecure>MANDATORY</threeDSecure>
      <eci>05</eci>
      <binBrand>VISA</binBrand>
      <binBank>Issuing Bank</binBank>
      <binCountry>AT</binCountry>
    </creditcardData>
  </returnData>
  <customerData>
    <identification>1111</identification>
    <firstName>John</firstName>
    <lastName>Smith</lastName>
    <billingCountry>AT</billingCountry>
    <email>[email protected]</email>
    <ipAddress>123.123.123.123</ipAddress>
  </customerData>
</callback>

This is an example for an error notification:

<?xml version="1.0" encoding="utf-8"?>
<callback xmlns="https://gateway.ixopay.com/Schema/V2/Callback">
  <result>ERROR</result>
  <referenceId>edcba123456789012345</referenceId>
  <transactionId>YOUR_TRANSACTION_ID</transactionId>
  <purchaseId>20170120-edcba123456789012345</purchaseId>
  <transactionType>DEBIT</transactionType>
  <merchantMetaData>YOUR_OPTIONAL_META_DATA</merchantMetaData>
  <amount>4.99</amount>
  <currency>USD</currency>
  <errors>
    <error>
      <message>Card invalid</message>
      <code>2008</code>
      <adapterMessage>Invalid Card Entered</adapterMessage>
      <adapterCode>100.000.100</adapterCode>
    </error>
  </errors>
  <returnData type="creditcardData">
    <creditcardData>
      <type>visa</type>
      <country>AT</country>
      <cardHolder>Max Mustermann</cardHolder>
      <expiryMonth>10</expiryMonth>
      <expiryYear>2020</expiryYear>
      <firstSixDigits>411111</firstSixDigits>
      <lastFourDigits>1111</lastFourDigits>
    </creditcardData>
  </returnData>
  <customerData>
    <identification>1111</identification>
    <firstName>John</firstName>
    <lastName>Smith</lastName>
    <billingCountry>AT</billingCountry>
    <email>[email protected]</email>
    <ipAddress>123.123.123.123</ipAddress>
  </customerData>
</callback>

Result Codes

The result tag will either contain "OK" or "ERROR". In case of error the XML contains an errors element with further information.

<?xml version="1.0" encoding="utf-8"?>
<callback xmlns="https://gateway.ixopay.com/Schema/V2/Callback">
  <result>OK</result>
  <referenceId>edcba123456789012345</referenceId>
  <transactionId>YOUR_TRANSACTION_ID</transactionId>
  <purchaseId>20170120-edcba123456789012345</purchaseId>
  <transactionType>DEBIT</transactionType>
  <merchantMetaData>YOUR_OPTIONAL_META_DATA</merchantMetaData>
  <amount>4.99</amount>
  <currency>USD</currency>
  <errors>
    <error>
      <message>Card declined</message>
      <code>2003</code>
      <adapterMessage>Card declined by authorisation System</adapterMessage>
      <adapterCode>301.110</adapterCode>
    </error>
  </errors>
</callback>

Data Verification

To prove the authenticity of the notification the Gateway signs every request with the same shared secret as used for signing your requests.

You should verify the signature by calculating it on your system and compare it to the given one.

The mechanism is the same as described in Signature, but instead of defining the various values (request URI, date, etc.), you must take them out of the HTTP request you received from us. You should also verify that the Date header is within a reasonable deviation of the current timestamp (e.g. 60 seconds)

Additional data

If you need additional information to process the notification for your shop order, you can use the optional field merchantMetaData, or you can provide that data as GET parameters in the callbackUrl you define.

E.g. https://www.merchant.com/notification-url?someKey=someValue&anything=else

Chargeback Notifications

If a transaction gets charged back by the customer, the Gateway will send you a notification to the URL from the original transaction (i.e. the Debit or Capture transaction).

The notification XML will then contain an element chargebackData with further information

<?xml version="1.0" encoding="utf-8"?>
<callback xmlns="https://gateway.ixopay.com/Schema/V2/Callback">
  <result>OK</result>
  <referenceId>edcba123456789012345</referenceId>
  <transactionId>auto-generated-id</transactionId>
  <purchaseId>20170120-edcba123456789012345</purchaseId>
  <transactionType>CHARGEBACK</transactionType>
  <amount>9.99</amount>
  <currency>EUR</currency>
  <chargebackData>
    <originalReferenceId>abcdef123456123456</originalReferenceId>
    <originalTransactionId>YOUR_TRANSACTION_ID</originalTransactionId>
    <amount>9.99</amount>
    <currency>EUR</currency>
    <reason>customer_chargeback</reason>
    <chargebackDateTime>2017-02-10T04:36:09Z</chargebackDateTime>
  </chargebackData>
</callback>

You must confirm the notification in the same manner as normal status notifications with status code 200 and text "OK" in the response's payload.

Chargeback Reversal Notification

As a follow-up on chargebacks there can be a chargeback reversal. Again the Gateway will send you a notification to the URL of the original transaction.

For this kind of notification the XML contains an element chargebackReversalData with information to the original transaction and the chargeback transaction

<?xml version="1.0" encoding="utf-8"?>
<callback xmlns="https://gateway.ixopay.com/Schema/V2/Callback">
  <result>OK</result>
  <referenceId>b5c36138ada44ca09d45</referenceId>
  <transactionId>auto-generated-id</transactionId>
  <purchaseId>20170120-edcba123456789012345</purchaseId>
  <transactionType>CHARGEBACK-REVERSAL</transactionType>
  <amount>9.99</amount>
  <currency>EUR</currency>
  <chargebackReversalData>
    <originalReferenceId>abcdef123456123456</originalReferenceId>
    <originalTransactionId>YOUR_TRANSACTION_ID</originalTransactionId>
    <chargebackReferenceId>edcba123456789012345</chargebackReferenceId>
    <amount>9.99</amount>
    <currency>EUR</currency>
    <reason>dispute_won</reason>
    <reversalDateTime>2017-03-26T11:27:15Z</reversalDateTime>
  </chargebackReversalData>
</callback>

Transaction Data

Note: For conditional fields, please refer to the corresponding adapter specific documentation.

Customer Data

The customer element can be one of two different customer types:

• Customer: This is the base type, containing all basic data
• IbanCustomer: Extends the base type with fields for IBAN, BIC, SEPA Mandate ID and Date

For details, refer to the Transaction XML definition

3D-Secure 2.0 Data

As explained in 3D Secure 2.0 Authentication you should provide as many data as you have to apply for the 3D Secure 2.0 frictionless flow.

Any data field listed shall be provided within an extraData element.

3D-Secure 2.0 Device Data

For 3DS v2, the device data below are mandatory. Transaction will not succeed if either all browser or all SDK parameters are provided.

Browser Data

The following fields are filled automatically by the Gateway if you are using hosted payment pages or payment.js integration. For any other integration flow you will need to provide them:

SDK Data

Authentication (Password Hashing)

Within the transaction request XML you pass username and password given by your integration engineer.

The plaintext password must be hashed with SHA1 hashing algorithm. The result shall be passed in lower case letters.

$password = 'myPassword';
$password = sha1($password);

var pass = "myPassword";
var sha1 = SHA1.Create();
var hash = sha1.ComputeHash(System.Text.Encoding.ASCII.GetBytes(pass));
pass = this.ByteToString(hash).ToLower(); //see function below

protected string ByteToString(byte[] buff)
{
  StringBuilder sb = new StringBuilder();
  for (int i = 0; i < buff.Length; i++)
  {
    sb.Append(buff[i].ToString("X2"));
  }
  return sb.ToString();
}

import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;

String password = 'myPassword';

MessageDigest md;
try {
  md = MessageDigest.getInstance("SHA-1");
} catch( NoSuchAlgorithmException e ) {
  // should never happen since MessageDigest doc says SHA-1 must be on every JVM
  throw new RuntimeException("couldn't get SHA-1 digest", e);
}
byte[] digest = password.getBytes(StandardCharsets.UTF_8);
md.reset();
digest = Hex.hex(md.digest(digest)).getBytes(StandardCharsets.UTF_8);

password = new String(digest, StandardCharsets.UTF_8);

Signing Requests

Generating the Signature

Every request to the Transaction API must be signed with your shared secret.

The signature is generated via Hash HMAC method, using SHA2-512 as hashing algorithm and is expected to be BASE64 encoded.

$method = 'POST';
$xml = '...'; //see Transaction Request chapter
$contentType = 'text/xml; charset=utf-8';
$date = new \DateTime('now', new \DateTimeZone('UTC'));
$timestamp = $date->format('D, d M Y H:i:s T');
$additionals = '';
$requestUri = '/transaction';

$signatureMessage = join("\n", [$method, hash("sha512", $xml), $contentType, $timestamp, $additionals, $requestUri]);

$digest = hash_hmac('sha512', $signatureMessage, 'THE_SHARED_SECRET', true);
$signature = base64_encode($digest);

var sharedSecret = "SHARED_SECRET";
var method = "POST";
var bodySHA512 = MakeSHA512Hash(transactionXml);
var contentType = "text/xml; charset=utf-8";
var date = new DateTime();
var timestamp = date.ToUniversalTime().ToString("r");
var additionals = "";
var requestUri = "/transaction";

var signatureMessage = method + "\n" + bodySHA512 + "\n" + contentType + "\n" + timestamp + "\n" + additionals + "\n" + requestUri;

var hmacSha512 = new HMACSHA512(Encoding.UTF8.GetBytes(sharedSecret));
var hash = hmacSha512.ComputeHash(Encoding.UTF8.GetBytes(signatureMessage));

var signature = System.Convert.ToBase64String(hash); //this is what we need now

public string MakeSHA512Hash(string content) {
  SHA512 sha512 = new SHA512Managed();
  byte[] inputBytes = System.Text.Encoding.UTF8.GetBytes(input);
  byte[] hash = sha512.ComputeHash(inputBytes);

  StringBuilder sb = new StringBuilder();
  for (int i = 0; i < hash.Length; i++) {
    sb.Append(hash[i].ToString("X2"));
  }
  return sb.ToString();
}

// No Java example yet

The signature message is built by concatenating the following data with a line break \n

• HTTP Method ("POST")
• SHA512 hash of payload (the XML itself) - Note: In previous versions this is MD5 instead.
• Content-Type header (e.g. "text/xml; charset=utf-8")
• Timestamp as sent in Date header
• Additional custom headers (usually empty)
• Request URI string (usually "/transaction")

Afterwards you build the HMAC digest with SHA512 of this message with the shared secret as key. The digest should be generated in binary (not hexadecimal) and then base64 encoded.

Passing the Signature

curl \
-d "PUT_XML_HERE" \
-H "Authorization: Gateway THE_API_KEY:Signature" \
-H "Content-Type: text/xml" \
"https://gateway.ixopay.com/transaction"

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  'Authorization: Gateway THE_API_KEY:'.$signature,
  'Date: '.$timestamp, //from above
  'Content-Type: '.$contentType
);

var apiKey = 'YOUR_API_KEY';
var request = (HttpWebRequest)WebRequest.Create("https://gateway.ixopay.com/transaction");

//values from above
request.Method = method;
request.ContentType = contentType;
request.ContentLength = transactionXml.Length;

request.Date = now;
request.Headers.Add("Authorization: Gateway " + apiKey + ":" + signature);

// No Java example yet

The generated signature must be passed in the request header Authorization, alongside with the application name ("Gateway") and your API key for the desired connector.

E.g.: Authorization: Gateway API_KEY:generatedSignature

(Replace "API_KEY" and "generatedSignature" with the appropriate values)

Now you can send the request.

Signature Testing Tool

Use this tool to verify the correctness of your signature generation.

Signature parameters
API-Key
Shared Secret
Method
Content
Content-Type
Timestamp (format)
Endpoint
Hashing Algorithm	SHA512 MD5 (deprecated)
Generate signature

Signature output
Expected -Hash of payload
Method
Content-Type
Timestamp
Request-URI
Hash HMAC Input (based on your request) Do note the line breaks!
Expected signature = data hashed using HMAC (SHA512), and the resulting binary encoded using Base64
Expected headers