HTTP Interface

HTTP Interface

HTTP Interface:Overview
DescriptionElectronic Transaction Payment
Version5.1
AuthenticationIP address white-listing
Max request length16384
MethodHTTP (SSL/TLS encrypted) POST and GET, x-www-form-urlencoded
Productive systemhttps://www.mpay24.com/app/bin/etpv5
Test systemhttps://test.mpay24.com/app/bin/etpv5

Legende:

  • Mandatory: All elements with an bold written name and an asterisk are mandatory (e.g. Example*).
  • Optional: All non-marked elements are optional and can be omitted.

Operations

OperationDescription
AcceptPaymentDirect payment interface
AcceptWithdrawDirect withdraw interface
SelectPaymentInteractive payment interface
ManualClearClear transaction(s)
ManualReverseReversal (not cleared) transaction
ManualCreditCredit already cleared transaction
ListProfilesList stored payment profiles
DeleteProfileDelete stored payment profile
ListPaymentMethodsList available payment methods (for specific pType)
TransactionStatusGet transaction status for specified mpayTID or tid
TransactionHistoryGet transaction history for specified mpayTID

AcceptPayment

Input

ElementTypeRestrictionDescription
MERCHANTID*numeric[0-9]{5}mPAY24 merchant ID
OPERATION*enumerationACCEPTPAYMENTOperation to perform
P_TYPE*PaymentType-Payment type of the transaction
PRICE*numeric[0-9]{2,11}Amount stated in cents
CURRENCY*alphanumeric[A-Z]{3}Three digit ISO country code
TIDalphanumeric.{1,32}Unique merchant transaction ID
CLEARINGenumeration1, 0Deprecated
AUTOCLEARenumerationY, NDefines if the transaction should be cleared automatically
CUSTOMERalphanumeric.{1,50}Customer name
CUSTOMER_IDalphanumeric.{1,32}Merchant ustomer ID
CUSTOMER_EMAILalphanumeric[-0-9a-zA-Z+.@_] {5,64}Customer e-mail
PROFILEenumerationY, NDefines if the payment details should be stored by mPAY24
ORDERDESCalphanumeric.{1,255}Order description
USER_FIELDalphanumeric.{1,255}User variable (is communicated over the URLs)
ORDERalphanumeric.{1,2048}Order description provided as XML
SUCCESS_URLURL-URL for customer redirection in case of success
ERROR_URLURL-URL for customer redirection in case of error
CONFIRMATION_URLURL-URL for receiving push notifications about the transaction state
LANGUAGEalphanumeric[A-Z]{2}Two digits language ISO code
BRANDBrand-Brand abbreviation

Output

