paybox

Introduction

paybox Logo

paybox is a payment system allowing a consumer to purchase goods and services using a mobile phone. Consumers provide their mobile phone number and set up a direct debit agreement with paybox and select a secret PIN for their paybox account. In order to use paybox, consumers need to have a bank account in Austria, Switzerland or the European Economic Area. After a once-only registration, all payments are debited to the consumer’s bank account. For private consumers who have a valid mobile phone contract with an Austrian mobile telephone provider, online purchases via paybox are included on the consumer’s mobile phone bill.

Before being able to offer paybox as a payment method, the merchant needs to sign an acceptance contract with paybox.

When purchasing in an online shop, the consumer selects paybox as the preferred payment method and is prompted to enter a mobile phone number. During the checkout process, paybox calls the consumer’s phone (automated call), and asks for the PIN to confirm the transaction. After entering the correct PIN, paybox debits the money from the consumer’s bank account and credits it to the merchant’s account. Finally, the consumer receives an SMS message confirming the transaction. The merchant also receives a confirmation and may thus proceed with the delivery of the goods or services.

Advantages
  • Easy to use.

  • World-wide GSM radio networks ensure the highest level of security during data transfer.

  • Consumers only need to give their bank details to the paybox company and do not need to reveal their credit card or bank account details to any other company.

General Information

Payment Mode, Countries and Currencies

This table illustrates which payment mode paybox belongs to. It also provides detailed information about the countries and currencies which are relevant for paybox.

Payment Mode

Online Bank Transfer, Mobile Payment

Countries

Austria

Currencies

EUR

Communication Formats

This table illustrates how paybox 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

Transaction Type Description Link to the Sample

authorization

Reserves funds on a consumer’s account until the merchant ships the product/service.

authorization samples

capture-authorization

Used to capture the reserved funds at the moment when some or all goods are physically delivered to the consumer.

capture-authorization samples

purchase

An immediate payment for online purchase.

purchase samples

refund-capture

Used when the consumer wishes to return some or all delivered goods.

refund-capture samples

refund-purchase

Used when the consumer wishes to return some or all delivered goods.

refund-purchase samples

void-authorization

Used when the consumer wishes to cancel some or all (not yet shipped) items from the order.

void-authorization samples

void-purchase

Used when the consumer wishes to cancel some or all (not yet shipped) items from the order.

void-purchase samples

Test Credentials

URLs (Endpoints)

For transaction types authorization and purchase.

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

For transaction types void-authorization, void-purchase, refund-capture and refund-purchase.

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

Merchant Account ID (MAID)

Please contact merchant support for complete test credentials.

Username

Please contact merchant support for complete test credentials.

Password

Please contact merchant support for complete test credentials.

Secret Key

Please contact merchant support for complete test credentials.

Workflow

Be aware that initial paybox authorization/purchase transactions have a long timeout (190 seconds). paybox calls the consumer to authorize the transfer. Synchronous http-calls are used in paybox interface which are kept alive until confirmation.
authorization, purchase
Authorization Purchase Workflow
  1. Consumer adds items to the shopping basket and selects paybox.

  2. Consumer provides the phone number.

  3. The merchant sends an authorization-purchase request to Wirecard Payment Gateway (WPG).

  4. WPG processes and validates the transaction.

  5. WPG sends a request to paybox.

  6. paybox calls or sends SMS to consumer to verify the amount and payee information.

  7. Consumer approves the transaction. The approval is done via paybox PIN (when called) or typing "JA" (when receiving an SMS).

  8. paybox processes consumer’s reply.

  9. paybox sends the transaction status to WPG.

  10. WPG forwards transaction status to the merchant.

  11. The merchant displays the completion of the payment process to the consumer.

void-authorization, capture-authorization, void-purchase, refund-capture, refund-purchase
Workflow Other Transaction Types
  1. The merchant initiates a request (either void-authorization, capture-authorization, void-purchase, refund-capture or refund-purchase).

  2. WPG processes and validates the transaction.

  3. WPG sends the request to paybox.

  4. paybox processes the transaction.

  5. paybox sends the transaction status to WPG.

  6. WPG forwards the transaction status to the merchant.

Fields

The fields used for paybox requests, responses and notifications are the same as the REST API fields. Please refer to REST API Fields. Only the fields listed below have different properties, especially according to size.

authorization, purchase

The following elements are mandatory (M), optional (O) or conditional (C) for a request/response/notification. If the respective cell is empty, the field is disregarded or not sent.

