Wirecard Voucher

REST API & Wirecard Payment Page v2

Please note that you can use the REST API documentation also for Wirecard Payment Page v1 LEGACY integration.

Wirecard Voucher is a type of voucher payment.

Countries and Currencies

Countries

Please contact Merchant Support for Countries.

Currencies

EUR
Communication Formats

This table illustrates how Wirecard Voucher notifications are encoded and which formats and methods can be used for requests and responses.

Requests/Responses

Format

XML

Methods

POST

IPN Encodement

Please follow the instructions given at Instant Payment Notification to set up IPN.
Transaction Types

For transaction type details look at Transaction Types.

Transaction Type Description Link to the Samples

enrollment

Creates a voucher with the option to instantly activate it.

enrollment
enrollment with instant activation

activation

Activates an existing voucher.
Vouchers must be activated in order to be used.

activation

purchase

Redeems a voucher.

purchase samples

void-purchase

Cancels a purchase against Voucher API.
Configurable on merchant level.

void-purchase samples

reserve

Reserves an amount for redemption.

reserve samples

void-reserve

Cancels a redemption reservation that has not yet been confirmed.
If redemption has already been confirmed, use transaction type cancel-redeem.

void-reserve samples

redeem

Confirms a reservation redemption.
Subtracts the redemption amount from the total voucher amount.

redeem samples

cancel-redeem

Cancels a confirmed redemption.
Resets the voucher amount to the value before redemption.
Resets the voucher status from REDEEMED to ACTIVATED.

cancel-redeem samples

void-cancel-redeem

Rollback of redemption cancelation.
Resets the voucher amount to the value before redemption cancelation.
Resets the voucher status from ACTIVATED to REDEEMED.

void-cancel-redeem samples

authorization-only

Retrieves voucher details.

authorization-only samples
Test Credentials

URLs (Endpoints)

https://api-test.wirecard.com/engine/rest/payments/

Merchant Account ID (MAID)

7b14cf26-44ae-4bf2-a180-044ac03ff9f6

Username

16390-testing

Password

3!3013=D3fD8X7

Secret Key

82e791c-0e68-4a5a-b178-8f9a7f3c7ba8
Additional Test Credentials on Wirecard Voucher Environment

Voucher Brand

testmerchant

Voucher Code for Test

TESTM49499486680, 9.000 EUR
Not reloadable, please use small amounts.
Workflow
Wirecard Voucher Workflow
Fields

Payment fields used for Wirecard Voucher requests, responses and notifications are the same as for REST API. Please refer to: REST API Fields.

Additional Voucher Fields

Fields can be Mandatory or Optional.

Field M/O Data Type Size Description

voucher-type

M/O

String

ID of voucher type that the voucher will be created from.
Mandatory for enrollment.

voucher-brand-id

M

String

255

Brand of voucher.

voucher-instant-activation

O

Boolean

In enrollment request: Set this flag to true to create and activate a new voucher in one go.

voucher-code

M/O

String

36

Unique code for payment and voucher processing.
Returned in an enrollment response for further use.

Mandatory for

  • activation

  • reserve

  • purchase

  • redeem

  • authorization-only

You have to send either voucher-code or voucher-serial-number.
If you send both, Wirecard Payment Gateway proceeds with voucher-code.

voucher-description

O

String

255

Used as operational comment and as reasonId for creating a voucher.

alternative-amount

O

Integer

18.0

Used for merchant specific currencies (bonuses, km, etc.).

voucher-serial-number

M/O

String

255

Identifies the voucher in reports and support requests.
Returned in an enrollment response for further use.

Mandatory for

  • activation

  • reserve

  • purchase

  • redeem

  • authorization-only

You have to send either voucher-code or voucher-serial-number.
If you send both, Wirecard Payment Gateway proceeds with voucher-code.

order-number

O

String

Merchant side voucher ID.
Send this external-correlation-id to link it to the generated voucher-code.

order-detail

O

String

Additional merchant side information (external-order-detail).

voucher-amount

Response only

String

255

Current voucher amount.

voucher-state

Response only

String

255