ElementTypeRestrictionDescription
STATUS*enumerationOK, ERRORResponse status of the operation
RETURNCODE*enumerationOK, ...Return code of the operation
LOCATIONalphanumeric(https://).{5,1016}Redirection location of the customer
EXTERNAL_ERRORalphanumeric.{1,255}Further information upon an error
MPAYTIDnumeric[0-9]{1,11}Unique mPAY24 transaction ID

Input: CC

CreditCard specific payment parameters

ElementTypeRestrictionDescription
P_TYPE*enumerationCCPayment type of the transaction
BRAND*enumerationAMEX, DINERS, JCB, MASTERCARD, VISABrand abbreviation
IDENTIFIER*alphanumeric.{1,20}Payment identifier
EXPIRY*alphanumericFormat: YYMMExpiry date
CVCnumeric[0-9]{3,4}CVC
AUTH_3DSenumerationY, NEnable or disable 3DS authentication

Input: ELV

Direct debit specific payment parameters

ElementTypeRestrictionDescription
P_TYPE*enumerationELVPayment type of the transaction
BRAND*enumerationATOS, BILLPAY, HOBEX-AT, HOBEX-DE, HOBEX-NLBrand abbreviation
IBAN*alphanumeric.{1,34}International bank account number of the customer
BICalphanumeric.{1,11}Bank identifier code of the customer
MANDATE_IDalphanumeric.{1,35}Mandate ID of the transaction assigned by the merchant
DATE_OF_SIGNATUREalphanumericFormat: YYYY-MM-DDDate of the mandate signature

Input: EPS

Online-banking (eps) specific payment parameters

ElementTypeRestrictionDescription
P_TYPE*enumerationEPSPayment type of the transaction
BRAND*enumerationEPSBrand abbreviation
BANK_ID*numeric[0-9]{1,3}Bank ID

Input: GIROPAY

Online-banking (giropay) specific payment parameters

ElementTypeRestrictionDescription
P_TYPE*enumerationGIROPAYPayment type of the transaction
IBANalphanumeric.{1,34}International bank account number of the customer
BIC*alphanumeric.{1,11}Bank identifier code of the customer

Input: MAESTRO

Debit card specific payment parameters

ElementTypeRestrictionDescription
P_TYPE*enumerationMAESTROPayment type of the transaction
IDENTIFIER*alphanumeric.{1,20}Payment identifier
EXPIRY*alphanumericFormat: YYMMExpiry date

Input: PAYPAL

PayPal specific payment parameters

ElementTypeRestrictionDescription
CUSTOMalphanumeric.{1,255}A free-form field for your own use

Input: PB

paybox specific payment parameters

ElementTypeRestrictionDescription
P_TYPE*enumerationPBPayment type of the transaction
IDENTIFIER*alphanumeric.{1,20}Payment identifier
PAYDAYSnumeric[0-9]{1,2}
RESERVEDAYSnumeric[0-9]{1,2}

Input: KLARNA

Klarna specific payment parameters

ElementTypeRestrictionDescription
P_TYPE*enumerationKLARNAPayment type of the transaction
BRAND*enumerationINVOICE, HPBrand abbreviation
GENDER*enumerationM, FCustomer gender
PERSONAL_NUMBER*alphanumeric.{1,11}Personal number of the user or the birthday for countries without personal number
PHONE*alphanumeric.{1,20}Customer phone number
PCLASSnumeric[0-9]{1,5}Payment class defined by Klarna

AcceptWithdraw

Input

ElementTypeRestrictionDescription
MERCHANTID*numeric[0-9]{5}mPAY24 merchant ID
OPERATION*enumerationACCEPTWITHDRAWOperation to perform
P_TYPE*PaymentType-Payment type of the transaction
PRICE*numeric[0-9]{2,11}Amount stated in cents
CURRENCY*alphanumeric[A-Z]{3}Three digit ISO country code
TIDalphanumeric.{1,32}Unique merchant transaction ID
CUSTOMERalphanumeric.{1,50}Customer name
CUSTOMER_IDalphanumeric.{1,32}Merchant ustomer ID
CUSTOMER_EMAILalphanumeric[-0-9a-zA-Z+.@_] {5,64}Customer e-mail
ORDERDESCalphanumeric.{1,255}Order description
USER_FIELDalphanumeric.{1,255}User variable (is communicated over the URLs)
ORDERalphanumeric.{1,2048}Order description provided as XML
CONFIRMATION_URLURL-URL for receiving push notifications about the transaction state
BRANDBrand-Brand abbreviation

Output

ElementTypeRestrictionDescription
STATUS*enumerationOK, ERRORResponse status of the operation
RETURNCODE*enumerationOK, ...Return code of the operation
EXTERNAL_ERRORalphanumeric.{1,255}Further information upon an error
MPAYTIDnumeric[0-9]{1,11}Unique mPAY24 transaction ID

Input: CC

CreditCard specific payment parameters

ElementTypeRestrictionDescription
P_TYPE*enumerationCCPayment type of the transaction
BRAND*enumerationAMEX, DINERS, MASTERCARD, VISABrand abbreviation
IDENTIFIER*alphanumeric.{1,20}Payment identifier
EXPIRY*alphanumericFormat: YYMMExpiry date

Input: MAESTRO

Debit card specific payment parameters

ElementTypeRestrictionDescription
P_TYPE*enumerationMAESTROPayment type of the transaction
IDENTIFIER*alphanumeric.{1,20}Payment identifier
EXPIRY*alphanumericFormat: YYMMExpiry date

SelectPayment

All payment relevant information (e.g. amount, customer name, shopping cart, ...) are provided within the MDXI XML.

Input

ElementTypeRestrictionDescription
MERCHANTID*numeric[0-9]{5}mPAY24 merchant ID
OPERATION*enumerationSELECTPAYMENTOperation to perform
MDXI*alphanumeric`.[\n\r\t]{1,8192}`

Output

ElementTypeRestrictionDescription
STATUS*enumerationOK, ERRORResponse status of the operation
RETURNCODE*enumerationOK, ...Return code of the operation
LOCATIONalphanumeric(https://).{5,1016}Redirection location of the customer

ManualClear

Input

ElementTypeRestrictionDescription
MERCHANTID*numeric[0-9]{5}mPAY24 merchant ID
OPERATION*enumerationMANUALCLEAROperation to perform
MPAYTID*numeric[0-9]{1,11}Unique mPAY24 transaction ID
PRICEnumeric[0-9]{2,11}Amount stated in cents
ORDERalphanumeric`.[\n\r\t]{1,2048}`

Input

ElementTypeRestrictionDescription
MERCHANTIDnumeric[0-9]{5}mPAY24 merchant ID
OPERATION*enumerationMANUALCLEAROperation to perform
MPAYTID_XXX*numeric[0-9]{1,11}Unique mPAY24 transaction ID
PRICE_XXXnumeric[0-9]{2,11}Amount stated in cents
ORDER_XXXalphanumeric`.[\n\r\t]{1,2048}`
SUMnumeric[0-9]{1,3}Sum of elements

Output

ElementTypeRestrictionDescription
STATUS*enumerationOK, ERRORResponse status of the operation
RETURNCODE*enumerationOK, ...Return code of the operation
MPAYTIDnumeric[0-9]{1,11}Unique mPAY24 transaction ID
TIMESTAMPnumeric[0-9]{14}Timestamp of the operation

ManualReverse

Input

ElementTypeRestrictionDescription
MERCHANTID*numeric[0-9]{5}mPAY24 merchant ID
OPERATION*enumerationMANUALREVERSEOperation to perform
MPAYTID*numeric[0-9]{1,11}Unique mPAY24 transaction ID

Output

ElementTypeRestrictionDescription
STATUSenumerationOK, ERRORResponse status of the operation
RETURNCODEenumerationOK, ...Return code of the operation
MPAYTIDnumeric[0-9]{1,11}Unique mPAY24 transaction ID
TIDalphanumeric.{1,32}Unique merchant transaction ID
TIMESTAMPnumeric[0-9]{14}Timestamp of the operation

ManualCredit

Input

ElementTypeRestrictionDescription
MERCHANTID*numeric[0-9]{5}mPAY24 merchant ID
OPERATION*enumerationMANUALCREDITOperation to perform
MPAYTID*numeric[0-9]{1,11}Unique mPAY24 transaction ID
STATEIDnumeric[0-9]{1,11}Unique ID of a transaction state
PRICEnumeric[0-9]{2,11}Amount stated in cents

Output

ElementTypeRestrictionDescription
STATUS*enumerationOK, ERRORResponse status of the operation
RETURNCODE*enumerationOK, ...Return code of the operation
MPAYTIDnumeric[0-9]{1,11}Unique mPAY24 transaction ID
TIMESTAMPnumeric[0-9]{14}Timestamp of the operation

ListProfiles

Input

ElementTypeRestrictionDescription
MERCHANTID*numeric[0-9]{5}mPAY24 merchant ID
OPERATION*enumerationLISTPROFILESOperation to perform
B_IDXnumeric[0-9]{1,6}Index of the first element being listed
E_IDXnumeric[0-9]{1,6}Index of the last element being listed

Output

ElementTypeRestrictionDescription
STATUS*enumerationOK, ERRORResponse status of the operation
RETURNCODE*enumerationOK, ...Return code of the operation
ALL*numeric[0-9]{1,3}Total number of payment methods
SUM*numeric[0-9]{1,3}Sum of elements
CUSTOMER_ID_XXXalphanumeric.{1,3}Merchant ustomer ID
UPDATED_XXXalphanumericFormat: YYYY-MM-DD HH:MM:SSTimestamp of last change

DeleteProfile

Input

ElementTypeRestrictionDescription
MERCHANTID*numeric[0-9]{5}mPAY24 merchant ID
OPERATION*enumerationDELETEPROFILEOperation to perform
CUSTOMER_ID*alphanumeric.{1,32}Merchant ustomer ID

Output

ElementTypeRestrictionDescription
STATUS*enumerationOK, ERRORResponse status of the operation
RETURNCODE*enumerationOK, ...Return code of the operation

ListPaymentMethods

Input

ElementTypeRestrictionDescription
MERCHANTID*numeric[0-9]{5}mPAY24 merchant ID
OPERATION*numeric[0-9]{5}Operation to perform
P_TYPEPaymentType-Payment type of the transaction

Output

ElementTypeRestrictionDescription
STATUS*enumerationOK, ERRORResponse status of the operation
RETURNCODE*enumerationOK, ...Return code of the operation
ALLnumeric[0-9]{1,3}Total number of payment methods
P_TYPE_XXXPaymentType-Payment type of the transaction
BRAND_XXXBrand-Brand abbreviation
DESCRIPTION_XXXalphanumeric.{1,255}Payment system description

TransactionStatus

Input

ElementTypeRestrictionDescription
MERCHANTID*numeric[0-9]{5}mPAY24 merchant ID
OPERATION*enumerationTRANSACTIONSTATUSOperation to perform
MPAYTIDnumeric[0-9]{1,11}Unique mPAY24 transaction ID
TIDalphanumeric.{1,32}Unique merchant transaction ID

Output

Additional to the returned elements below, the operation returns also the details of the payment notification.

ElementTypeRestrictionDescription
STATUS*enumerationOK, ERRORResponse status of the operation
RETURNCODE*enumerationOK, ...Return code of the operation

TransactionHistory

Input

ElementTypeRestrictionDescription
MERCHANTID*numeric[0-9]{5}mPAY24 merchant ID
OPERATION*enumerationTRANSACTIONHISTORYOperation to perform
MPAYTIDnumeric[0-9]{1,11}Unique mPAY24 transaction ID

Output

ElementTypeRestrictionDescription
STATUS*enumerationOK, ERRORResponse status of the operation
RETURNCODE*enumerationOK, ...Return code of the operation
STATEID_XXXnumeric[0-9]{1,11}Unique ID of a transaction state
PARENTSTATEID_XXXnumeric[0-9]{1,11}ID of the related parent state
TS_XXXnumeric[0-9]{14}Timestamp of the transaction state
AMOUNT_XXXnumeric[0-9]{2,11}Amount stated in cents
TXSTATE_XXXalphanumeric.{1,255}Transaction state
PROFILESTATUS_XXXalphanumeric.{1,255}Profile status of the action

Special types

Simple types / enumerations

ElementTypeRestrictionDescription
PaymentTypeenumerationCC, MAESTRO, EPS, PB, GIROPAY, ELV, PSC, QUICK, PAYPAL, MPASS, BILLPAY, INVOICE, HP, KLARNA, SOFORT, PROFILEPayment type
BrandenumerationAMEX, DINERS, JCB, MASTERCARD, VISA, EPS, ELV, ATOS, HOBEX-AT, HOBEX-DE, HOBEX-NL, B4P, BILLPAY, KLARNABrand abbreviation
URLalphanumeric{5,1016}URL definition