Field Cardinality Datatype Size Description

order-number

O

xs:string

40

This is the order number of the merchant.

descriptor

O

xs:string

60

Description on the settlement of the account holder’s account about a transaction.

account-holder/phone

M

xs:string

24

The phone number of the account holder.

Samples

authorization
XML authorization Request (Successful)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
    <merchant-account-id>cd774c92-e46b-48da-9963-a30bb6a362cf</merchant-account-id>
    <request-id>$(unique for each request}</request-id>
    <transaction-type>authorization</transaction-type>
    <requested-amount currency="EUR">1.23</requested-amount>
    <account-holder>
        <phone>+43000123456789</phone>
    </account-holder>
    <order-number>order-number</order-number>
    <descriptor>customer-statement</descriptor>
    <payment-methods>
        <payment-method name="paybox"/>
    </payment-methods>
</payment>
XML authorization Response (Successful)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
    <merchant-account-id>cd774c92-e46b-48da-9963-a30bb6a362cf</merchant-account-id>
    <transaction-id>d6e3497e-15c7-11e5-b0a7-005056a97509</transaction-id>
    <request-id>$(unique for each request}</request-id>
    <transaction-type>authorization</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2015-06-18T14:39:35.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="The resource was successfully created." severity="information"/>
    </statuses>
    <requested-amount currency="EUR">1.23</requested-amount>
    <account-holder>
        <phone>+43100</phone>
    </account-holder>
    <ip-address>127.0.0.2</ip-address>
    <order-number>0</order-number>
    <order-detail>order detail</order-detail>
    <descriptor>Customer 007</descriptor>
    <payment-methods>
        <payment-method name="paybox"/>
    </payment-methods>
    <authorization-code>success</authorization-code>
    <locale>de</locale>
</payment>
XML authorization Response (Failure)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
    <merchant-account-id>cd774c92-e46b-48da-9963-a30bb6a362cf</merchant-account-id>
    <transaction-id>ee35f4fa-1441-11e5-8539-005056b13ce8</transaction-id>
    <request-id>$(unique for each request}</request-id>
    <transaction-type>authorization</transaction-type>
    <transaction-state>failed</transaction-state>
    <completion-time-stamp>2015-06-16T16:08:31.000Z</completion-time-stamp>
    <statuses>
        <status code="500.1051" description="A Provider refused to accept the transaction.  Please check your input and try again." severity="error"/>
    </statuses>
    <requested-amount currency="EUR">1.23</requested-amount>
    <account-holder>
        <phone>+43000123456789</phone>
    </account-holder>
    <order-number>order-number</order-number>
    <descriptor>customer-statement</descriptor>
    <payment-methods>
        <payment-method name="paybox"/>
    </payment-methods>
</payment>
capture-authorization
XML capture-authorization Request (Successful)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
     <merchant-account-id>0e0a466b-bed8-4eb3-973f-faddd77e692c</merchant-account-id>
     <request-id>$(unique for each request}</request-id>
     <transaction-type>capture-authorization</transaction-type>
    <payment-methods>
       <payment-method name="paybox"/>
    </payment-methods>
     <parent-transaction-id>31af95ca-15c9-11e5-b0a7-005056a97509</parent-transaction-id>
     <ip-address>127.0.0.1</ip-address>
</payment>
XML capture-authorization Response (Successful)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment" self="http://p-grz-web02.wirecard.lan:8080/engine/rest/merchants/0e0a466b-bed8-4eb3-973f-faddd77e692c/payments/321d784f-15c9-11e5-b0a7-005056a97509">
    <merchant-account-id ref="http://p-grz-web02.wirecard.lan:8080/engine/rest/merchants/0e0a466b-bed8-4eb3-973f-faddd77e692c">0e0a466b-bed8-4eb3-973f-faddd77e692c</merchant-account-id>
    <transaction-id>321d784f-15c9-11e5-b0a7-005056a97509</transaction-id>
    <request-id>$(unique for each request}</request-id>
    <transaction-type>capture-authorization</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2015-06-18T14:49:17.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="paybox:The resource was successfully created." severity="information"/>
    </statuses>
    <requested-amount currency="EUR">1.01</requested-amount>
    <account-holder>
        <phone>+43100</phone>
    </account-holder>
    <ip-address>127.0.0.1</ip-address>
    <order-number>0</order-number>
    <order-detail>order detail</order-detail>
    <descriptor>Customer 007</descriptor>
    <payment-methods>
        <payment-method name="paybox"/>
    </payment-methods>
    <api-id>elastic-api</api-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>0e0a466b-bed8-4eb3-973f-faddd77e692c</merchant-account-id>
    <request-id>$(unique for each request}</request-id>
    <transaction-type>purchase</transaction-type>
    <payment-methods>
       <payment-method name="paybox"/>
    </payment-methods>
    <account-holder>
      <phone>+43100</phone>
    </account-holder>
    <requested-amount currency="EUR">1.01</requested-amount>