Possible voucher states:

  • CREATED

  • PREACTIVATED

  • ACTIVATED

  • RESERVED (loading or redemption)

  • CONFIRMED (loading or redemption)

  • REVERSED (loading or redemption)

  • LOCKED

  • CANCELLED (loading or redemption)

  • REDEEMED

  • INVALID

  • DEACTIVATED

  • EXPIRED

voucher-token-id

Response only

String

255

Token used on Voucher API for this transaction.

voucher-expiration-date

Response only

Date Time

255

Voucher expiration date.

The payments.payment.additional-merchant-data field is used along with voucher type to send keyValuePairs to the Voucher API. Its value is Base64 encoded.

Part of the request

<additional-merchant-data>ew0KInh5eiI6ICIxMjMiLA0KImFiYyI6ICI0NTYiDQp9</additional-merchant-data>

will be sent to Voucher API as

"keyValuePairs": "ew0KInh5eiI6ICIxMjMiLA0KImFiYyI6ICI0NTYiDQp9"

Decode from Base64 ew0KInh5eiI6ICIxMjMiLA0KImFiYyI6ICI0NTYiDQp9

{
 "xyz": "123",
 "abc": "456"
}

additional-merchant-data also provides keyValuePairs from the Voucher API response and is decoded in the same way.
Samples

Go to Notification Examples if you want to see corresponding notification samples.

enrollment
XML enrollment Request (Successful)
<?xml version="1.0" encoding="utf-8"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
    <merchant-account-id>7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
    <request-id>{{$guid}}</request-id>
    <transaction-type>enrollment</transaction-type>
    <payment-methods>
        <payment-method name="voucher"/>
    </payment-methods>
    <voucher>
        <voucher-brand-id>testmerchant</voucher-brand-id>
        <voucher-type>6903</voucher-type>
    </voucher>
</payment>
XML enrollment Response (Successful)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment" self="https://api-test.wirecard.com:443/engine/rest/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6/payments/91715c80-8ee8-49c6-832f-4ad821a5ae54">
    <merchant-account-id ref="https://api-test.wirecard.com:443/engine/rest/config/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6">7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
    <transaction-id>91715c80-8ee8-49c6-832f-4ad821a5ae54</transaction-id>
    <request-id>24d53c91-9ac8-4312-b0c6-52592ef37a67</request-id>
    <transaction-type>enrollment</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2020-04-24T06:58:29.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="voucher:The resource was successfully created." severity="information"/>
    </statuses>
    <payment-methods>
        <payment-method name="voucher"/>
    </payment-methods>
    <voucher>
        <voucher-code>TESTM24852783764</voucher-code>
        <voucher-brand-id>testmerchant</voucher-brand-id>
        <voucher-serial-number>9999990051896428441</voucher-serial-number>
        <voucher-type>6903</voucher-type>
        <voucher-state>CREATED</voucher-state>
    </voucher>
    <provider-account-id>0000003173E1F10E</provider-account-id>
</payment>
XML enrollment with Instant Activation Request (Successful)
<?xml version="1.0" encoding="utf-8"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
    <merchant-account-id>7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
    <request-id>{{$guid}}</request-id>
    <transaction-type>enrollment</transaction-type>
    <requested-amount currency="EUR">9.99</requested-amount>
    <payment-methods>
        <payment-method name="voucher"/>
    </payment-methods>
    <voucher>
        <voucher-brand-id>testmerchant</voucher-brand-id>
        <voucher-type>6903</voucher-type>
        <voucher-instant-activation>true</voucher-instant-activation>
    </voucher>
