Welcome to the mPAY24 Developer portal.

mPAY24 makes it easy to accept payments in your website or app.
Get integrated quickly using our documentation or using a plugin for your shop system.

Withdrawal

With the AcceptWithdraw call a transaction can be made to transfer an amount from the merchant to the customer. If successful, the transaction is in state WITHDRAWN.

🚧

Currently supported Payment systems:
Credit Cards over acquirer PXP (Kalixa).
Direct Debit over acquirer B4Payment.

Operation: AcceptWithdraw

A withdraw payment can be done by providing the card, or the bank account data of the customer and the payment data (amount and currency).

📘

The amount element is provided as cent amount.

Example for Credit Card (due to PCI-DSS restrictions we recommend using profiles)

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:ns1="http://www.w3.org/2001/XMLSchema"
               xmlns:etp="https://www.mpay24.com/soap/etp/1.5/ETP.wsdl" 
               xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
               xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
               xsl:version="1.0">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <etp:AcceptWithdraw>
      <merchantID>90000</merchantID>
      <tid>160530-084601</tid>
      <pType>PROFILE</pType>
      <etp:withdraw xsi:type="etp:WithdrawPROFILE">
        <amount>1000</amount>
        <currency>EUR</currency>
      </etp:withdraw>
      <customerID>123456</customerID>
    </etp:AcceptWithdraw>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
<SOAP-ENV:Envelope 
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
  xmlns:etp="https://www.mpay24.com/soap/etp/1.5/ETP.wsdl">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <etp:AcceptWithdrawResponse>
      <status>OK</status>
      <returnCode>PROFILE_USED</returnCode>
      <mpayTID>193604</mpayTID>
    </etp:AcceptWithdrawResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Example for direct debit:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:ns1="http://www.w3.org/2001/XMLSchema"
               xmlns:etp="https://www.mpay24.com/soap/etp/1.5/ETP.wsdl" 
               xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
               xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
               xsl:version="1.0">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <etp:AcceptWithdraw>
      <merchantID>92883</merchantID>
      <tid>160530-084601</tid>
      <pType>ELV</pType>
      <etp:withdraw xsi:type="etp:WithdrawELV">
        <amount>100</amount>
        <currency>EUR</currency>
        <brand>B4P</brand>
        <iban>DE09100100101234567893</iban>
        <bic>PBNKDEFFXXX</bic>
      </etp:withdraw>
    </etp:AcceptWithdraw>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
<SOAP-ENV:Envelope 
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
  xmlns:etp="https://www.mpay24.com/soap/etp/1.5/ETP.wsdl">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <etp:AcceptWithdrawResponse>
      <status>OK</status>
      <returnCode>OK</returnCode>
      <mpayTID>193606</mpayTID>
    </etp:AcceptWithdrawResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

As response the withdrawn transaction is listed with its current state.

📘

Status Confirmation

Unlike other payment methods the initial status for B4P transactions is 'SUSPENDED'. After our reconciliation (every 180 minutes) the status BILLED, ERROR, BILLED_REVERSAL, WITHDRAWN will be communicated over the confirmation interface.

📘

The status and returnCode should be checked to determine if the operation was successful.

The result is also communicated via the confirmationURL (STATUS: WITHDRAWN).

Updated about a year ago

Withdrawal


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.