</payment>
XML purchase Response (Successful)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
    <merchant-account-id>0e0a466b-bed8-4eb3-973f-faddd77e692c</merchant-account-id>
    <transaction-id>58093450-15c6-11e5-b0a7-005056a97509</transaction-id>
    <request-id>$(unique for each request}</request-id>
    <transaction-type>purchase</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2015-06-18T14:28:53.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="The resource was successfully created." severity="information"/>
    </statuses>
    <requested-amount currency="EUR">1.01</requested-amount>
    <account-holder>
        <phone>+43100</phone>
    </account-holder>
    <payment-methods>
        <payment-method name="paybox"/>
    </payment-methods>
    <authorization-code>success</authorization-code>
</payment>
refund-capture
XML refund-capture Request (Successful)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
     <merchant-account-id>0e0a466b-bed8-4eb3-973f-faddd77e692c</merchant-account-id>
     <request-id>$(unique for each request}</request-id>
     <transaction-type>refund-capture</transaction-type>
    <payment-methods>
       <payment-method name="paybox"/>
    </payment-methods>
     <parent-transaction-id>321d784f-15c9-11e5-b0a7-005056a97509</parent-transaction-id>
     <ip-address>127.0.0.1</ip-address>
</payment>
XML refund-capture Response (Successful)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment" self="http://p-grz-web02.wirecard.lan:8080/engine/rest/merchants/0e0a466b-bed8-4eb3-973f-faddd77e692c/payments/32b39020-15c9-11e5-b0a7-005056a97509">
    <merchant-account-id ref="http://p-grz-web02.wirecard.lan:8080/engine/rest/merchants/0e0a466b-bed8-4eb3-973f-faddd77e692c">0e0a466b-bed8-4eb3-973f-faddd77e692c</merchant-account-id>
    <transaction-id>32b39020-15c9-11e5-b0a7-005056a97509</transaction-id>
    <request-id>$(unique for each request}</request-id>
    <transaction-type>refund-capture</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2015-06-18T14:49:18.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="paybox:The resource was successfully created." severity="information"/>
    </statuses>
    <requested-amount currency="EUR">1.01</requested-amount>
    <account-holder>
        <phone>+43100</phone>
    </account-holder>
    <ip-address>127.0.0.1</ip-address>
    <order-number>0</order-number>
    <order-detail>order detail</order-detail>
    <descriptor>Customer 007</descriptor>
    <payment-methods>
        <payment-method name="paybox"/>
    </payment-methods>
    <api-id>elastic-api</api-id>
</payment>
refund-purchase
XML refund-purchase Request (Successful)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
     <merchant-account-id>0e0a466b-bed8-4eb3-973f-faddd77e692c</merchant-account-id>
     <request-id>$(unique for each request}</request-id>
     <transaction-type>refund-purchase</transaction-type>
    <payment-methods>
       <payment-method name="paybox"/>
    </payment-methods>
     <parent-transaction-id>264082a3-15c7-11e5-b0a7-005056a97509</parent-transaction-id>
     <ip-address>127.0.0.1</ip-address>
</payment>
XML refund-purchase Response (Successful)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment" self="http://p-grz-web02.wirecard.lan:8080/engine/rest/merchants/0e0a466b-bed8-4eb3-973f-faddd77e692c/payments/269e9ea3-15c7-11e5-b0a7-005056a97509">
    <merchant-account-id ref="http://p-grz-web02.wirecard.lan:8080/engine/rest/merchants/0e0a466b-bed8-4eb3-973f-faddd77e692c">0e0a466b-bed8-4eb3-973f-faddd77e692c</merchant-account-id>
    <transaction-id>269e9ea3-15c7-11e5-b0a7-005056a97509</transaction-id>
    <request-id>$(unique for each request}</request-id>
    <transaction-type>refund-purchase</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2015-06-18T14:34:39.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="paybox:The resource was successfully created." severity="information"/>
    </statuses>
    <requested-amount currency="EUR">1.01</requested-amount>
    <account-holder>
        <phone>+43100</phone>
    </account-holder>
    <ip-address>127.0.0.1</ip-address>
    <order-number>0</order-number>
    <order-detail>order detail</order-detail>
    <descriptor>Customer 007</descriptor>
    <payment-methods>
        <payment-method name="paybox"/>
    </payment-methods>
    <api-id>elastic-api</api-id>