</payment>
XML enrollment with Instant Activation Response (Successful)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment" self="https://api-test.wirecard.com:443/engine/rest/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6/payments/505bd746-8404-4d01-b2d6-673995407c0b">
    <merchant-account-id ref="https://api-test.wirecard.com:443/engine/rest/config/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6">7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
    <transaction-id>505bd746-8404-4d01-b2d6-673995407c0b</transaction-id>
    <request-id>de6138ea-107d-4329-ab84-42e15cfecf0b</request-id>
    <transaction-type>enrollment</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2020-04-24T08:58:57.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="voucher:The resource was successfully created." severity="information"/>
    </statuses>
    <requested-amount currency="EUR">1.05</requested-amount>
    <payment-methods>
        <payment-method name="voucher"/>
    </payment-methods>
    <voucher>
        <voucher-code>TESTM10713130261</voucher-code>
        <voucher-brand-id>testmerchant</voucher-brand-id>
        <voucher-serial-number>9999990118706819644</voucher-serial-number>
        <voucher-type>6903</voucher-type>
        <voucher-state>ACTIVATED</voucher-state>
        <voucher-amount currency="EUR">1.05</voucher-amount>
        <voucher-expiration-date>2030-04-24T21:59:59.000Z</voucher-expiration-date>
    </voucher>
    <provider-account-id>0000003173E1F10E</provider-account-id>
</payment>
activation
XML activation by Voucher Code Request (Successful)
<payment xmlns="http://www.elastic-payments.com/schema/payment">
    <merchant-account-id>7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
    <request-id>{{$guid}}</request-id>
    <transaction-type>activation</transaction-type>
        <requested-amount currency="EUR">1.25</requested-amount>
        <parent-transaction-id>7f676dc2-c8e5-40ca-8a6a-c46373e7803c</parent-transaction-id>
        <payment-methods>
            <payment-method name="voucher"/>
        </payment-methods>
        <voucher>
                <voucher-code>TESTM58310327617</voucher-code>
                <voucher-brand-id>testmerchant</voucher-brand-id>
        </voucher>
</payment>
XML activation by Voucher Code Response (Successful)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment" self="https://api-test.wirecard.com:443/engine/rest/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6/payments/7f26b1c5-8d3e-4a74-aee4-18a8fe8254f4">
    <merchant-account-id ref="https://api-test.wirecard.com:443/engine/rest/config/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6">7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
    <transaction-id>7f26b1c5-8d3e-4a74-aee4-18a8fe8254f4</transaction-id>
    <request-id>54742df0-679e-4a76-afbe-fa8d6fd5fd6c</request-id>
    <transaction-type>activation</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2020-04-24T09:09:20.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="voucher:The resource was successfully created." severity="information"/>
    </statuses>
    <requested-amount currency="EUR">1.05</requested-amount>
    <parent-transaction-id>7f676dc2-c8e5-40ca-8a6a-c46373e7803c</parent-transaction-id>
    <payment-methods>
        <payment-method name="voucher"/>
    </payment-methods>
    <voucher>
        <voucher-code>TESTM58310327617</voucher-code>
        <voucher-brand-id>testmerchant</voucher-brand-id>
        <voucher-token-id>p9pr9bf48fl66naici3uap6sj8</voucher-token-id>
        <voucher-serial-number>9999990574406641559</voucher-serial-number>
        <voucher-state>ACTIVATED</voucher-state>
        <voucher-amount currency="EUR">1.05</voucher-amount>
        <voucher-expiration-date>2030-04-24T21:59:59.000Z</voucher-expiration-date>
    </voucher>
    <provider-account-id>0000003173E1F10E</provider-account-id>
</payment>
XML activation by Serial Number Request (Successful)
<payment xmlns="http://www.elastic-payments.com/schema/payment">
  <merchant-account-id>7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
  <request-id>{{$guid}}</request-id>
  <transaction-type>activation</transaction-type>
  <payment-methods>
    <payment-method name="voucher"/>
  </payment-methods>
  <requested-amount currency="EUR">1.25</requested-amount>
  <parent-transaction-id>0004335f-bd93-43e1-b166-1a557f87a6fd</parent-transaction-id>
  <voucher>
    <voucher-brand-id>testmerchant</voucher-brand-id>
    <voucher-serial-number>9999990121327828742</voucher-serial-number>
  </voucher>
</payment>
XML activation by Voucher Serial Number Response (Successful)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment" self="https://api-test.wirecard.com:443/engine/rest/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6/payments/9dc49c5c-6c67-4799-85db-9a7953b5254c">
    <merchant-account-id ref="https://api-test.wirecard.com:443/engine/rest/config/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6">7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
    <transaction-id>9dc49c5c-6c67-4799-85db-9a7953b5254c</transaction-id>
    <request-id>d2de4968-f8ef-436e-ba04-281fc6a899ae</request-id>
    <transaction-type>activation</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2020-05-04T13:16:34.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="voucher:The resource was successfully created." severity="information"/>
    </statuses>
    <requested-amount currency="EUR">1.25</requested-amount>
    <parent-transaction-id>0004335f-bd93-43e1-b166-1a557f87a6fd</parent-transaction-id>
    <payment-methods>
        <payment-method name="voucher"/>
    </payment-methods>
    <voucher>
        <voucher-code>TEST********7027</voucher-code>
        <voucher-brand-id>testmerchant</voucher-brand-id>
        <voucher-token-id>n86fpv9fs1u218s5hgh9sopkl5</voucher-token-id>
        <voucher-serial-number>9999990121327828742</voucher-serial-number>
        <voucher-state>ACTIVATED</voucher-state>
        <voucher-amount currency="EUR">1.25</voucher-amount>
        <voucher-expiration-date>2030-05-04T21:59:59.000Z</voucher-expiration-date>
    </voucher>
    <provider-account-id>0000003173E1F10E</provider-account-id>
</payment>
purchase
XML purchase Request (Successful)
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
        <merchant-account-id>7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
        <request-id>{{$guid}}</request-id>
        <transaction-type>purchase</transaction-type>
        <requested-amount currency="EUR">1.25</requested-amount>
        <payment-methods>
                <payment-method name="voucher" />
        </payment-methods>
        <voucher>
                <voucher-code>TESTM49499486680</voucher-code>
                <voucher-brand-id>testmerchant</voucher-brand-id>
                <voucher-description>This is Voucher Description</voucher-description>
        </voucher>
</payment>
XML purchase Response (Successful)
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment" xmlns:ns2="http://www.elastic-payments.com/schema/epa/transaction" self="https://api-test.wirecard.com:443/engine/rest/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6/payments/d424b4b8-c189-4f7f-b24b-912d35632924">
    <merchant-account-id ref="https://api-test.wirecard.com:443/engine/rest/config/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6">7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
    <transaction-id>d424b4b8-c189-4f7f-b24b-912d35632924</transaction-id>
    <request-id>826a358c-ff21-4eb8-8150-dd14ba4c2263</request-id>
    <transaction-type>purchase</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2018-07-05T07:36:06.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="voucher:The resource was successfully created." severity="information" />
    </statuses>
    <requested-amount currency="EUR">1.25</requested-amount>
    <payment-methods>
        <payment-method name="voucher" />
    </payment-methods>
    <voucher>
        <voucher-code>TE******80</voucher-code>
        <voucher-brand-id>testmerchant</voucher-brand-id>
        <voucher-token-id>e7222p70eta48ck8lidnrcsgto</voucher-token-id>
        <voucher-description>This is Voucher Description</voucher-description>
    </voucher>
    <provider-account-id>0000003173E1F10E</provider-account-id>
</payment>
void-purchase
XML void-purchase Request (Successful)
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
        <request-id>{{$guid}}</request-id>
        <transaction-type>void-purchase</transaction-type>
        <parent-transaction-id>$transaction-id-from-purchase-response</parent-transaction-id>
</payment>
XML void-purchase Response (Successful)
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment" xmlns:ns2="http://www.elastic-payments.com/schema/epa/transaction" self="https://api-test.wirecard.com:443/engine/rest/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6/payments/1c4ba465-400a-4366-bf39-d0cae16aa2fa">
    <merchant-account-id ref="https://api-test.wirecard.com:443/engine/rest/config/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6">7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
    <transaction-id>1c4ba465-400a-4366-bf39-d0cae16aa2fa</transaction-id>
    <request-id>8eb23e9a-61e8-4bd5-8a9d-7faa9edb54b7</request-id>
    <transaction-type>void-purchase</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2018-07-05T07:36:59.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="voucher:The resource was successfully created." severity="information" />
    </statuses>
    <requested-amount currency="EUR">1.25</requested-amount>
    <parent-transaction-id>d424b4b8-c189-4f7f-b24b-912d35632924</parent-transaction-id>
    <payment-methods>
        <payment-method name="voucher" />
    </payment-methods>
    <parent-transaction-amount currency="EUR">1.250000</parent-transaction-amount>
    <api-id>elastic-api</api-id>
    <voucher>
        <voucher-code>TE******80</voucher-code>
        <voucher-brand-id>testmerchant</voucher-brand-id>
        <voucher-token-id>e7222p70eta48ck8lidnrcsgto</voucher-token-id>
        <voucher-description>This is Voucher Description</voucher-description>
    </voucher>
    <provider-account-id>0000003173E1F10E</provider-account-id>
</payment>
reserve
XML reserve Request (Successful)
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
        <merchant-account-id>7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
        <request-id>${{guid}}</request-id>
        <transaction-type>reserve</transaction-type>
        <requested-amount currency="EUR">0.25</requested-amount>
        <payment-methods>
                <payment-method name="voucher" />
        </payment-methods>
        <voucher>
                <voucher-code>TESTM49499486680</voucher-code>
                <voucher-brand-id>testmerchant</voucher-brand-id>
                <voucher-description>This is Voucher Description</voucher-description>
        </voucher>
</payment>
XML reserve Response (Successful)
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment" xmlns:ns2="http://www.elastic-payments.com/schema/epa/transaction" self="https://api-test.wirecard.com:443/engine/rest/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6/payments/7c4d1dc7-d439-44a1-83b7-90b8678afe76">
    <merchant-account-id ref="https://api-test.wirecard.com:443/engine/rest/config/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6">7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
    <transaction-id>7c4d1dc7-d439-44a1-83b7-90b8678afe76</transaction-id>
    <request-id>175215cb-00f0-42a5-9471-4b7bd17cb554</request-id>
    <transaction-type>reserve</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2018-07-05T07:38:52.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="voucher:The resource was successfully created." severity="information" />
    </statuses>
    <requested-amount currency="EUR">0.25</requested-amount>
    <payment-methods>
        <payment-method name="voucher" />
    </payment-methods>
    <voucher>
        <voucher-code>TE******80</voucher-code>
        <voucher-brand-id>testmerchant</voucher-brand-id>
        <voucher-token-id>4q1mlejfi3g1g5uaplmekdt2tg</voucher-token-id>
        <voucher-description>This is Voucher Description</voucher-description>
    </voucher>
    <provider-account-id>0000003173E1F10E</provider-account-id>
</payment>
void-reserve
XML void-reserve Request (Successful)
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
        <request-id>{{$guid}}</request-id>
        <transaction-type>void-reserve</transaction-type>
        <parent-transaction-id>$transaction-id-from-reserve-response</parent-transaction-id>
</payment>
XML void-reserve Response (Successful)
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment" xmlns:ns2="http://www.elastic-payments.com/schema/epa/transaction" self="https://api-test.wirecard.com:443/engine/rest/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6/payments/1fcf2f9f-47df-4301-8c45-51d9085aca53">
    <merchant-account-id ref="https://api-test.wirecard.com:443/engine/rest/config/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6">7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
    <transaction-id>1fcf2f9f-47df-4301-8c45-51d9085aca53</transaction-id>
    <request-id>6c517309-1b74-44a8-8b6f-19ed50c0cb8b</request-id>
    <transaction-type>void-reserve</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2018-07-09T10:19:37.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="voucher:The resource was successfully created." severity="information" />
    </statuses>
    <requested-amount currency="EUR">0.25</requested-amount>
    <parent-transaction-id>83666ab6-cb2d-47eb-9112-8916008a1059</parent-transaction-id>
    <payment-methods>
        <payment-method name="voucher" />
    </payment-methods>
    <parent-transaction-amount currency="EUR">0.250000</parent-transaction-amount>
    <api-id>elastic-api</api-id>
    <voucher>
        <voucher-code>TE******80</voucher-code>
        <voucher-brand-id>testmerchant</voucher-brand-id>
        <voucher-token-id>rk0rdd9qj80r8ch2tlmf8kn3g0</voucher-token-id>
        <voucher-description>This is Voucher Description</voucher-description>
    </voucher>
    <provider-account-id>0000003173E1F10E</provider-account-id>
</payment>
redeem
XML redeem Request (Successful)
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
        <merchant-account-id>7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
        <request-id>${{guid}}</request-id>
        <transaction-type>redeem</transaction-type>
        <requested-amount currency="EUR">0.25</requested-amount>
        <payment-methods>
                <payment-method name="voucher" />
        </payment-methods>
        <voucher>
                <voucher-code>TESTM49499486680</voucher-code>
                <voucher-brand-id>testmerchant</voucher-brand-id>
                <voucher-description>This is Voucher Description</voucher-description>
                <voucher-token-id>$from-successful-reserve-response</voucher-token-id>
        </voucher>
</payment>
XML redeem Response (Successful)
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment" xmlns:ns2="http://www.elastic-payments.com/schema/epa/transaction" self="https://api-test.wirecard.com:443/engine/rest/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6/payments/2bf67fc0-a137-4e3e-b149-b5bbc958ecc6">
    <merchant-account-id ref="https://api-test.wirecard.com:443/engine/rest/config/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6">7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
    <transaction-id>2bf67fc0-a137-4e3e-b149-b5bbc958ecc6</transaction-id>
    <request-id>30232dda-6a16-400d-8e91-e6d1754b227b</request-id>
    <transaction-type>redeem</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2018-07-05T07:40:06.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="voucher:The resource was successfully created." severity="information" />
    </statuses>
    <requested-amount currency="EUR">0.25</requested-amount>
    <payment-methods>
        <payment-method name="voucher" />
    </payment-methods>
    <voucher>
        <voucher-code>TE******80</voucher-code>
        <voucher-brand-id>testmerchant</voucher-brand-id>
        <voucher-token-id>4q1mlejfi3g1g5uaplmekdt2tg</voucher-token-id>
        <voucher-description>This is Voucher Description</voucher-description>
    </voucher>
    <provider-account-id>0000003173E1F10E</provider-account-id>
</payment>
cancel-redeem
XML cancel-redeem Request (Successful)
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
        <merchant-account-id>7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
        <request-id>{{$guid}}</request-id>
        <transaction-type>cancel-redeem</transaction-type>
        <parent-transaction-id>$from-redeem-response</parent-transaction-id>
</payment>
XML cancel-redeem Response (Successful)
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment" xmlns:ns2="http://www.elastic-payments.com/schema/epa/transaction" self="https://api-test.wirecard.com:443/engine/rest/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6/payments/75bd223e-ab98-40da-83d1-918aa4e7e210">
    <merchant-account-id ref="https://api-test.wirecard.com:443/engine/rest/config/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6">7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
    <transaction-id>75bd223e-ab98-40da-83d1-918aa4e7e210</transaction-id>
    <request-id>bfd442bb-5b86-44b1-bfb8-34e579aff23d</request-id>
    <transaction-type>cancel-redeem</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2018-07-05T07:41:28.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="voucher:The resource was successfully created." severity="information" />
    </statuses>
    <requested-amount currency="EUR">0.25</requested-amount>
    <parent-transaction-id>2bf67fc0-a137-4e3e-b149-b5bbc958ecc6</parent-transaction-id>
    <payment-methods>
        <payment-method name="voucher" />
    </payment-methods>
    <parent-transaction-amount currency="EUR">0.250000</parent-transaction-amount>
    <api-id>elastic-api</api-id>
    <voucher>
        <voucher-code>TE******80</voucher-code>
        <voucher-brand-id>testmerchant</voucher-brand-id>
        <voucher-token-id>4q1mlejfi3g1g5uaplmekdt2tg</voucher-token-id>
        <voucher-description>This is Voucher Description</voucher-description>
    </voucher>
    <provider-account-id>0000003173E1F10E</provider-account-id>
</payment>
void-cancel-redeem
XML void-cancel-redeem Request (Successful)
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
        <merchant-account-id>7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
        <request-id>${{guid}}</request-id>
        <transaction-type>void-cancel-redeem</transaction-type>
        <parent-transaction-id>$from-cancel-redeem-response</parent-transaction-id>
</payment>
XML void-cancel-redeem Response (Successful)
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment" xmlns:ns2="http://www.elastic-payments.com/schema/epa/transaction" self="https://api-test.wirecard.com:443/engine/rest/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6/payments/11a3ce39-7d55-47a8-ae82-9103fc378878">
    <merchant-account-id ref="https://api-test.wirecard.com:443/engine/rest/config/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6">7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
    <transaction-id>11a3ce39-7d55-47a8-ae82-9103fc378878</transaction-id>
    <request-id>cc0f56c5-e6ce-4bbc-9c9f-dc9f9da2e9d7</request-id>
    <transaction-type>void-cancel-redeem</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2018-07-05T07:42:09.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="voucher:The resource was successfully created." severity="information" />
    </statuses>
    <requested-amount currency="EUR">0.25</requested-amount>
    <parent-transaction-id>75bd223e-ab98-40da-83d1-918aa4e7e210</parent-transaction-id>
    <payment-methods>
        <payment-method name="voucher" />
    </payment-methods>
    <parent-transaction-amount currency="EUR">0.250000</parent-transaction-amount>
    <api-id>elastic-api</api-id>
    <voucher>
        <voucher-code>TE******80</voucher-code>
        <voucher-brand-id>testmerchant</voucher-brand-id>
        <voucher-token-id>4q1mlejfi3g1g5uaplmekdt2tg</voucher-token-id>
        <voucher-description>This is Voucher Description</voucher-description>
    </voucher>
    <provider-account-id>0000003173E1F10E</provider-account-id>
</payment>
authorization-only
XML authorization-only Request (Successful)
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
    <merchant-account-id>7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
    <request-id>eb370e8f-6a19-41c1-977f-ddc61b7bd45d</request-id>
    <transaction-type>authorization-only</transaction-type>
    <payment-methods>
        <payment-method name="voucher"/>
    </payment-methods>
    <voucher>
        <voucher-code>9999999625213695</voucher-code>
        <voucher-brand-id>testmerchant</voucher-brand-id>
        <voucher-description>This is Test Voucher 1</voucher-description>
    </voucher>
    <requested-amount currency="EUR">0</requested-amount>
</payment>
XML authorization-only Response (Successful)
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment" self="http://localhost:8080/engine/rest/merchants/30cbaf92-a45d-4d41-8a2f-39dfa395c07c/payments/ba84ec9b-6be3-4a12-894e-fa5bf89d6c3a">
    <merchant-account-id ref="http://localhost:8080/engine/rest/config/merchants/7b14cf26-44ae-4bf2-a180-044ac03ff9f6">7b14cf26-44ae-4bf2-a180-044ac03ff9f6</merchant-account-id>
    <transaction-id>ba84ec9b-6be3-4a12-894e-fa5bf89d6c3a</transaction-id>
    <request-id>eb370e8f-6a19-41c1-977f-ddc61b7bd45d</request-id>
    <transaction-type>authorization-only</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2019-06-03T14:13:47.000+02:00</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="voucher:The resource was successfully created." severity="information"/>
    </statuses>
    <requested-amount currency="EUR">0</requested-amount>
    <payment-methods>
        <payment-method name="voucher"/>
    </payment-methods>
    <voucher>
        <voucher-code>9999999625213695</voucher-code>
        <voucher-brand-id>testmerchant</voucher-brand-id>
        <voucher-token-id>134f8a4e-6f87-472e-bb45-a9401372181c</voucher-token-id>
        <voucher-description>This is Test Voucher 1</voucher-description>
        <voucher-serial-number>5963125269999999</voucher-serial-number>
        <voucher-state>ACTIVATED</voucher-state>
        <voucher-amount currency="EUR">15</voucher-amount>
        <voucher-expiration-date>4024-09-26T23:59:59.000+02:00</voucher-expiration-date>
    </voucher>
</payment>

← Wirecard Payment on Invoice | Payment Processing →