This is a detailed description of the input and output values in the payment webserivce, which are used for normal payments. The webserivce for normal payments is to be found on this URL:
How to read the documentation
Every description of a function consists of input and output. Input is all the fields the webservice expects you to set as you call it. Fields given by BOLD are mandatory the rest can be given as empty values. The output fields are the ones which the webservice returns.
Dataflow
- "Authorize" - Requires PCI certification. Instead of use one of the following two solutions:
Standard Payment window or own payment form.
- The payment is captured by use of the remote call ”Capture”. As this call is completed the captured amount is transferred from the card holder’s account to the internet shop’s account by the aquire.
- If the order is returned back to the internet shop or if it is cancelled and the ”Capture” has been performed to ePay, the order amount can be reversed to the card holder’s account, by use of the “Credit” call.
- If the order is returned or cancelled before the ”Capture” is carried through, the full amount can be released by use of the ”Delete” function.
Datatypes
The webservice uses objects and data types defined in the SOAP format. The types are: Integer, Long, String, Enum, Boolean and DateTime. The DateTime must be formatted: "yyyy-MM-dd HH:mm:ss". All functions return a boolean, which indicates if the operation was succeeded. If the returning value is false the integer values "epayresponse" and "pbsresponse" that can be used to figure out what the reason was.
Description of the functions in the webservice
| Input |
Datatype |
Values |
Description |
| Merchantnumber |
Integer |
7 digits |
The unique merchant number which is created in ePay. The merchant number is located on your agreement with the acquirer (eg. PBS). |
| Transactionid |
Long |
|
The unique number to identify the payment returned during the authorization. |
| Amount |
Integer |
Minor Units |
The amount in minor units. Eg. DKK 125,75 must be specified as 12575 in the amount field. |
| Group |
String |
Max. 100 characters |
Which group the payment will be associated to. |
| OutPut |
Datatype |
Values |
Description |
| captureResult |
Boolean |
|
See description of output values. |
| Pbsresponse |
Integer |
|
If PBS declines the capture the error code is defined in pbsresponse. If the payment is captured this value is 0. |
| epayresponse |
Integer |
|
If ePay declines the payment the error code is defined in epayresponse. |
| Output values |
If the capture is approved captureResult will return true. Otherwise the returning value is false. If the function call returns false the epayresponse and pbsresponse must be used to figure out what the error was. |
| Input |
Datatype |
Values |
Description |
| Merchantnumber |
Integer |
7 digits |
The unique merchant number which is created in ePay. The merchant number is located on your agreement with the acquirer (eg. PBS). |
| Transactionid |
Long |
|
The unique number to identify the payment returned during the authorization. |
| Amount |
Integer |
Minor Units |
The amount in minor units. Eg. DKK 125,75 must be specified as 12575 in the amount field. |
| Group |
String |
Max. 100 characters |
Which group the payment will be associated to. |
| OutPut |
Datatype |
Values |
Description |
| creditResult |
Boolean |
|
See description of output values. |
| Pbsresponse |
Integer |
|
If PBS declines the capture the error code is defined in pbsresponse. If the payment is captured this value is 0. |
| epayresponse |
Integer |
|
If ePay declines the delete, the error code is defined in epayresponse. |
| Output values |
If the credit completed the creditResult will return true. Otherwise the returning value is false. If the function call returns false the epayresponse and pbsresponse must be used to figure out what the error was. |
| Input |
Datatype |
Values |
Description |
| Merchantnumber |
Integer |
7 digits |
The unique merchant number created in ePay. This merchant number is to be found in your contract with PBS. |
| Transactionid |
Long |
|
The unique number to identify the payment returned during the authorization. |
| Group |
String |
Max. 100 characters |
Which group the payment will be associated to. |
| OutPut |
Datatype |
Values |
Description |
| deleteResult |
Boolean |
|
See description of output values. |
| epayresponse |
Integer |
|
If ePay declines the delete, the error code is defined in epayresponse. |
| Output values |
If the payment is deleted the deleteResult returns true. Otherwise the returning value is false. If the function call returns false the epayresponse and pbsresponse must be used to figure out what the error was |
| Input |
Datatype |
Values |
Description |
| Merchantnumber |
Integer |
7 digits |
The unique merchant number which is created in ePay. The merchant number is located on your agreement with the acquirer (eg. PBS). |
| Language |
Integer |
1 |
Which language the result will be returned in
(1) for Danish
(2) for English
(3) for Swedish
|
| Epayresponsecode |
Integer |
|
Error code received from ePay in the epayresponse. |
| OutPut |
Datatype |
Values |
Description |
| getEpayErrorResult |
Boolean |
|
See description of output values. |
| epayResponseString |
String |
|
The error returned as string from ePay. |
| epayresponse |
Integer |
|
If ePay declines the payment, the error code is defined in epayresponse. |
| Output values |
If it is possible to retrieve information about the error code, the getEpayErrorResult will return true. Otherwise the returning value is false. If the call returns false epayresponse has to be used to find out the reason why. |
| Input |
Datatype |
Values |
Description |
| Merchantnumber |
Integer |
7 digits |
The unique merchant number which is created in ePay. The merchant number is located on your agreement with the acquirer (eg. PBS). |
| Language |
Integer |
1 |
Which language the result will be returned in
(1) for Danish
(2) for English
(3) for Swedish
|
| pbsresponsecode |
Integer |
|
Error code received from PBS in the pbsresponse. |
| OutPut |
Datatype |
Values |
Description |
| getPbsErrorResult |
Boolean |
|
See description of output values. |
| pbsResponseString |
String |
|
The error returned as string from ePay. |
| epayresponse |
Integer |
|
If ePay declines the payment, the error code is defined in epayresponse. |
| Output values |
it is possible to retrieve information about the error code, the getPbsErrorResult will return true. Otherwise the returning value is false. If the call returns false epayresponse has to be used to find out the reason why. |
| Input |
Datatype |
Values |
Description |
| Merchantnumber |
Integer |
7 digits |
The unique merchant number which is created in ePay. The merchant number is located on your agreement with the acquirer (eg. PBS). |
| Cardnumber |
String |
Max. 20 characters |
The cardnumber of the card holder's credit card. |
| OutPut |
Datatype |
Values |
Description |
| getcardtypeResult |
Boolean |
|
See description of output values. |
| Cardtypeid |
Integer |
|
The card type as Integer |
| Cardname |
String |
|
The name of the card type (eg. DANKORT) |
| epayresponse |
Integer |
|
If ePay declines the payment, the error code is defined in epayresponse. |
| Output values |
Is it possible to return information about the card, the getcardtypeResult is true. Otherwise the value will be false. As the call returns false the epayresponse is to be used to find out the reason why. |
| Input |
Datatype |
Values |
Description |
| Merchantnumber |
Integer |
7 digits |
The unique merchant number which is created in ePay. The merchant number is located on your agreement with the acquirer (eg. PBS). |
| Transactionid |
Long |
|
The unique number to identify the payment returned during the authorization. |
| OutPut |
Datatype |
Values |
Description |
| Group |
String |
|
Group (If defined) |
| Authamount |
Integer |
|
Amount authorized on the card holder's credit card. |
| Currency |
Integer |
|
Currency of the authorization. |
| Cardtypeid |
Integer |
|
Cardtype of the credit card used. |
| Capturedamount |
Integer |
|
Amount captured. |
| Creditedamount |
Integer |
|
Amount credited. |
| Orderid |
String |
|
Order number |
| Description |
String |
|
Description (If defined) |
| Authdate |
dateTime |
|
Date of the authorization. |
| Captureddate |
dateTime |
|
Date of the capture. |
| Deleteddate |
dateTime |
|
Date of the deletion. |
| Crediteddate |
dateTime |
|
Date of the credit. |
| Status |
Enum |
| 0 |
= PAYMENT_UNDEFINED |
| 1 |
= PAYMENT_NEW |
| 2 |
= PAYMENT_CAPTURED |
| 3 |
= PAYMENT_DELETED |
| 4 |
= PAYMENT_DELETED |
| 5 |
= PAYMENT_SUBSCRIPTION_INI |
|
Status of the payment. As standard the status is PAYMENT_NEW.
As the payment is captured it is given the status PAYMENT_CAPTURED. |
| [ History ] List start |
| transactionHistoryID |
Long |
|
Unique ID for the history. |
| logonID |
Integer |
|
Unique ID for the user who performed the operation. |
| eventMsg |
String |
|
Description of the operation. |
| created |
DateTime |
|
When the operation was performed. |
| [ History ] List end |
| Transactionid |
Long |
|
The unique number to identify the payment returned during the authorization. |
| Cardholder |
String |
|
Name of the card holder (if defined) |
| Mode |
Enum |
0 = MODE_PRODUCTION
1 = MODE_TEST |
If the payment is type: test or production. |
| Epayresponse |
Integer |
|
If ePay declines the payment the reason is defined in epayresponse. |
| Output values |
It is possible to retrieve information about the payment the function will return true. Otherwise the returning value is false. As the returning value is false the epayresponse has to be used to find out what the reason was. |
| Input |
Datatype |
Values |
Description |
| Merchantnumber |
Integer |
7 digits |
The unique merchant number which is created in ePay. The merchant number is located on your agreement with the acquirer (eg. PBS). |
| Status |
Enum |
| 0 |
= PAYMENT_UNDEFINED |
| 1 |
= PAYMENT_NEW |
| 2 |
= PAYMENT_CAPTURED |
| 3 |
= PAYMENT_DELETED |
| 4 |
= PAYMENT_DELETED |
| 5 |
= PAYMENT_SUBSCRIPTION_INI |
|
Status of the payment. As standard the status is PAYMENT_NEW.
As the payment is captured it is given the status PAYMENT_CAPTURED. |
| Searchdatestart |
Datetime |
Null (nothing) og den ignorers |
Start date (Defined as: "yyyy-MM-dd HH:mm:ss"). |
| Searchdateend |
Datetime |
Null (nothing) og den ignorers |
End date (defined as: "yyyy-MM-dd HH:mm:ss"). |
| Searchgroup |
String |
Max. 100 characters |
Search for payments in a defined group. (allowed empty) |
| searchorderid |
String |
Max. 20 characters |
Search for payments with defined order number (allowed empty) |
| OutPut |
Datatype |
Values |
Description |
| Output værdier |
See the result in GetTransaction. The values are the same. However they are enclosed into transactionInformationArray, which is an array of TransactionInformationType types.
See output values here GetTransaction. |
| Input |
Datatype |
Values |
Description |
| Merchantnumber |
Integer |
7 digits |
The unique merchant number which is created in ePay. The merchant number is located on your agreement with the acquirer (eg. PBS). |
| Cardno_prefix |
Integer |
6 digits |
Prefix on the creditcard to calculate fee on. It is important only the first six digits is defined, otherwise the system will reject the call.
Note that eDankort, Danske Bank, Nordea og EWIRE must use following prefixes:
| 000012 |
eDankort |
| 000022 eller 000023 |
Danske Bank Net-betaling |
| 000021 |
Nordea e-betaling |
| 000017 |
EWIRE |
|
| Amount |
Integer |
Minor units |
The amount to calculate transaction fee (Defined in minor units) |
| Currency |
Integer |
208 = DKK
978 = EUR
840 = USD
578 = NOK
752 = SEK
826 = GBP |
Currency which amount is defined in. Eg. if the customer must be settled in Danish kroner, then set the value to 208
See complete list here |
| Acquirer |
Integer |
PBS = 1
SEB = 2
DANSKE_BANK = 3
NORDEA = 4
EWIRE = 5 |
The acquirer to use for the payment. This is normal PBS.
characters |
| OutPut |
Datatype |
Values |
Description |
| Fee |
Integer |
Minor units |
Transaction fee calculated on this value |
| Cardtype |
Integer |
| 1 |
= DANKORT |
| 2 |
= VISA_DANKORT |
| 3 |
= VISA_ELECTRON_FOREIGN |
| 4 |
= MASTERCARD |
| 5 |
= MASTERCARD_FOREIGN |
| 6 |
= VISA_ELECTRON |
| 7 |
= JCB |
| 8 |
= DINERS |
| 10 |
= AMERICAN_EXPRESS |
| 13 |
= DINERS_FOREIGN |
| 14 |
= AMERICAN_EXPRESS_FOREIGN |
| 16 |
= FORBRUGSFORENINGEN |
| 18 |
= VISA |
| 19 |
= IKANO |
| 24 |
= LIC_MASTERCARD |
| 25 |
= LIC_MASTERCARD_FOREIGN |
|
Type that the creditcard is calculated to. |
| CardTypeText |
String |
|
Cardholder name on card. |
| ePayResponse |
Integer |
|
If ePay declines the API call (Will return false) the reason will be defined in this parameter.
The full list of error codes can be found inside the administration to ePay under the menu item support.
|