</payment>
void-authorization
XML void-authorization Request (Successful)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment">
     <merchant-account-id>0e0a466b-bed8-4eb3-973f-faddd77e692c</merchant-account-id>
     <request-id>$(unique for each request}</request-id>
     <transaction-type>void-authorization</transaction-type>
    <payment-methods>
       <payment-method name="paybox"/>
    </payment-methods>
     <parent-transaction-id>d6e3497e-15c7-11e5-b0a7-005056a97509</parent-transaction-id>
     <ip-address>127.0.0.1</ip-address>
</payment>
XML void-authorization Response (Successful)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment" self="http://p-grz-web02.wirecard.lan:8080/engine/rest/merchants/0e0a466b-bed8-4eb3-973f-faddd77e692c/payments/d739eb5a-15c7-11e5-b0a7-005056a97509">
    <merchant-account-id ref="http://p-grz-web02.wirecard.lan:8080/engine/rest/merchants/0e0a466b-bed8-4eb3-973f-faddd77e692c">0e0a466b-bed8-4eb3-973f-faddd77e692c</merchant-account-id>
    <transaction-id>d739eb5a-15c7-11e5-b0a7-005056a97509</transaction-id>
    <request-id>$(unique for each request}</request-id>
    <transaction-type>void-authorization</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2015-06-18T14:39:35.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="paybox:The resource was successfully created." severity="information"/>
    </statuses>
    <requested-amount currency="EUR">1.01</requested-amount>
    <account-holder>
        <phone>+43100</phone>
    </account-holder>
    <ip-address>127.0.0.1</ip-address>
    <order-number>0</order-number>
    <order-detail>order detail</order-detail>
    <descriptor>Customer 007</descriptor>
    <payment-methods>
        <payment-method name="paybox"/>
    </payment-methods>
    <api-id>elastic-api</api-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">
     <merchant-account-id>0e0a466b-bed8-4eb3-973f-faddd77e692c</merchant-account-id>
     <request-id>$(unique for each request}</request-id>
     <transaction-type>void-purchase</transaction-type>
    <payment-methods>
       <payment-method name="paybox"/>
    </payment-methods>
     <parent-transaction-id>c391dd8f-15c6-11e5-b0a7-005056a97509</parent-transaction-id>
     <ip-address>127.0.0.1</ip-address>
</payment>
XML void-purchase Response (Successful)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<payment xmlns="http://www.elastic-payments.com/schema/payment" self="http://p-grz-web02.wirecard.lan:8080/engine/rest/merchants/0e0a466b-bed8-4eb3-973f-faddd77e692c/payments/c3ea4dc7-15c6-11e5-b0a7-005056a97509">
    <merchant-account-id ref="http://p-grz-web02.wirecard.lan:8080/engine/rest/merchants/0e0a466b-bed8-4eb3-973f-faddd77e692c">0e0a466b-bed8-4eb3-973f-faddd77e692c</merchant-account-id>
    <transaction-id>c3ea4dc7-15c6-11e5-b0a7-005056a97509</transaction-id>
    <request-id>$(unique for each request}</request-id>
    <transaction-type>void-purchase</transaction-type>
    <transaction-state>success</transaction-state>
    <completion-time-stamp>2015-06-18T14:31:54.000Z</completion-time-stamp>
    <statuses>
        <status code="201.0000" description="paybox:The resource was successfully created." severity="information"/>
    </statuses>
    <requested-amount currency="EUR">1.01</requested-amount>
    <account-holder>
        <phone>+43100</phone>
    </account-holder>
    <ip-address>127.0.0.1</ip-address>
    <order-number>0</order-number>
    <order-detail>order detail</order-detail>
    <descriptor>Customer 007</descriptor>
    <payment-methods>
        <payment-method name="paybox"/>
    </payment-methods>
    <api-id>elastic-api</api-id>
</payment>
Custom URL: