1. Changelog
Version | Date | Description |
---|---|---|
9.7 |
2023-06-30 |
Add new optional fields to request in payment methods: street, houseNumber, city, postalCode, province. |
9.6 |
2023-06-28 |
Added new optional field: authMethod and tokenType for method Token payment. |
9.5 |
2023-05-11 |
Deleted noCurrencyConversion field for payment methods. |
9.4 |
2023-03-21 |
Added new optional fields for method /client/3ds/authentication regarding Cardholder Billing Card Information |
9.3 |
2023-03-06 |
Added new optional field: phoneNumber to Recurring Initial, CoF Initial and Account status inquiry requests. New API status: E01607 - Transaction rejected, internal server error during authorization request generation added to all payment responses. |
9.2 |
2023-01-30 |
Bugfix (adaptation to documentation) - make 3DS mandatory for 5.9.1 Recurring Payment - initial transaction |
9.1 |
2022-12-16 |
New error status: E01606 - Transaction rejected, country of residence is not permitted |
9.0 |
2020-12-15 |
New transaction status, min amount limit per terminal (E01605) + 2.6.4. Payment |
8.9 |
2022-11-24 |
New field on payment method - country of residence required for merchants crypto |
8.8 |
2022-10-20 |
PENDING prevent feature released, more information here: 6.4. Payment + 6.4. Payment |
8.7 |
2022-10-26 |
Removal from use 3DS 1 for all countries (except those configured in the system) |
8.6 |
2022-10-24 |
Adding information about the withdrawal of 3DSv1. |
8.5 |
2022-09-28 |
First BLIK release. New response codes to blik methods: E0164, E0165, E0166, E0167, E0189, E00180, E9800 |
8.4 |
2022-09-16 |
New terminal limits added: + E10000 Transaction rejected, terminal daily card transaction limit exceeded, + E10001 Transaction rejected, terminal daily transaction limit, + E10002 Transaction rejected, terminal monthly transaction limit exceeded, + 2.6.4. Payment |
8.3 |
2022-08-29 |
New API fields in authorization response - cardBlockadeAdditionalData.blockType, cardBlockadeAdditionalData.blockedUntil present when transaction was rejected because card was blocked. Example response is available in authorize response sections. |
8.2 |
2022-08-22 |
New fields on payment method - there are data address sender required for crypto or wallet |
8.1 |
2022-08-01 |
New response fields on 3DS 2.X Response: 'errorCode', 'errorCodeDetails', Request: challengeWindowSize |
8.0 |
2022-05-05 |
New response codes to payment methods: E209 - sender name contains fraudulent phrase, E0210 - Transaction rejected, suspicious sender name |
7.9 |
2022-04-08 |
New response fields to transaction details method added: terminalSettlementCurrency, amountInTerminalSettlementCurrency, commissionFenigeInTerminalSettlementCurrency |
7.8 |
2022-03-21 |
Monitoring status added (E0208) 2.7.9. Monitoring |
7.7 |
2021-03-18 |
New API method: Payment JWE. New response statuses: E8009, E8010. E8011. |
7.6 |
2022-03-11 |
Remove Terminal/Merchant management from Fenige Ecommerce API |
7.5 |
2022-03-01 |
Monitoring status added (E0207) 2.7.9. Monitoring |
7.4 |
2021-12-30 |
New transaction status defined for terminal based restricted transaction amounts (E0159) + 6.4 Payments |
7.3 |
2021-12-17 |
New transaction status added (E01602) for all transactions type to indicate blocked transaction in specific geographic scope + 6.10 Details |
7.2 |
2021-12-16 |
Added responseCode - new field in Payment API - Reversal error response (422 UNPROCESSABLE ENTITY with status E0161). |
7.1 |
2021-12-06 |
Updated validation for purchaseAmount in Authentication request in 3DS 2.X verification methods |
7.0 |
2021-11-22 |
Add new response code(E01584, E01585) and change validation for outside3ds.eci |
6.9 |
2021-11-04 |
Add noCurrencyConversion field for payment methods. For more information please refer to 6.4 Payments |
6.8 |
2021-10-26 |
New transaction status added (E01596) for installment payment performed using terminal restricted card country + 6.9. Installment Payment |
6.7 |
2021-10-19 |
Added new optional field 'receiverAmount' in payment methods |
6.6 |
2021-10-18 |
Added description of the use case of the Google pay method. |
6.5 |
2021-10-14 |
Added new types: DOMESTIC_PL, INTRA_EU, INTER to geographicScope field in 6.10 Details |
6.4 |
2021-08-17 |
New error status: E01601 - terminal is blocked for provider |
6.3 |
2021-06-09 |
Added Payment API field 'transactionRef' for determining merchant additional transaction identifier |
6.2 |
2021-05-18 |
New filed on 3DS 1.0 Initialize method to process Token PAN transaction |
6.1 |
2021-05-05 |
An implementation of CODE_65(Mastercard)/CODE_1A(Visa) transaction rejection logic for MASTERCARD and VISA. More details can be found here: 6.4 Payments |
6.0 |
2021-04-19 |
New error status: E01600 in response for 3DS 2.X payment method |
5.9 |
2021-04-09 |
Added card Id support from Datacenter for methods with 3ds 2.x/3ds 1.0 |
5.8 |
2021-04-09 |
Monitoring status added (E0206) 2.7.9. Monitoring |
5.7 |
2021-04-01 |
Introduction of a new webhook functionality. Now it is possible to handle information about transaction status without polling API. 9. Webhooks |
5.6 |
2021-03-10 |
Remove status E01595 and allow processing of all types of payment transactions using quasi-cash terminals |
5.5 |
2021-01-20 |
Internal functionality to restrict access to specific method for PSP. |
5.4 |
2021-01-18 |
New field 'terminalUrl' in Ecommerce Payment requests added. The field is optional now, but it is recommended to include it in your request body. From 2021-05-03 the 'terminalUrl' and 'addressIp' fields will be required. |
5.3 |
2021-01-15 |
Update for 3DS 1.0 Add merchantUuid for verify and initialize method. Optional fields to get merchant configuration. |
5.2 |
2021-01-01 |
New status E8004 for Clearing and Reversal method. Locks the method call until the ongoing task for a given Request Uuid is completed. |
5.1 |
2020-12-30 |
Update for 3DS 2.X |
5.0 |
2020-12-06 |
DataCenter card transaction functionality release for Payment API methods + 6.4. Payment + 6.5. MO/TO payment + 6.6. Token payment + 6.7. CoF payment + 6.8. Recurring payment + 6.9. Installment Payment |
4.12 |
2020-11-20 |
Cards management methods added 5. Cards |
4.11 |
2020-11-17 |
3DS version enforcement configuration |
4.10 |
2020-11-06 |
Change in outside 3DS, authentication status required Y or A value |
4.9 |
2020-11-06 |
Add Installment Payment API methods 5.10. Installment Payment |
4.8 |
2020-10-26 |
New transaction status added (E01596) for transactions performed using terminal restricted card country + 5.5. Payment + 5.6. MO/TO payment + 5.7. Token payment + 5.7. CoF payment + 5.7. Recurring payment |
4.7 |
2020-09-23 |
Add new VISA response code value 80 |
4.6 |
2020-09-16 |
Add new fields in details: authorizeRRN, authorizeStan, reversalRRN, reversalStan, arn |
4.5 |
2020-09-1 |
Add new method Currency for card 5.3. Currency for card |
4.4 |
2020-09-1 |
Add new method MO/TO payment 5.6. MO/TO Payment |
4.3 |
2020-08-28 |
Add new response status E01595 - Returned when terminal MCC configuration is QUASI-CASH. |
4.2 |
2020-07-23 |
Add new response status E0187 during refund processing to notify that chargeback was reported for transaction |
4.1 |
2020-07-09 |
|
4.0 |
2020-07-01 |
New method "Card Provider" added |
3.9 |
2020-06-30 |
Update Mastercard statuses table |
3.8 |
2020-06-18 |
Response status E0141 replaced with E0190 when currency rate cannot be found |
3.7 |
2020-06-10 |
Documentation updated. Currency Rate method will be deprecated on 30.09.2020 and will be replaced by a new version of the Currency Rate method. 5.2. Currency Rate |
3.6 |
2020-06-08 |
New status E0163 added + 2.6.6. Reversal |
3.5 |
2020-06-05 |
Documentation updated. Change value and description about field "md" in Initialize and Finalize methods: + 6.2. Initialize + 6.3. Finalize |
3.4 |
2020-05-13 |
New reversal status (S0005, S0006) and changed response + 5.11.2 Reversal - response |
3.3 |
2020-04-27 |
Release API with Recurring Payments functionality + 5.9.1 Recurring Payment - initial transaction + 5.9.4 Recurring Payment - subsequent transaction |
3.2 |
2020-03-26 |
Release API with Credential on File (CoF) functionality + 5.8.1 Cof payment - initial transaction + 5.8.4 Cof payment - subsequent transaction |
3.1 |
2020-03-05 |
Monitoring status added (E0205) + 2.6.8. Monitoring + 5.5. Payment + 5.7. Token payment |
3.0 |
2020-03-04 |
Removed commission and merchantCommission from transaction details response body. |
2.9 |
2020-03-02 |
ERROR_MPI_CONNECTION status is replaced by the following statuses: Error mpi - 3ds initialize failed Error mpi connection - the change will be available on production from 12.03.2020. |
2.8 |
2020-02-28 |
3DS Verification method + 6. 3DS 1.0 verification methods - the change will be available on production from 12.03.2020. |
2.7 |
2020-02-24 |
Outside 3DS transactions documentation added + 5.2. Payment - request |
2.6 |
2020-02-18 |
Deleted refund status (S0012, S0013), changed refund status (E0184) and added new status (E0186) to refund. Changed response status for refund (2.6.7) + 2.6.7. Refund |
2.5 |
2020-01-31 |
Information about certification process added |
2.4 |
2020-01-30 |
New transaction status, amount limit per terminal (E0158) + 2.6.4. Payment |
2.3 |
2019-11-26 |
Monitoring status added (E0204) + 2.6.8. Monitoring |
2.2 |
2019-11-15 |
Monitoring status added (E0203) + 2.6.8. Monitoring |
2.1 |
2019-09-26 |
Monitoring statuses added + 2.6.8. Monitoring |
2.0 |
2019-09-23 |
New payment method with token description added |
1.9 |
2019-09-10 |
A flow diagrams updated |
1.8 |
2019-07-18 |
Clearing amount field has been added to the details method |
1.7 |
2019-05-10 |
Methods descriptions modified and statuses description improved |
1.6 |
2019-04-25 |
Endpoint (base url) changed to https://ecom-staging.fenige.pl |
1.5 |
2019-03-20 |
Fields validation changes |
1.4 |
2019-02-04 |
Optional IP address field added in transaction request body |
1.3 |
2019-01-16 |
Fields validation changes |
1.2 |
2018-12-18 |
Documentation update |
1.1 |
2018-11-13 |
Partial clearing method describe added |
1.0 |
2018-10-01 |
First release of documentation |
2. Introduction
Fenige e-commerce API service allows to easily and safely perform operations realated to e-commerce. You can authorize payments and show details about completed transactions. Also you can make reversals, clearings and refunds. |
Transaction process: |
---|
1. Fenige registers the PSP, Merchants and Terminals in his system. |
2. The Partner can use all available methods in the API. |
2.1. Certification
In order to access the Moneysend API, you must successfully pass the certification process in our dedicated application.
The application is available at https://certification.fenige.pl/
The new partner will receive login data from the Fenige employee, who is responsible for introducing new customers.
After a positive result, the user receives access to the production environment. Be adviced that the entire process takes place in a staging environment.
2.2. Transaction types
In Ecommerce Service we have two various transaction types
Transaction type | Description |
---|---|
Domestic |
This transaction type can be execute only if card’s country of sender, receiver and merchant are all the same. |
Crossborder |
This transaction type is executed if one or more conditions of Domestic Transaction type is not fulfill. |

2.3. Endpoints
Environment | Endpoint (base url) |
---|---|
Staging |
2.4. HTTP verbs
RESTful notes tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP verbs.
Verb | Usage |
---|---|
|
Used to retrieve a resource |
|
Used to create a new resource |
|
Used to update specific resource |
|
Used to delete a resource |
2.5. Language
If you want to select your language, add Accept-Language header to request JSON and set its value to, for example, pl, en, cs or sk. In case of a successful transaction for the send money method you will receive a email confirmation in the language which you set.
Accept-Language |
en |
2.6. General methods
All api methods require the delivery of appropriate headers.
List of methods headers used in Fenige REST API:
Key | Value | Validation | Description |
---|---|---|---|
|
application/json |
Required |
Used to indicate the media type of the resource |
|
Basic cHNwbmFtZTpwYXNzd29yZA== |
Required |
Used to resolve PSP context of user. Basic Auth from PSP data (PSP name and password). Consist of keyword Basic and string obtained from Base64 coding method for PSP name and password parameter |
2.7. HTTP status codes
RESTful notes tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP status codes.
Status code | Usage |
---|---|
|
The request completed successfully |
|
The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place. |
|
The request with 3ds has been registered for processing. Check status in a while. |
|
The request was malformed. The response body will include an error providing further information |
|
The requested resource did not exist |
|
Message occur when an unexpected condition was encountered |
2.7.1. Currency rate
Code | Messages | HTTP Code | HTTP STATUS |
---|---|---|---|
E0190 |
Failed to get currency rates |
500 |
INTERNAL_SERVER_ERROR |
2.7.2. Currency for card
Code | Messages | HTTP Code | HTTP STATUS |
---|---|---|---|
E0400 |
Failed to get currency for card |
500 |
INTERNAL_SERVER_ERROR |
E0401 |
Issuer card is not supported |
422 |
UNPROCESSABLE_ENTITY |
2.7.3. Payment
Code | Messages | HTTP Code | HTTP STATUS |
---|---|---|---|
S0000 |
SUCCESS |
200 |
OK |
S0001 |
SUCCESS |
204 |
NO CONTENT |
S0002 |
Success transaction |
200 |
OK |
S0003 |
Transaction declined, check response code for reason |
200 |
OK |
S0004 |
PENDING |
202 |
ACCEPTED |
E0150 |
Transaction rejected |
422 |
UNPROCESSABLE ENTITY |
E0151 |
Transaction rejected, currency not supported |
422 |
UNPROCESSABLE ENTITY |
E0152 |
Transaction rejected, issuer not supported |
422 |
UNPROCESSABLE ENTITY |
E0153 |
Transaction declined, problem with MIP connection |
500 |
INTERNAL SERVER ERROR |
E0154 |
Failed to fetch transaction details |
500 |
INTERNAL SERVER ERROR |
E0155 |
Transaction not exist |
404 |
NOT FOUND |
E0156 |
Transaction rejected, terminal not supported 3ds |
422 |
UNPROCESSABLE ENTITY |
E0157 |
Transaction rejected, card not supported 3ds |
422 |
UNPROCESSABLE ENTITY |
E0158 |
Transaction rejected, maximum transaction amount limit exceeded |
422 |
UNPROCESSABLE ENTITY |
E01605 |
Transaction rejected, minimum transaction amount limit exceeded |
422 |
UNPROCESSABLE ENTITY |
E01607 |
Transaction rejected, internal server error during authorization |
422 |
UNPROCESSABLE ENTITY |
E0159 |
Transaction rejected, restricted transaction amount has occurred |
422 |
UNPROCESSABLE ENTITY |
E8009 |
Merchant RSA keys not found |
404 |
NOT FOUND |
E8010 |
Merchant RSA key expired |
422 |
UNPROCESSABLE ENTITY |
E8011 |
Internal error during card decrypting |
500 |
INTERNAL SERVER ERROR |
E01580 |
Transaction rejected. Card is expired. |
422 |
UNPROCESSABLE ENTITY |
E01581 |
Transaction rejected. Not found Card Authentication (3DS 2.X) |
422 |
UNPROCESSABLE ENTITY |
E01582 |
Transaction rejected. Card Authentication not match to transaction type (3DS 2.X) |
422 |
UNPROCESSABLE ENTITY |
E01583 |
Transaction rejected. Outside 3ds is required for terminal |
422 |
UNPROCESSABLE ENTITY |
E01584 |
Transaction rejected, 3DS 2.X flow invoked for other card number than specified in the request |
422 |
UNPROCESSABLE ENTITY |
E01585 |
Transaction rejected, Outside 3ds values are not valid for Card Authentication. |
422 |
UNPROCESSABLE ENTITY |
E01590 |
Transaction rejected, cof card not found in db |
422 |
UNPROCESSABLE ENTITY |
E01591 |
Transaction rejected, initial cof transaction not approved |
422 |
UNPROCESSABLE ENTITY |
E01592 |
Transaction rejected, recurring card not found in db |
422 |
UNPROCESSABLE ENTITY |
E01593 |
Transaction rejected, initial recurring transaction not approved |
422 |
UNPROCESSABLE ENTITY |
E01594 |
Transaction rejected, transactionXId parameter had registered for another transaction |
422 |
UNPROCESSABLE ENTITY |
E01596 |
Transaction rejected, terminal blocks transactions with card issued in given card country |
422 |
UNPROCESSABLE ENTITY |
E01597 |
Transaction rejected, 3DS version of terminal are not compatible with 3DS version defined in request |
422 |
UNPROCESSABLE ENTITY |
E01598 |
Transaction rejected, ECI value is not available for card provider |
422 |
UNPROCESSABLE ENTITY |
E01599 |
Transaction declined, processing timeout |
500 |
INTERNAL_SERVER_ERROR |
E01600 |
Transaction rejected, 3DS 2.X flow invoked for other card number than specified in the request |
422 |
UNPROCESSABLE ENTITY |
E01601 |
Transaction rejected, terminal is blocked for provider |
422 |
UNPROCESSABLE ENTITY |
E01602 |
Transaction rejected, geographic scope is not permitted for this transaction |
422 |
UNPROCESSABLE ENTITY |
E01603 |
Transaction rejected, Transactions without 3ds above 30 EUR (the blockade applies only to EU countries) |
422 |
UNPROCESSABLE ENTITY |
E01604 |
Transaction rejected, transactions 3DS 1.X not supported for given country |
422 |
UNPROCESSABLE ENTITY |
E01606 |
Transaction rejected, country of residence is not permitted |
422 |
UNPROCESSABLE ENTITY |
E10000 |
Transaction rejected, terminal daily card transaction limit exceeded |
422 |
UNPROCESSABLE ENTITY |
E10001 |
Transaction rejected, terminal daily transaction limit exceeded |
422 |
UNPROCESSABLE ENTITY |
E10002 |
Transaction rejected, terminal monthly transaction limit exceeded |
422 |
UNPROCESSABLE ENTITY |
E11000 |
Transaction rejected, time for transaction processing exceeded |
422 |
UNPROCESSABLE ENTITY |
E05000 |
Installment Payment initial not found |
500 |
INTERNAL SERVER ERROR |
E05001 |
Installment Payment already confirmed |
500 |
INTERNAL SERVER ERROR |
E05002 |
Installment Payment already cancelleded |
500 |
INTERNAL SERVER ERROR |
E05003 |
Installment Payment already pay in full |
500 |
INTERNAL SERVER ERROR |
E05004 |
Installment Payment not confirmed in required time |
500 |
INTERNAL SERVER ERROR |
E05005 |
Installment Payment Initial was failed |
500 |
INTERNAL SERVER ERROR |
E05006 |
Installment Payment could not find valid installment plan for requested uuid |
500 |
INTERNAL SERVER ERROR |
E05007 |
Installment Payment Option not allowed for transaction |
500 |
INTERNAL SERVER ERROR |
E05008 |
Installment Payment missing plan uuid |
500 |
INTERNAL SERVER ERROR |
E05009 |
Installment Payment missing request number of installments |
500 |
INTERNAL SERVER ERROR |
E05010 |
Installment Payment requested number of installments is outside of allowed range |
500 |
INTERNAL SERVER ERROR |
E05011 |
Installment Payment operation not allowed, installment type allows ISSUER_FINANCED installments |
500 |
INTERNAL SERVER ERROR |
E05014 |
Installment Payment outside 3ds request is required for terminal |
500 |
INTERNAL SERVER ERROR |
E05015 |
Installment Payment unsupported card provider VISA |
500 |
INTERNAL SERVER ERROR |
2.7.4. Clearing
Code | Messages | HTTP Code | HTTP STATUS |
---|---|---|---|
E0170 |
Clearing of the payment is procesing |
422 |
UNPROCESSABLE ENTITY |
E0171 |
Can’t clear payment |
422 |
UNPROCESSABLE ENTITY |
E0172 |
Can’t clear payment, the time is over |
422 |
UNPROCESSABLE ENTITY |
E0173 |
Payment is automatically cleared |
422 |
UNPROCESSABLE ENTITY |
E0174 |
Payment is already cleared |
422 |
UNPROCESSABLE ENTITY |
E0175 |
Can’t clear payment, clearing amount is to low |
503 |
UNPROCESSABLE ENTITY |
E0176 |
Can’t clear payment, clearing amount is to high |
503 |
UNPROCESSABLE ENTITY |
2.7.5. Reversal
Code | Messages | HTTP Code | HTTP STATUS |
---|---|---|---|
S0005 |
Success reverse transaction |
200 |
OK |
S0006 |
Reverse transaction declined, check response code for reason |
200 |
OK |
E0160 |
Reversal of the payment is procesing |
422 |
UNPROCESSABLE ENTITY |
E0161 |
Can’t reversal payment |
422 |
UNPROCESSABLE ENTITY |
E0162 |
Payment is already reversed |
422 |
UNPROCESSABLE ENTITY |
E0163 |
Payment is already refunded |
422 |
UNPROCESSABLE ENTITY |
E05012 |
Installment Payment reverse not allowed |
500 |
INTERNAL SERVER ERROR |
2.7.6. Refund
Code | Messages | HTTP Code | HTTP STATUS |
---|---|---|---|
E0180 |
Refund rejected, no MC/VISA response |
500 |
INTERNAL SERVER ERROR |
E0181 |
Refund rejected by MC/VISA |
500 |
INTERNAL SERVER ERROR |
E0182 |
Refund transaction amount to low |
400 |
BAD REQUEST |
E0183 |
Refund transaction amount to high |
400 |
BAD REQUEST |
E0184 |
Transaction is refunded |
422 |
UNPROCESSABLE ENTITY |
E0185 |
Transaction not cleared, can’t refund |
422 |
UNPROCESSABLE ENTITY |
E0186 |
Refund is already processing |
422 |
UNPROCESSABLE ENTITY |
E0187 |
Transaction is chargeback reported |
422 |
UNPROCESSABLE ENTITY |
E05013 |
Installment Payment refund not allowed |
500 |
INTERNAL SERVER ERROR |
2.7.7. Monitoring
Code | Messages | HTTP Code | HTTP STATUS |
---|---|---|---|
E0200 |
Transaction rejected, card is blocked |
422 |
UNPROCESSABLE ENTITY |
E0201 |
Transaction rejected, bin is blocked |
422 |
UNPROCESSABLE ENTITY |
E0202 |
Transaction rejected, terminal is blocked |
422 |
UNPROCESSABLE ENTITY |
E0203 |
Transaction rejected, token is blocked |
422 |
UNPROCESSABLE ENTITY |
E0204 |
Transaction rejected, user is on aml list |
422 |
UNPROCESSABLE ENTITY |
E0205 |
Transaction rejected, bank is blocked |
422 |
UNPROCESSABLE ENTITY |
E0206 |
Transaction rejected, to many reject transactions and card is blocked |
422 |
UNPROCESSABLE ENTITY |
E0207 |
Transaction rejected, to many attempts declined and card is blocked |
422 |
UNPROCESSABLE ENTITY |
E0208 |
Transaction rejected, second transaction with merchant advice code 03 or 21 within 30 days |
422 |
UNPROCESSABLE ENTITY |
2.7.8. 3DS 2.X
Code | Messages | HTTP Code | HTTP STATUS |
---|---|---|---|
S0000 |
SUCCESS |
200 |
OK |
E0300 |
Error mpi V2 - failed internal |
500 |
INTERNAL_SERVER_ERROR |
E0301 |
Three DS Method Data mismatch |
422 |
UNPROCESSABLE_ENTITY |
E0302 |
Error on parsing Three DS Method Data |
422 |
UNPROCESSABLE_ENTITY |
E0303 |
Card number not Enrolled in 3DS v2 |
422 |
UNPROCESSABLE_ENTITY |
E0304 |
Invalid card authentication id |
422 |
UNPROCESSABLE_ENTITY |
E0305 |
Issuer card is not supported |
422 |
UNPROCESSABLE_ENTITY |
E0306 |
Invalid card number |
422 |
UNPROCESSABLE_ENTITY |
E0307 |
Card Authentication not found |
404 |
NOT_FOUND |
E0132 |
Terminal not exists |
404 |
NOT_FOUND |
E0309 |
Protocol version is not supported |
422 |
UNPROCESSABLE_ENTITY |
E0310 |
Invalid Three DS Method Data |
422 |
UNPROCESSABLE_ENTITY |
2.7.9. 3DS 2.X more details Error Code
Code | Description |
---|---|
E1001 |
Three DS Method Data mismatch |
E1002 |
Error on parsing Three DS Method Data |
E1003 |
Card number not Enrolled in 3DS v2 |
E1004 |
Read file exception |
E1005 |
Invalid card authentication id |
E1006 |
Issuer card is not supported |
E1007 |
Can not fetch provider configuration |
E1008 |
Invalid card number |
E1009 |
Card Authentication not found |
E1010 |
Protocol version is not supported |
E1011 |
Protocol version is not supported |
E601 |
Could not create ephemeral key. |
E602 |
Invalid certificate. |
E603 |
Invalid operation. |
E604 |
Invalid ClientAuth data. |
E605 |
The errorCode element in Error message is invalid. |
E606 |
Invalid index. |
E700 |
Unknown host exception. |
E1101 |
Protocol error. Received invalid message. |
E1102 |
Protocol error. Invalid message version. |
E1201 |
Protocol error. Missing data element. |
E1202 |
Protocol error. Unrecognized critical extension. |
E1203 |
Data element value is invalid. |
E1204 |
Duplicate Data Element. |
E1286 |
Error while sending to DS. |
E1301 |
Protocol error. Unrecognized transaction Id. |
E1302 |
Decryption failed. |
E1303 |
Access Denied, Invalid Endpoint |
E1304 |
ISO Code Invalid. |
E1305 |
Transaction Data Not Valid. |
E1306 |
MCC Not Valid for Payment System. |
E1307 |
Serial Number Not Valid. |
E1402 |
Transaction Timed Out. |
E1403 |
Transient System Failure. |
E1404 |
Permanent system failure. |
E1405 |
System Connection Failure. |
E118 |
Firewall Error. Error description contains detailed message. |
E143 |
Busy executing current method. |
E151 |
HTTP protocol error. The error message has the server response. |
E152 |
No server specified in URL |
E153 |
Specified URLScheme is invalid. |
E155 |
Range operation is not supported by server. |
E156 |
Invalid cookie index (out of range). |
E301 |
Interrupted. |
E302 |
Can’t open AttachedFile. |
E100 |
You cannot change the RemotePort at this time. A connection is in progress. |
E101 |
You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
E102 |
The RemoteHost address is invalid (X.X.X.X). |
E104 |
Already connected. If you want to reconnect, close the current connection first. |
E106 |
You cannot change the LocalPort at this time. A connection is in progress. |
E107 |
You cannot change the LocalHost at this time. A connection is in progress. |
E112 |
You cannot change MaxLineLength at this time. A connection is in progress. |
E116 |
RemotePort cannot be zero. Please specify a valid service port number. |
E117 |
Cannot change UseConnection option while the bean is Active. |
E135 |
Operation would block. |
E201 |
Timeout. |
E211 |
Action impossible in control’s present state. |
E212 |
Action impossible while not connected. |
E213 |
Action impossible while listening. |
E303 |
Could not open file. |
E434 |
Unable to convert string to selected CodePage |
E1105 |
Already connecting. If you want to reconnect, close the current connection first. |
E1117 |
You need to connect first. |
E1119 |
You cannot change the LocalHost at this time. A connection is in progress. |
E1120 |
Connection dropped by remote host. |
E270 |
Cannot load specified security library. |
E271 |
Cannot open certificate store. |
E272 |
Cannot find specified certificate. |
E273 |
Cannot acquire security credentials. |
E274 |
Cannot find certificate chain. |
E275 |
Cannot verify certificate chain. |
E276 |
Error during handshake. |
E280 |
Error verifying certificate. |
E281 |
Could not find client certificate. |
E282 |
Could not find server certificate. |
E283 |
Error encrypting data. |
E284 |
Error decrypting data. |
E10004 |
Interrupted system call. |
E10009 |
Bad file number. |
E10013 |
Access denied. |
E10014 |
Bad address. |
E10022 |
Invalid argument. |
E10024 |
Too many open files. |
E10035 |
Operation would block. |
E10036 |
Operation now in progress. |
E10037 |
Operation already in progress. |
E10038 |
Socket operation on non-socket. |
E10039 |
Destination address required. |
E10040 |
Message too long. |
E10041 |
Protocol wrong type for socket. |
E10042 |
Bad protocol option. |
E10043 |
Protocol not supported. |
E10044 |
Socket type not supported. |
E10045 |
Operation not supported on socket. |
E10046 |
Protocol family not supported. |
E10047 |
Address family not supported by protocol family. |
E10048 |
Address already in use. |
E10049 |
Can’t assign requested address. |
E10050 |
Network is down. |
E10051 |
Network is unreachable. |
E10052 |
Net dropped connection or reset. |
E10053 |
Software caused connection abort. |
E10054 |
Connection reset by peer. |
E10055 |
No buffer space available. |
E10056 |
Socket is already connected. |
E10057 |
Socket is not connected. |
E10058 |
Can’t send after socket shutdown. |
E10059 |
Too many references, can’t splice. |
E10060 |
Connection timed out. |
E10061 |
Connection refused. |
E10062 |
Too many levels of symbolic links. |
E10063 |
File name too long. |
E10064 |
Host is down. |
E10065 |
No route to host. |
E10066 |
Directory not empty |
E10067 |
Too many processes. |
E10068 |
Too many users. |
E10069 |
Disc Quota Exceeded. |
E10070 |
Stale NFS file handle. |
E10071 |
Too many levels of remote in path. |
E10091 |
Network subsystem is unavailable. |
E10092 |
WINSOCK DLL Version out of range. |
E10093 |
Winsock not loaded yet. |
E11001 |
Host not found. |
E11002 |
Non-authoritative 'Host not found' (try again or check DNS setup). |
E11003 |
Non-recoverable errors: FORMERR, REFUSED, NOTIMP. |
E11004 |
Valid name, no data record (check DNS setup). |
2.7.10. Global
Code | Messages | HTTP Code | HTTP STATUS |
---|---|---|---|
E8000 |
Bad Request |
400 |
BAD REQUEST |
E8001 |
Forbidden |
403 |
FORBIDDEN |
E8002 |
Unauthorized |
401 |
UNAUTHORIZED |
E8003 |
Scale of amount is different than the scale of currency |
422 |
UNPROCESSABLE ENTITY |
E8004 |
Some operation for this requestUuid is processing |
422 |
UNPROCESSABLE ENTITY |
2.7.11. Fatal Errors
Code | Messages | HTTP Code | HTTP STATUS |
---|---|---|---|
E9000 |
Domain error |
500 |
INTERNAL SERVER ERROR |
E9001 |
Error acquirer connection |
503 |
SERVICE UNAVAILABLE |
E9002 |
Error mpi connection |
503 |
SERVICE_UNAVAILABLE |
E9003 |
Error monitoring connection |
503 |
SERVICE_UNAVAILABLE |
E9007 |
Error mpi - 3ds verify failed |
500 |
INTERNAL_SERVER_ERROR |
E9008 |
Error mpi - 3ds initialize failed |
500 |
INTERNAL_SERVER_ERROR |
E9009 |
Error mpi - 3ds finalize failed |
500 |
INTERNAL_SERVER_ERROR |
E9010 |
Error data center connection |
503 |
SERVICE_UNAVAILABLE |
2.8. Mastercard/VISA statuses
Status code | Usage |
---|---|
|
Approved or completed successfully |
|
Refer to card issuer |
|
Refer to card issuer’s special conditions |
|
Invalid merchant |
|
Pick up card (no fraud) |
|
Do not honor |
|
General error |
|
Pick up card, special condition (fraud account) |
|
Honor with ID |
|
Request in progress |
|
Approved for partial amount |
|
Approved (V.I.P) |
|
Invalid transaction |
|
Invalid amount |
|
Invalid account number (no such number) |
|
No such issuer |
|
Approved, update track 3 |
|
Customer cancellation |
|
Customer dispute |
|
Re-enter transaction |
|
Invalid response |
|
No action taken |
|
Suspected malfunction |
|
Unacceptable transaction fee |
|
File update not supported by receiver |
|
Unable to locate record in file |
|
Duplicate file update record, old record replaced |
|
File update field edit error |
|
File update file locked out |
|
File update not successful, contact acquirer |
|
Format error |
|
Bank not supported by switch |
|
Completed partially |
|
Expired card |
|
Suspected fraud |
|
Card acceptor contact acquirer |
|
Restricted card |
|
Card acceptor call acquirer security |
|
Allowable PIN tries exceeded |
|
No credit account |
|
Requested function not supported |
|
Lost card, pick up (fraud account) |
|
No universal account |
|
Stolen card, pick up (fraud account) |
|
No investment account |
|
Not sufficient funds |
|
No checking account |
|
No savings account |
|
Expired card or expiration date is missing |
|
Incorrect PIN or PIN missing |
|
No card record |
|
Transaction not permitted to cardholder |
|
Transaction not permitted to acquirer/terminal |
|
Suspected fraud |
|
Card acceptor contact acquirer |
|
Exceeds withdrawal amount limit |
|
Restricted card (card invalid in this region or country) |
|
Security violation (source is not correct issuer) |
|
Original amount incorrect/Transaction does not fulfill AML requirement |
|
Exceeds withdrawal frequency limit |
|
Card acceptor call acquirer’s security department |
|
Hard capture (requires that card be picked up at ATM) |
|
Response received too late |
|
Contact Card Issuer/PIN data required |
|
PIN Not Changed |
|
Different value than that used for PIN encryption errors |
|
Allowable number of PIN tries exceeded |
|
Invalid/nonexistent “To Account” specified/Unsolicited reversal |
|
Invalid/nonexistent “From Account” specified |
|
Invalid/nonexistent account specified (general)/“Blocked, first used”—Transaction from new cardholder, and card not properly unblocked |
|
Life cycle/Already reversed (by Switch) |
|
System not available/No financial impact |
|
Domestic Debit Transaction Not Allowed (Regional use only)/Cryptographic error found in PIN |
|
Policy (Mastercard use only)/Negative CAM, dCVV, iCVV, or CVV results |
|
Fraud/Security (Mastercard use only) |
|
Invalid Authorization Life Cycle |
|
Not declined/No reason to decline a request for address verification, CVV2 verification, or a credit voucher or merchandise return |
|
PIN Validation not possible |
|
Purchase Amount Only, No Cash Back Allowed |
|
Cryptographic failure |
|
Unacceptable PIN—Transaction Declined—Retry/Ineligible to receive financial position information (GIV) |
|
Cutoff is in process (switch ending a day’s business and starting the next. Transaction can be sent again in a few minutes) |
|
Issuer or switch is inoperative/Issuer or switch inoperative and STIP not applicable or not available for this transaction; Time-out when no stand-in; POS Check Service: Destination unavailable; Credit Voucher and Merchandise Return Authorizations: V.I.P. sent the transaction to the issuer, but the issuer was unavailable. |
|
Financial institution or intermediate network facility cannot be found for routing |
|
Transaction cannot be completed. Violation of law |
|
Duplicate transmission |
|
Reconcile error |
|
System malfunction or certain field error conditions |
|
Additional customer authentication required |
|
Surcharge amount not permitted on Visa cards (U.S. acquirers only) |
|
Surcharge amount not supported by debit network issuer. |
|
Force STIP |
|
Cash service not available |
|
Cashback request exceeds issuer limit or appoved limit |
|
Ineligible for resubmission |
|
Decline for CVV2 failure |
|
Transaction amount exceeds preauthorized approval amount |
|
Invalid biller information |
|
Denied PIN unblock—PIN change or unblock request declined by issuer |
|
Denied PIN change—requested PIN unsafe |
|
Card Authentication failed |
|
Stop payment order |
|
Revocation of authorization order |
|
Transaction does not qualify for Visa PIN |
|
Revocation of all authorizations order |
|
Forward to issuer |
|
Forward to issuer |
|
Unable to go online |
|
Customer ID verification failed |
|
Additional customer authentication required (Europe Region only) |
|
Verification Failed (Cardholder Identification does not match issuer records) |
2.9. Response statuses
2.9.1. Transaction statuses
Status | Description |
---|---|
|
Transaction is processing |
|
Transaction complete successfully |
|
Transaction was declined by Mastercard, look at response code |
|
Transaction was reversed successfully - money will return to cardholder’s account |
|
Transaction is cleared correctly |
|
Transaction is waiting for login to bank by cardholder and confirm transaction |
|
Cardholder did not login to bank in 15 minutes since transaction initiated |
|
Something went wrong and some validation error occurred |
2.9.2. Reversal statuses
Status | Description |
---|---|
|
A reversal complete successfully |
|
A reversal was declined by Mastercard, look at response code |
|
Something went wrong and reversal cannot be processed |
|
Reversal could not be processed and it is not possible |
2.9.3. Clearing statuses
Status |
Description |
|
A clearing complete successfully |
|
A clearing is declined |
|
Something went wrong and clearing cannot be processed |
|
Transaction was registered correctly and will processing soon |
|
Clearing was processed with success and now it is waiting for send to Mastercard |
|
Clearing is not possible |
|
Clearing transaction is not found |
|
Time for clearing is over (7 days when manual clearing is enabled) |
|
Clearing is pending |
|
Clearing is processing |
2.9.4. Refund statuses
Status | Description |
---|---|
|
Refund complete successfully |
|
A refund is declined by MasterCard, look at response code |
|
An attempt to transaction refund was registered and refund is processing |
|
Transaction not found |
|
Transaction is just correctly refund when user make request again with same requestUuid |
|
Transaction in not cleared yet |
|
Transaction is chargeback reported |
3. Merchants
3.1. Get merchant for uuid
Using this method, we can get a merchant with a unique uuid. We send uuid in url as a param. In response, we receive detailed information about the merchant.
3.1.1. Request
GET /merchants/5533ecab-f1bb-4781-afd5-fa3e42be611f HTTP/1.1
accept-encoding: gzip
user-agent: ReactorNetty/1.0.32
Authorization: Basic dXNlcjpwYXNzd29yZA==
Accept: application/json
Host: ecom-staging.fenige.pl
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Parameter | Description |
---|---|
|
Merchant’s unique uuid in system |
3.1.2. Response
Response status
Status | Description |
---|---|
|
Returned when the merchant is already existing. In response are details about the merchant. |
|
STATUS: E8002 - Returned when you are the problem with authorized to your PSP. |
|
STATUS: E8001 - Returned when server understood the request but refuses to authorize it. |
|
STATUS: E0122 - Returned when merchant not exist. |
|
STATUS: E9000 - Returned when reason is unknown. |
HTTP/1.1 200 OK
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:09 GMT
Content-Length: 560
{
"uuid" : "5533ecab-f1bb-4781-afd5-fa3e42be611f",
"name" : "merchant_name",
"companyName" : "merchant_company_name",
"companyBusinessName" : "merchant_company_business_name",
"email" : "merchant_mail@example.com",
"merchantStatus" : "ACTIVE",
"address" : {
"city" : "Lublin",
"country" : "PL",
"homeNumber" : "10",
"street" : "Karola Olszewskiego",
"streetNumber" : "11",
"postalCode" : "24-110"
},
"accountNumber" : "11124000013372880300945921",
"status" : "S0000",
"message" : "SUCCESS",
"httpStatus" : "OK"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Merchant’s unique uuid in system |
|
|
The merchant’s name |
|
|
The merchant’s company name |
|
|
The merchant’s company business name |
|
|
The merchant’s email |
|
|
The merchant’s city |
|
|
The merchant’s country in accordance with ISO 3166-1 Alpha-2 |
|
|
The merchant’s home number |
|
|
The merchant’s street |
|
|
The merchant’s street number |
|
|
The merchant’s postal code |
|
|
Response http status |
|
|
The merchant’s status |
|
|
The merchant’s account number |
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic realm="Realm"
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 141
Date: Mon, 25 Sep 2023 11:12:10 GMT
{
"status" : "E8002",
"message" : "Unauthorized",
"httpStatus" : "UNAUTHORIZED",
"traceId" : "91370ae9-2527-491e-ab7a-513f6ee49d7f"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 403 Forbidden
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 135
Date: Mon, 25 Sep 2023 11:12:11 GMT
{
"status" : "E8001",
"message" : "Forbidden",
"httpStatus" : "FORBIDDEN",
"traceId" : "a823464b-5a7d-433c-8209-8536699b400d"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 404 Not Found
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:10 GMT
Content-Length: 146
{
"status" : "E0122",
"message" : "Merchant not exists.",
"httpStatus" : "NOT_FOUND",
"traceId" : "efdd8c35-c7fb-49f1-9d38-ee38085c3d7c"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 500 Internal Server Error
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:09 GMT
Connection: close
Content-Length: 150
{
"status" : "E9000",
"message" : "Domain error",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "56d55753-676f-474b-b74d-6063d627a8bc"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
3.2. Get merchant list
Using this method, we can get a list of merchants who are assigned to the authenticated PSP.
3.2.1. Request
GET /merchants HTTP/1.1
accept-encoding: gzip
user-agent: ReactorNetty/1.0.32
Authorization: Basic dXNlcjpwYXNzd29yZA==
Accept: application/json
Host: ecom-staging.fenige.pl
Name | Description |
---|---|
|
Basic auth credentials for PSP |
3.2.2. Response
Response status
Status | Description |
---|---|
|
Returned when the authorized PSP has at least one merchant. In response, he receives a list of merchants with details about each of them. |
|
STATUS: E0123 - Returned when merchant list is empty. |
|
STATUS: E8002 - Returned when you are the problem with authorized to your PSP. |
|
STATUS: E8001 - Returned when server understood the request but refuses to authorize it. |
|
STATUS: E9000 - Returned when reason is unknown. |
HTTP/1.1 200 OK
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:07 GMT
Content-Length: 1173
{
"merchants" : {
"content" : [ {
"uuid" : "364874ee-8f7a-45f4-a37d-cff557a02175",
"name" : "merchant_name",
"companyName" : "merchant_company_name",
"companyBusinessName" : "merchant_company_business_name",
"email" : "merchant_mail@example.com",
"merchantStatus" : "ACTIVE",
"address" : {
"city" : "Lublin",
"country" : "PL",
"homeNumber" : "10",
"street" : "Karola Olszewskiego",
"streetNumber" : "11",
"postalCode" : "24-110"
},
"accountNumber" : "11124000013372880300945921"
} ],
"pageable" : {
"sort" : {
"empty" : true,
"unsorted" : true,
"sorted" : false
},
"offset" : 0,
"pageNumber" : 0,
"pageSize" : 20,
"paged" : true,
"unpaged" : false
},
"totalPages" : 1,
"totalElements" : 1,
"last" : true,
"size" : 20,
"number" : 0,
"sort" : {
"empty" : true,
"unsorted" : true,
"sorted" : false
},
"numberOfElements" : 1,
"first" : true,
"empty" : false
},
"status" : "S0000",
"message" : "SUCCESS",
"httpStatus" : "OK"
}
Path | Type | Description |
---|---|---|
|
|
The merchant’s name |
|
|
The merchant’s company name |
|
|
The merchant’s company business name |
|
|
The merchant’s email |
|
|
The merchant’s status |
|
|
Merchant’s unique uuid in system |
|
|
The merchant’s city |
|
|
The merchant’s country in accordance with ISO 3166-1 Alpha-2 |
|
|
The merchant’s home number |
|
|
The merchant’s street |
|
|
The merchant’s street number |
|
|
The merchant’s postal code |
|
|
The merchant’s account number |
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
HTTP/1.1 200 OK
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:07 GMT
Content-Length: 91
{
"status" : "E0123",
"message" : "List of Merchant is empty.",
"httpStatus" : "OK"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic realm="Realm"
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 141
Date: Mon, 25 Sep 2023 11:12:07 GMT
{
"status" : "E8002",
"message" : "Unauthorized",
"httpStatus" : "UNAUTHORIZED",
"traceId" : "e64d240c-6d9a-4734-b053-6862821c4a06"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 403 Forbidden
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 135
Date: Mon, 25 Sep 2023 11:12:09 GMT
{
"status" : "E8001",
"message" : "Forbidden",
"httpStatus" : "FORBIDDEN",
"traceId" : "1b91b944-7fdc-4370-a342-88c39b105cea"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 500 Internal Server Error
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:06 GMT
Connection: close
Content-Length: 150
{
"status" : "E9000",
"message" : "Domain error",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "30f061a9-bbc5-4d4d-bca6-b0a0c5b314a9"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
4. Terminals
4.1. Get terminal for uuid
Using this method, we can get a terminal with a unique uuid. We send merchant uuid and terminal uuid in url as a params. In response, we receive detailed information about the terminal.
4.1.1. Request
GET /merchants/ef154571-b72f-4afa-b618-ce456726cd0e/terminals/e77594d7-06e0-42f2-9d6c-d1b3061ca938 HTTP/1.1
accept-encoding: gzip
user-agent: ReactorNetty/1.0.32
Authorization: Basic dXNlcjpwYXNzd29yZA==
Accept: application/json
Host: ecom-staging.fenige.pl
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Parameter | Description |
---|---|
|
Merchant’s unique uuid in system |
|
Terminal’s unique uuid in system |
4.1.2. Response
Response status
Status | Description |
---|---|
|
Returned when the terminal is already existing. In response are details about the terminal. |
|
STATUS: E8002 - Returned when you are the problem with authorized to your PSP. |
|
STATUS: E8001 - Returned when server understood the request but refuses to authorize it. |
|
STATUS: E0122 - Returned when merchant not exist. STATUS: E0132 - Returned when terminal not exist. |
|
STATUS: E9000 - Returned when reason is unknown. |
HTTP/1.1 200 OK
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:11:39 GMT
Content-Length: 357
{
"uuid" : "e77594d7-06e0-42f2-9d6c-d1b3061ca938",
"name" : "terminal_name",
"merchantUUID" : "ef154571-b72f-4afa-b618-ce456726cd0e",
"terminalStatus" : "ACTIVE",
"settlementCurrency" : "PLN",
"calculateCommissionType" : "STANDARD",
"status" : "S0000",
"message" : "SUCCESS",
"httpStatus" : "OK",
"default" : true,
"3dsEnable" : true
}
Path | Type | Description |
---|---|---|
|
|
The merchant’s identifier in the database |
|
|
The terminal’s name |
|
|
The terminal’s identifier in the database |
|
|
Is 3DS enabled for transaction. Enabled if true, is not enabled if false |
|
|
The terminals’s status (NEW - terminal is waiting for activation in Fenige system, ACTIVE - terminal is active, INACTIVE - terminal is not active) |
|
|
Is default terminal. Default if true, is not default if false |
|
|
Commission type for terminal (STANDARD - percentage commission, SUMMARIZE - percentage commission and fixed amount) |
|
|
Settlement currency for terminal (in accordance with ISO-4217) |
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic realm="Realm"
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 141
Date: Mon, 25 Sep 2023 11:11:39 GMT
{
"status" : "E8002",
"message" : "Unauthorized",
"httpStatus" : "UNAUTHORIZED",
"traceId" : "c83acb78-c702-49a7-91ce-472aefce3730"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 403 Forbidden
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 135
Date: Mon, 25 Sep 2023 11:11:41 GMT
{
"status" : "E8001",
"message" : "Forbidden",
"httpStatus" : "FORBIDDEN",
"traceId" : "56c756d1-b6ee-4f05-bc2c-92b9013ce14d"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 404 Not Found
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:11:39 GMT
Content-Length: 146
{
"status" : "E0132",
"message" : "Terminal not exists.",
"httpStatus" : "NOT_FOUND",
"traceId" : "5acb2367-0a3a-48c8-8c78-52e5d2bf14c3"
}
HTTP/1.1 404 Not Found
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:11:38 GMT
Content-Length: 146
{
"status" : "E0136",
"message" : "Merchant not exists.",
"httpStatus" : "NOT_FOUND",
"traceId" : "b58adfb5-bde9-4c35-afe2-cc25eee860cc"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 500 Internal Server Error
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:11:38 GMT
Connection: close
Content-Length: 150
{
"status" : "E9000",
"message" : "Domain error",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "6cba3d03-9e2b-4da2-a238-514437b97f9e"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
4.2. Get terminals list
Using this method, we can get a list of terminals who are assigned to the merchant.
4.2.1. Request
GET /merchants/9bc09d79-8c29-4803-9a61-882643fa17ee/terminals HTTP/1.1
accept-encoding: gzip
user-agent: ReactorNetty/1.0.32
Authorization: Basic dXNlcjpwYXNzd29yZA==
Accept: application/json
Host: ecom-staging.fenige.pl
Name | Description |
---|---|
|
Basic auth credentials for PSP |
4.2.2. Response
Response status
Status | Description |
---|---|
|
Returned when the merchant has at least one terminal. In response, he receives a list of terminals with details about each of them. |
|
STATUS: E0133 - Returned when terminal list is empty. |
|
STATUS: E8002 - Returned when you are the problem with authorized to your PSP. |
|
STATUS: E8001 - Returned when server understood the request but refuses to authorize it. |
|
STATUS: E0122 - Returned when merchant not exist. |
|
STATUS: E9000 - Returned when reason is unknown. |
HTTP/1.1 200 OK
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:11:44 GMT
Content-Length: 896
{
"terminals" : {
"content" : [ {
"uuid" : "5e0b5362-f034-4897-9a40-6d9c696801d6",
"name" : "terminal_name",
"merchantUUID" : "9bc09d79-8c29-4803-9a61-882643fa17ee",
"terminalStatus" : "ACTIVE",
"settlementCurrency" : "PLN",
"default" : true,
"3dsEnable" : true
} ],
"pageable" : {
"sort" : {
"empty" : true,
"unsorted" : true,
"sorted" : false
},
"offset" : 0,
"pageNumber" : 0,
"pageSize" : 20,
"paged" : true,
"unpaged" : false
},
"totalPages" : 1,
"totalElements" : 1,
"last" : true,
"size" : 20,
"number" : 0,
"sort" : {
"empty" : true,
"unsorted" : true,
"sorted" : false
},
"numberOfElements" : 1,
"first" : true,
"empty" : false
},
"status" : "S0000",
"message" : "SUCCESS",
"httpStatus" : "OK"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
The terminal’s identifier in the database |
|
|
The terminal’s name |
|
|
Merchant’s unique uuid in system |
|
|
Is 3DS enabled for transaction. Enabled if true, is not enabled if false |
|
|
The terminals’s status (NEW - terminal is waiting for activation in Fenige system, ACTIVE - terminal is active, INACTIVE - terminal is not active) |
|
|
Is default terminal. Default if true, is not default if false |
|
|
Settlement currency for terminal (in accordance with ISO-4217) |
HTTP/1.1 200 OK
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:11:44 GMT
Content-Length: 150
{
"merchantUuid" : "7e3076d2-c70e-4e36-bf4d-8f4a172e8621",
"status" : "E0133",
"message" : "List of Terminal is empty.",
"httpStatus" : "OK"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
The merchant’s identifier in the database |
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic realm="Realm"
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 141
Date: Mon, 25 Sep 2023 11:11:42 GMT
{
"status" : "E8002",
"message" : "Unauthorized",
"httpStatus" : "UNAUTHORIZED",
"traceId" : "cb0e0b93-e6fc-4484-bdeb-239082829ec3"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 403 Forbidden
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 135
Date: Mon, 25 Sep 2023 11:11:45 GMT
{
"status" : "E8001",
"message" : "Forbidden",
"httpStatus" : "FORBIDDEN",
"traceId" : "09c81b97-9eae-4350-b28a-f0a198769941"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 404 Not Found
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:11:42 GMT
Content-Length: 146
{
"status" : "E0136",
"message" : "Merchant not exists.",
"httpStatus" : "NOT_FOUND",
"traceId" : "78b81b0b-a8e9-401c-b1e5-358da4633c5b"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 500 Internal Server Error
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:11:41 GMT
Connection: close
Content-Length: 150
{
"status" : "E9000",
"message" : "Domain error",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "c08fe56f-36ad-4122-99d4-96365e7b5ae1"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
5. Cards
5.1. Add card
Using this method, we can create a new Card in Fenige Datacenter. Cards in the Ecommerce system are stored securely and are assigned to the PSP object. Each PSP (object you authenticate in API with) has access to store cards in separated secure database.
5.1.1. Request
POST /client/card HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 149
Host: ecom-staging.fenige.pl
{
"cardNumber" : "5453131785534417",
"expirationDate" : "10/24",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@fenige.pl"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
cardNumber |
String |
@Card number length must be between 12 and 19, @Must not be blank, @Must not be null |
Full cardholder’s card number must be between 12-digits and 19-digits |
expirationDate |
String |
@Must match the regular expression |
Expiration date of card mm/yy |
firstName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null, @Must not be empty |
First name of cardholder |
lastName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null, @Must not be empty |
Last name of cardholder |
String |
@Length must be between 1 and 128 inclusive, @Must be a well-formed email address, @Must not be blank, @Must not be null, @Must not be empty |
Cardholder’s email |
5.1.2. Response
Response status
Status | Description |
---|---|
|
Returned when terminal was successfully create. |
|
STATUS: E8000 - Returned when request is incorrect, required fields are missing or the values are not valid. |
|
STATUS: E8002 - Returned when you are the problem with authorized to your PSP. |
|
STATUS: E8001 - Returned when server understood the request but refuses to authorize it. |
|
STATUS: E06007 - Returned when there was issue with internal Datacenter flow. |
|
STATUS: E9000 - Returned when reason is unknown. + STATUS: E06000 - Critical error occurred while connecting to Datacenter. |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 88
{
"cardId" : 1,
"status" : "S0000",
"message" : "SUCCESS",
"httpStatus" : "OK"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Id numeric value of added card |
HTTP/1.1 400 Bad Request
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:20 GMT
Connection: close
Content-Length: 490
{
"errors" : {
"firstName" : [ "length must be between 2 and 35" ],
"lastName" : [ "length must be between 2 and 35" ],
"cardNumber" : [ "invalid card number", "card number length must be between 12 and 19", "card number must be numeric" ],
"email" : [ "must be a well-formed email address" ],
"expirationDate" : [ "invalid card format expiration date" ]
},
"status" : "E8000",
"httpStatus" : "BAD_REQUEST",
"traceId" : "f0f577a3-77bf-4013-b97b-b60aa692c8c0"
}
Path | Type | Description |
---|---|---|
|
|
First name validation error |
|
|
Last name validation error |
|
|
Email validation error |
|
|
Card number validation error |
|
|
Expiration date validation error |
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
UUID that helps to identify request in system |
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic realm="Realm"
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 141
Date: Mon, 25 Sep 2023 11:12:19 GMT
{
"status" : "E8002",
"message" : "Unauthorized",
"httpStatus" : "UNAUTHORIZED",
"traceId" : "c79bfb6f-b21a-4481-93ca-a9033a527563"
}
Path | Type | Description |
---|---|---|
|
|
Message for response code from Fenige system |
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
UUID that helps to identify request in system |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 191
{
"status" : "E06007",
"message" : "Exception occurred while trying to add ecommerce card",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "126dde90-d696-4f7e-b445-ced19af38503"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
UUID that helps to identify request in system |
HTTP/1.1 500 Internal Server Error
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:19 GMT
Connection: close
Content-Length: 150
{
"status" : "E9000",
"message" : "Domain error",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "3c268696-8733-4d27-a65d-64f672197318"
}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 197
{
"status" : "E06000",
"message" : "Unrecognized error occurred while connection to Datacenter",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "afbf8757-7a72-4151-9c3d-7dc0550cd658"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
UUID that helps to identify request in system |
5.2. Get card
This method can be use for fetch Card object by 'cardId' parameter.
5.2.1. Request
GET /client/card/1 HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Host: ecom-staging.fenige.pl
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Parameter | Description |
---|---|
|
Id numeric value of card existing in database |
5.2.2. Response
Response status
Status | Description |
---|---|
|
Returned when card was successfully fetched. |
|
STATUS: E8002 - Returned when you are the problem with authorized to your PSP. |
|
STATUS: E8001 - Returned when server understood the request but refuses to authorize it. |
|
STATUS: E9000 - Returned when reason is unknown. |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 308
{
"cardId" : 1,
"hiddenCardNumber" : "545313******4417",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@fenige.pl",
"createdDate" : "2023-09-25T13:12:18.254Z",
"lastModifiedDate" : "2023-09-25T13:12:18.254Z",
"status" : "S0000",
"message" : "SUCCESS",
"httpStatus" : "OK"
}
Path | Type | Description |
---|---|---|
|
|
Full cardholder’s masked card number must be between 12-digits and 19-digits |
|
|
First name of cardholder |
|
|
Last name of cardholder |
|
|
Cardholder’s email |
|
|
Card creation date |
|
|
Last card edit date |
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Id numeric value of added card |
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic realm="Realm"
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 141
Date: Mon, 25 Sep 2023 11:12:19 GMT
{
"status" : "E8002",
"message" : "Unauthorized",
"httpStatus" : "UNAUTHORIZED",
"traceId" : "c79bfb6f-b21a-4481-93ca-a9033a527563"
}
Path | Type | Description |
---|---|---|
|
|
Message for response code from Fenige system |
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
UUID that helps to identify request in system |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 152
{
"status" : "E06003",
"message" : "Datacenter card not found",
"httpStatus" : "NOT_FOUND",
"traceId" : "cdf79946-a0bd-4e59-88a4-62f257fe26b5"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
UUID that helps to identify request in system |
HTTP/1.1 500 Internal Server Error
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:19 GMT
Connection: close
Content-Length: 150
{
"status" : "E9000",
"message" : "Domain error",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "3c268696-8733-4d27-a65d-64f672197318"
}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 197
{
"status" : "E06000",
"message" : "Unrecognized error occurred while connection to Datacenter",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "afbf8757-7a72-4151-9c3d-7dc0550cd658"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
UUID that helps to identify request in system |
5.3. Update card
This method allows you to edit the details of a Card that has been added previously. The request body requires a 'cardId' and any data set. All data is optional.
5.3.1. Request
PUT /client/card HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 165
Host: ecom-staging.fenige.pl
{
"cardId" : 1,
"cardNumber" : "5453131785534417",
"expirationDate" : "10/24",
"firstName" : "John",
"lastName" : "Doe",
"email" : "john.doe@fenige.pl"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
cardId |
Number |
@Must not be null, @Numeric value |
Id numeric value of card existing in database |
cardNumber |
String |
@Card number length must be between 12 and 19, @Must not be blank, @Must not be null |
Full cardholder’s card number must be between 12-digits and 19-digits |
expirationDate |
String |
@Must match the regular expression |
Expiration date of card mm/yy |
firstName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null, @Must not be empty |
First name of cardholder |
lastName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null, @Must not be empty |
Last name of cardholder |
String |
@Length must be between 1 and 128 inclusive, @Must be a well-formed email address, @Must not be blank, @Must not be null, @Must not be empty |
Cardholder’s email |
5.3.2. Response
Response status
Status | Description |
---|---|
|
Returned when card was successfully updated. |
|
STATUS: E8000 - Returned when request is incorrect, required fields are missing or the values are not valid. |
|
STATUS: E8002 - Returned when you are the problem with authorized to your PSP. |
|
STATUS: E8001 - Returned when server understood the request but refuses to authorize it. |
|
STATUS: E9000 - Returned when reason is unknown. |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 88
{
"cardId" : 1,
"status" : "S0000",
"message" : "SUCCESS",
"httpStatus" : "OK"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Id numeric value of added card |
HTTP/1.1 400 Bad Request
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:19 GMT
Connection: close
Content-Length: 690
{
"errors" : {
"firstName" : [ "must be null", "length must be between 2 and 35", "must not be blank", "must match \"^[^0-9\\n]+$\"" ],
"lastName" : [ "must match \"^[^0-9\\n]+$\"", "length must be between 2 and 35", "must be null", "must not be blank" ],
"cardId" : [ "must not be null" ],
"cardNumber" : [ "card number length must be between 12 and 19", "invalid card number", "must be null", "card number must be numeric" ],
"email" : [ "must be null", "must be a well-formed email address" ],
"expirationDate" : [ "invalid card expiration date" ]
},
"status" : "E8000",
"httpStatus" : "BAD_REQUEST",
"traceId" : "78517f33-33c5-4ba5-8668-430244ffdbd5"
}
Path | Type | Description |
---|---|---|
|
|
cardId validation error |
|
|
First name validation error |
|
|
Last name validation error |
|
|
Email validation error |
|
|
Card number validation error |
|
|
Expiration date validation error |
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
UUID that helps to identify request in system |
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic realm="Realm"
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 141
Date: Mon, 25 Sep 2023 11:12:19 GMT
{
"status" : "E8002",
"message" : "Unauthorized",
"httpStatus" : "UNAUTHORIZED",
"traceId" : "c79bfb6f-b21a-4481-93ca-a9033a527563"
}
Path | Type | Description |
---|---|---|
|
|
Message for response code from Fenige system |
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
UUID that helps to identify request in system |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 185
{
"status" : "E06005",
"message" : "Update of ecommerce card failed, card not found",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "b4f5c998-260b-4c27-b082-181bde4340c7"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
UUID that helps to identify request in system |
HTTP/1.1 500 Internal Server Error
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:19 GMT
Connection: close
Content-Length: 150
{
"status" : "E9000",
"message" : "Domain error",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "3c268696-8733-4d27-a65d-64f672197318"
}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 197
{
"status" : "E06000",
"message" : "Unrecognized error occurred while connection to Datacenter",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "afbf8757-7a72-4151-9c3d-7dc0550cd658"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
UUID that helps to identify request in system |
5.4. Delete card
This method is used to remove a card from the Datacenter database that is assigned to the PSP with which you have logged in.
5.4.1. Request
DELETE /client/card/1 HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Host: ecom-staging.fenige.pl
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Parameter | Description |
---|---|
|
Id numeric value of card existing in database |
5.4.2. Response
Response status
Status | Description |
---|---|
|
Returned when card was successfully removed. |
|
STATUS: E8002 - Returned when you are the problem with authorized to your PSP. |
|
STATUS: E8001 - Returned when server understood the request but refuses to authorize it. |
|
STATUS: E9000 - Returned when reason is unknown. |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 96
{
"cardRemoved" : true,
"status" : "S0000",
"message" : "SUCCESS",
"httpStatus" : "OK"
}
Path | Type | Description |
---|---|---|
|
|
Indicates is card was removed or not |
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic realm="Realm"
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 141
Date: Mon, 25 Sep 2023 11:12:19 GMT
{
"status" : "E8002",
"message" : "Unauthorized",
"httpStatus" : "UNAUTHORIZED",
"traceId" : "c79bfb6f-b21a-4481-93ca-a9033a527563"
}
Path | Type | Description |
---|---|---|
|
|
Message for response code from Fenige system |
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
UUID that helps to identify request in system |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 185
{
"status" : "E06004",
"message" : "Delete of ecommerce card failed, card not found",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "cfd8eb7a-4b48-4113-b756-0854def2e9eb"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
UUID that helps to identify request in system |
HTTP/1.1 500 Internal Server Error
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:19 GMT
Connection: close
Content-Length: 150
{
"status" : "E9000",
"message" : "Domain error",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "3c268696-8733-4d27-a65d-64f672197318"
}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 197
{
"status" : "E06000",
"message" : "Unrecognized error occurred while connection to Datacenter",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "afbf8757-7a72-4151-9c3d-7dc0550cd658"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
UUID that helps to identify request in system |
6. Payment API
6.1. Currency rate
This method can be used for calculate Mastercard/Visa currency rates between two values depends on terminal and provider. Notice that `higherRate` is used to transaction processing.
6.1.1. Request
POST /client/payments/currency-rate HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 124
Host: ecom-staging.fenige.pl
{
"terminalUuid" : "f052f303-3704-48b3-8b27-879f67ece319",
"provider" : "MASTERCARD",
"from" : "USD",
"to" : "PLN"
}
Path | Type | Constraints | Description |
---|---|---|---|
terminalUuid |
String |
@Must not be null |
Terminal’s unique uuid in system |
provider |
String |
@Must not be null |
VISA or MASTERCARD or MAESTRO |
from |
String |
@Must not be null |
Currency code for conversion |
to |
String |
@Must not be null |
Target currency of conversion |
POST /client/payments/currency-rate HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 118
Host: ecom-staging.fenige.pl
{
"terminalUuid" : "f052f303-3704-48b3-8b27-879f67ece319",
"provider" : "VISA",
"from" : "USD",
"to" : "PLN"
}
Path | Type | Constraints | Description |
---|---|---|---|
terminalUuid |
String |
@Must not be null |
Terminal’s unique uuid in system |
provider |
String |
@Must not be null |
VISA or MASTERCARD or MAESTRO |
from |
String |
@Must not be null |
Currency code for conversion |
to |
String |
@Must not be null |
Target currency of conversion |
6.1.2. Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 129
{
"lowerRate" : 0.88000011,
"higherRate" : 0.89801726,
"status" : "S0000",
"message" : "SUCCESS",
"httpStatus" : "OK"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Lower currency rate |
|
|
Higher currency rate used for process transaction |
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 141
{
"status" : "E8002",
"message" : "Unauthorized",
"httpStatus" : "UNAUTHORIZED",
"traceId" : "d87d65ee-2820-4e7d-9978-afba3ad3d2ef"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Id of trace |
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 166
{
"status" : "E0190",
"message" : "Failed to get currency rates",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "190ecb86-f1e8-49e6-9fd3-3b06a9479450"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Id of trace |
6.2. Currency for card
Method is used to determine currencies applied for given card. If merchant has stored card in DataCenter can you use this method by cardId rather than cardNumber.
6.2.1. Request
Path | Type | Constraints | Description |
---|---|---|---|
cardNumber |
String |
@Card number length must be between 12 and 19, @Luhn, @Must not be blank, @Must not be null |
Card number |
POST /client/currency-for-card HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 39
Host: ecom-staging.fenige.pl
{
"cardNumber" : "5575168861324712"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
cardNumber |
String |
@Card number length must be between 12 and 19, @Luhn, @Must not be blank, @Must not be null |
Card number |
POST /client/currency-for-card HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 39
Host: ecom-staging.fenige.pl
{
"cardNumber" : "4761340000000050"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
cardId |
Number |
@Must not be null, @Numeric |
DataCenter card id. |
POST /client/currency-for-card HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 18
Host: ecom-staging.fenige.pl
{
"cardId" : 1
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
6.2.2. Response
Response status
Status | Description |
---|---|
|
STATUS: S0000 Returned when SUCCESS. |
|
STATUS: E8000 - Returned when request is incorrect, required fields are missing or the values are not valid. |
|
STATUS: E8002 - Returned when you are the problem with authorized to your PSP. |
|
STATUS: E0401 - Issuer card is not supported. |
|
STATUS: E0400 - Returned when failed to get currency for card. |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 207
{
"defaultCurrency" : "PLN",
"currencyCodes" : [ "PLN", "EUR", "USD" ],
"provider" : "MASTERCARD",
"countryCodeNumeric" : "616",
"status" : "S0000",
"message" : "SUCCESS",
"httpStatus" : "OK"
}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 199
{
"defaultCurrency" : "UNDEFINED",
"currencyCodes" : [ "UNDEFINED" ],
"provider" : "VISA",
"countryCodeNumeric" : "616",
"status" : "S0000",
"message" : "SUCCESS",
"httpStatus" : "OK"
}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 173
{
"defaultCurrency" : "UNDEFINED",
"currencyCodes" : [ "UNDEFINED" ],
"provider" : "MASTERCARD",
"status" : "S0000",
"message" : "SUCCESS",
"httpStatus" : "OK"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Currencies supported by card |
|
|
Default currency code for card |
|
|
Card’s provider: MASTERCARD, MAESTRO, VISA, UNKNOWN |
|
|
Country code numeric for Mastercard/Visa: - ISO 3166-1 Numeric |
HTTP/1.1 400 Bad Request
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:06 GMT
Connection: close
Content-Length: 214
{
"errors" : {
"cardNumber" : [ "must not be null", "must not be empty", "must not be blank" ]
},
"status" : "E8000",
"httpStatus" : "BAD_REQUEST",
"traceId" : "cdde400d-c2c9-408d-beeb-e200b6263f39"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 141
{
"status" : "E8002",
"message" : "Unauthorized",
"httpStatus" : "UNAUTHORIZED",
"traceId" : "5170c0cf-7120-46d8-b983-fd165b062e15"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Id of trace |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json;charset=UTF-8
Content-Length: 168
{
"status": "E0401",
"message": "Issuer card is not supported",
"httpStatus": "UNPROCESSABLE_ENTITY",
"traceId": "cf77afc8-f41b-425c-ab6a-de4eb9a69136",
"links" : [ ]
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Id of trace |
HTTP/1.1 503 Service Unavailable
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:05 GMT
Connection: close
Content-Length: 161
{
"status" : "E9001",
"message" : "Error acquirer connection",
"httpStatus" : "SERVICE_UNAVAILABLE",
"traceId" : "da762af3-a5fc-4c96-8378-c3b5b2a0d9b1"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
6.3. Card provider
This method is used to check the card provider, for example: VISA or MASTERCARD. If merchant has stored card in DataCenter can you use this method by cardId rather than cardNumber.
6.3.1. Request
Path | Type | Constraints | Description |
---|---|---|---|
cardNumber |
String |
@Card number length must be between 12 and 19, @Luhn, @Must not be blank, @Must not be null |
PAN card number |
POST /client/card/provider HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 39
Host: ecom-staging.fenige.pl
{
"cardNumber" : "5117964247989169"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
cardId |
Number |
@Must not be null, @Numeric |
DataCenter card id. |
POST /client/card/provider HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 20
Host: ecom-staging.fenige.pl
{
"cardId" : 231
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
6.3.2. Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 101
{
"status" : "S0000",
"message" : "SUCCESS",
"httpStatus" : "OK",
"provider" : "MASTERCARD"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Card’s provider: MASTERCARD, MAESTRO, VISA, UNKNOWN |
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 141
{
"status" : "E8002",
"message" : "Unauthorized",
"httpStatus" : "UNAUTHORIZED",
"traceId" : "9b2bed45-81be-4281-9048-76007f41d37a"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Id of trace |
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 150
{
"status" : "E9000",
"message" : "Domain error",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "5181d783-fb7b-4c3f-bad1-763364277a80"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Id of trace |
HTTP/1.1 503 Service Unavailable
Content-Type: application/json
Content-Length: 156
{
"status" : "E9002",
"message" : "Error mpi connection",
"httpStatus" : "SERVICE_UNAVAILABLE",
"traceId" : "918218dc-45e0-43f2-a251-ef6b01a308b2"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Id of trace |
6.4. Payment
The method is used to charge the cardholder. Using this method, we can authorize and process entire transaction. This method supports both 3DS and without 3DS transactions. You can also use this method using the outside 3ds authorization. How the transaction will be initiated depends on the terminal settings (look at 'is3dsEnable' field). This endpoint is idempotent so if you execute more than one requests with the same data even at the same time, only first registered transaction will be processed further. In response, we receive transaction status.
Merchant has the ability to make a payment for goods which causes the cardholder to be debited in the currency of purchase, terminal or card currency based on the parameters provided: currency of transaction, different currency terminals held and currencies supported by the card. The optional terminalUuid field provided during any of the authorisation methods forces the card to be debited in the currency of the terminal specified if the purchase currency is different from the terminal currency a currency conversion will take place.
The Fenige Payment API methods optionally allows merchants to store card data and sensitive personal data in order to allow performing subsequent transactions. If merchant decides to use DataCenter transaction flow then is required to provide the card id of the card previously stored in the Fenige DataCenter, from which card the relevant required parameters will be downloaded and used for authorization. Card data and sensitive personal data according to the Fenige API specification are: cardNumber, expiryDate, firstName, lastName and email. All card data are stored securely on Fenige DataCenter servers in accordance with applicable security requirements.
From January 2021, there is an internal functionality to restrict access for the PSP to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The PSP will be informed about each access restriction action. |
Since October 2022, there is enabled feature for resolving PENDING status of transaction. Ecommerce system now measure time of processing transaction and rejects transaction which processing time exceeded. Default processing time is set as 120 seconds and in order to change this parameter please contact Fenige Sales Department. If transaction was sent to Mastercard/Visa and processing times up, then Fenige automatically makes reversal for this transaction. |
Mastercard and Visa requires for intra-European Economic Area (EEA), plus United Kingdom, for which EMV 3DS must be used subsequent to a valid authorization soft decline DE39=65 (Mastercard)/1A(Visa).To perform a transaction for which the card has previously received CODE_65(Mastercard)/CODE_1A(Visa), the transaction must be processed with full EMV 3DS (3DS 2.x) and the authentication status must be 'Y'. Correct flow:
|
When performing authorization, remember that there are currencies with different number of decimal places. For example: VND has no pennies and KWD has three decimal places. Please take this into account in the Amount field. For more information on other currencies, see ISO 4217. |





6.4.1. Request
POST /client/payments/auth HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 866
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "042af8c5-ec68-4ce2-801a-d3b00db32bd0",
"requestUuid" : "ab2e3bc8-e13e-4a1d-bf78-2b618a24759f",
"firstName" : "user",
"lastName" : "testUser",
"amount" : 1000,
"currency" : "USD",
"cardNumber" : "5453131785534417",
"expiryDate" : "11/26",
"cvc2" : "123",
"email" : "test@fenige.pl",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"eci" : "02",
"authenticationStatus" : "Y",
"transactionXId" : "d543820d-683e-4589-86d9-6c9e40db4b53"
},
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"province" : "NY",
"postalCode" : "24-110"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
firstName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
First name of cardholder |
lastName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
Last name of cardholder |
amount |
Number |
@Must be at least 100, @Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
cardNumber |
String |
@Card number length must be between 12 and 19, @Must not be blank, @Must not be null |
Full cardholder’s card number must be between 12-digits and 19-digits |
expiryDate |
String |
@Must not be blank, @Must not be null |
Expiration date of card mm/yy |
cvc2 |
String |
@Optional only for Google pay, @Length must be 3 characters, @Must match regular expression: \d+ |
Cardholder’s card cvc2 |
String |
Optional field, @Length(min = 1, max = 128) |
Cardholder’s email |
|
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
outside3ds |
Object |
There are outside 3ds data authorization that have been send to our API |
|
outside3ds.cavv |
String |
Cardholder Authentication Verification Value. |
|
outside3ds.transactionXId |
String |
Server transaction Id generated by DS. Required for 3DS 2.x version. The transactionXId is the field that defines the 3DS version. The presence of this field in the HTTP request specifies that the transaction will be processed with 3DS 2.x. TransactionXId can be obtained by executing the /authentication method. |
|
outside3ds.cavvAlgorithm |
String |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm |
|
outside3ds.eci |
String |
@Length must be between 1 and 2 inclusive, @Must match 00 or 01 or 02 or 05 or 06 or 07, @Must not be null |
Electronic Commerce Indicator: 5 (Visa) or 2 (SecureCode) - The cardholder was successfully authenticated. 6 (Visa) or 1 (SecureCode) - Authentication was attempted, but the cardholder was not enrolled. More info. |
outside3ds.authenticationStatus |
String |
@Must match Y or A or U, @Must not be null |
Authentication status: Y - (Full Authentication) - The customer was successfully authenticated. A - (Successful Attempted Authentication) - Authentication was not available, but functionality was available to generate a proof of authentication attempt. U - (Technical or other problem) - No liability shift, consider whether to proceed with the transaction |
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
cipherCardNumber |
String |
@Optional |
Cipher card number. More in Payment API - JWE chapter |
keysVersion |
Number |
@Optional |
Field informs about keys version that was used to encrypt card number in cipherCardNumber field. More in Payment API - JWE chapter |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
POST /client/payments/auth HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 925
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "042af8c5-ec68-4ce2-801a-d3b00db32bd0",
"terminalUuid" : "9f4054f0-197b-4869-92a9-f60f7946a268",
"requestUuid" : "9368bc56-6d1d-4ea6-8f28-6d48c82ddb3f",
"firstName" : "user",
"lastName" : "testUser",
"amount" : 1000,
"currency" : "USD",
"cardNumber" : "5453131785534417",
"expiryDate" : "11/26",
"cvc2" : "123",
"email" : "test@fenige.pl",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"eci" : "02",
"authenticationStatus" : "Y",
"transactionXId" : "d543820d-683e-4589-86d9-6c9e40db4b53"
},
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"province" : "NY",
"postalCode" : "24-110"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
terminalUuid |
String |
Request’s unique uuid in system |
|
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
firstName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
First name of cardholder |
lastName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
Last name of cardholder |
amount |
Number |
@Must be at least 100, @Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
cardNumber |
String |
@Card number length must be between 12 and 19, @Must not be blank, @Must not be null |
Full cardholder’s card number must be between 12-digits and 19-digits |
expiryDate |
String |
@Must not be blank, @Must not be null |
Expiration date of card mm/yy |
cvc2 |
String |
@Optional only for Google pay, @Length must be 3 characters, @Must match regular expression: \d+ |
Cardholder’s card cvc2 |
String |
Optional field, @Length(min = 1, max = 128) |
Cardholder’s email |
|
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
outside3ds |
Object |
There are outside 3ds data authorization that have been send to our API |
|
outside3ds.cavv |
String |
Cardholder Authentication Verification Value |
|
outside3ds.transactionXId |
String |
Cardholder Authentication Verification Value. The transactionXId is the field that defines the 3DS version.The presence of this field in the HTTP request specifies that the transaction will be processed with 3DS 2.x.TransactionXId can be obtained by executing the /authentication method. |
|
outside3ds.cavvAlgorithm |
String |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm |
|
outside3ds.eci |
String |
@Length must be between 1 and 2 inclusive, @Must match 00 or 01 or 02 or 05 or 06 or 07, @Must not be null |
Electronic Commerce Indicator: 5 (Visa) or 2 (SecureCode) - The cardholder was successfully authenticated. 6 (Visa) or 1 (SecureCode) - Authentication was attempted, but the cardholder was not enrolled. More info. |
outside3ds.authenticationStatus |
String |
@Must match Y or A or U, @Must not be null |
Authentication status: Y - (Full Authentication) - The customer was successfully authenticated. A - (Successful Attempted Authentication) - Authentication was not available, but functionality was available to generate a proof of authentication attempt. U - (Technical or other problem) - No liability shift, consider whether to proceed with the transaction |
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03. |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
cipherCardNumber |
String |
@Optional |
Cipher card number. More in Payment API - JWE chapter |
keysVersion |
Number |
@Optional |
Field informs about keys version that was used to encrypt card number in cipherCardNumber field. More in Payment API - JWE chapter |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
POST /client/payments/auth HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 803
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "042af8c5-ec68-4ce2-801a-d3b00db32bd0",
"requestUuid" : "61639432-485d-442b-a2cd-45e31e424cf1",
"firstName" : "user",
"lastName" : "testUser",
"amount" : 1000,
"currency" : "USD",
"cardNumber" : "5453131785534417",
"expiryDate" : "11/26",
"cvc2" : "123",
"email" : "test@fenige.pl",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"eci" : "02",
"authenticationStatus" : "Y"
},
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"province" : "NY",
"postalCode" : "24-110"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
firstName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
First name of cardholder |
lastName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
Last name of cardholder |
amount |
Number |
@Must be at least 100, @Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
cardNumber |
String |
@Card number length must be between 12 and 19, @Must not be blank, @Must not be null |
Full cardholder’s card number must be between 12-digits and 19-digits |
expiryDate |
String |
@Must not be blank, @Must not be null |
Expiration date of card mm/yy |
cvc2 |
String |
@Optional only for Google pay, @Length must be 3 characters, @Must match regular expression: \d+ |
Cardholder’s card cvc2 |
String |
Optional field, @Length(min = 1, max = 128) |
Cardholder’s email |
|
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
outside3ds |
Object |
There are outside 3ds data authorization that have been send to our API |
|
outside3ds.cavv |
String |
Cardholder Authentication Verification Value. |
|
outside3ds.cavvAlgorithm |
String |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm |
|
outside3ds.eci |
String |
@Length must be between 1 and 2 inclusive, @Must match 00 or 01 or 02 or 05 or 06 or 07, @Must not be null |
Electronic Commerce Indicator: 5 (Visa) or 2 (SecureCode) - The cardholder was successfully authenticated. 6 (Visa) or 1 (SecureCode) - Authentication was attempted, but the cardholder was not enrolled. More info. |
outside3ds.authenticationStatus |
String |
@Must match Y or A or U, @Must not be null |
Authentication status: Y - (Full Authentication) - The customer was successfully authenticated. A - (Successful Attempted Authentication) - Authentication was not available, but functionality was available to generate a proof of authentication attempt. U - (Technical or other problem) - No liability shift, consider whether to proceed with the transaction |
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
cipherCardNumber |
String |
@Optional |
Cipher card number. More in Payment API - JWE chapter |
keysVersion |
Number |
@Optional |
Field informs about keys version that was used to encrypt card number in cipherCardNumber field. More in Payment API - JWE chapter |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
POST /client/payments/auth HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 862
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "042af8c5-ec68-4ce2-801a-d3b00db32bd0",
"terminalUuid" : "9f4054f0-197b-4869-92a9-f60f7946a268",
"requestUuid" : "807b1925-6b3d-4203-a9c1-99daf77d784d",
"firstName" : "user",
"lastName" : "testUser",
"amount" : 1000,
"currency" : "USD",
"cardNumber" : "5453131785534417",
"expiryDate" : "11/26",
"cvc2" : "123",
"email" : "test@fenige.pl",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"eci" : "02",
"authenticationStatus" : "Y"
},
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"province" : "NY",
"postalCode" : "24-110"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
terminalUuid |
String |
Request’s unique uuid in system |
|
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
firstName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
First name of cardholder |
lastName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
Last name of cardholder |
amount |
Number |
@Must be at least 100, @Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
cardNumber |
String |
@Card number length must be between 12 and 19, @Must not be blank, @Must not be null |
Full cardholder’s card number must be between 12-digits and 19-digits |
expiryDate |
String |
@Must not be blank, @Must not be null |
Expiration date of card mm/yy |
cvc2 |
String |
@Optional only for Google pay, @Length must be 3 characters, @Must match regular expression: \d+ |
Cardholder’s card cvc2 |
String |
Optional field, @Length(min = 1, max = 128) |
Cardholder’s email |
|
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
outside3ds |
Object |
There are outside 3ds data authorization that have been send to our API |
|
outside3ds.cavv |
String |
Cardholder Authentication Verification Value |
|
outside3ds.cavvAlgorithm |
String |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm |
|
outside3ds.eci |
String |
@Length must be between 1 and 2 inclusive, @Must match 00 or 01 or 02 or 05 or 06 or 07, @Must not be null |
Electronic Commerce Indicator: 5 (Visa) or 2 (SecureCode) - The cardholder was successfully authenticated. 6 (Visa) or 1 (SecureCode) - Authentication was attempted, but the cardholder was not enrolled. More info. |
outside3ds.authenticationStatus |
String |
@Must match Y or A or U, @Must not be null |
Authentication status: Y - (Full Authentication) - The customer was successfully authenticated. A - (Successful Attempted Authentication) - Authentication was not available, but functionality was available to generate a proof of authentication attempt. U - (Technical or other problem) - No liability shift, consider whether to proceed with the transaction |
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03. |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
cipherCardNumber |
String |
@Optional |
Cipher card number. More in Payment API - JWE chapter |
keysVersion |
Number |
@Optional |
Field informs about keys version that was used to encrypt card number in cipherCardNumber field. More in Payment API - JWE chapter |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
POST /client/payments/auth HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 655
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "ac8dbfc0-967a-4867-8978-896cdbfb6bc1",
"requestUuid" : "cf12f6aa-3426-4752-97b4-2572c26c03cd",
"firstName" : "user",
"lastName" : "testUser",
"amount" : 1000,
"currency" : "USD",
"cardNumber" : "5453131785534417",
"expiryDate" : "11/26",
"cvc2" : "123",
"email" : "test@fenige.pl",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"province" : "NY",
"postalCode" : "24-110"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
firstName |
String |
First name of cardholder |
|
lastName |
String |
Last name of cardholder |
|
amount |
Number |
@Must be at least 100, @Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
cardNumber |
String |
Full cardholder’s card number must be between 12-digits and 19-digits |
|
expiryDate |
String |
Expiration date of card mm/yy |
|
cvc2 |
String |
@Optional only for Google pay, @Length must be 3 characters, @Must match regular expression: \d+ |
Cardholder’s card cvc2 |
String |
Optional field, @Length(min = 1, max = 128) |
Cardholder’s email |
|
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
cipherCardNumber |
String |
@Optional |
Cipher card number. More in Payment API - JWE chapter |
keysVersion |
Number |
@Optional |
Field informs about keys version that was used to encrypt card number in cipherCardNumber field. More in Payment API - JWE chapter |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
POST /client/payments/auth HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 714
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "042af8c5-ec68-4ce2-801a-d3b00db32bd0",
"terminalUuid" : "8e8127fe-8af6-406e-bc25-fa4855ff68ad",
"requestUuid" : "7a82bfe6-5b82-4285-bec8-bd57afe3d7fe",
"firstName" : "user",
"lastName" : "testUser",
"amount" : 1000,
"currency" : "USD",
"cardNumber" : "5453131785534417",
"expiryDate" : "11/26",
"cvc2" : "123",
"email" : "test@fenige.pl",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"postalCode" : "24-110",
"province" : "NY"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
firstName |
String |
First name of cardholder |
|
lastName |
String |
Last name of cardholder |
|
amount |
Number |
@Must be at least 100, @Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
cardNumber |
String |
Full cardholder’s card number must be between 12-digits and 19-digits |
|
expiryDate |
String |
Expiration date of card mm/yy |
|
cvc2 |
String |
@Optional only for Google pay, @Length must be 3 characters, @Must match regular expression: \d+ |
Cardholder’s card cvc2 |
String |
Optional field, @Length(min = 1, max = 128) |
Cardholder’s email |
|
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
cipherCardNumber |
String |
@Optional |
Cipher card number. More in Payment API - JWE chapter |
keysVersion |
Number |
@Optional |
Field informs about keys version that was used to encrypt card number in cipherCardNumber field. More in Payment API - JWE chapter |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
terminalUuid |
String |
Terminals’s unique uuid in system |
POST /client/payments/auth HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 744
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "03039358-daa0-453c-a58c-a707f2c28be5",
"requestUuid" : "3df34a4f-03fa-4205-8866-4b87e1d4c9b0",
"amount" : 1000,
"currency" : "USD",
"cardId" : 1906455,
"cvc2" : "123",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"eci" : "02",
"authenticationStatus" : "Y",
"transactionXId" : "d543820d-683e-4589-86d9-6c9e40db4b53"
},
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"province" : "NY",
"postalCode" : "24-110"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
amount |
Number |
@Must be at least 100, @Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
cardId |
Number |
@Must not be null, @Numeric |
DataCenter card id. Required to obtain card information data from DataCenter such as (cardNumber, expiryDate, firstName, lastName, email) |
cvc2 |
String |
@Optional only for Google pay, @Length must be 3 characters, @Must match regular expression: \d+ |
Cardholder’s card cvc2 |
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
outside3ds |
Object |
There are outside 3ds data authorization that have been send to our API |
|
outside3ds.cavv |
String |
Cardholder Authentication Verification Value |
|
outside3ds.transactionXId |
String |
Cardholder Authentication Verification Value. The transactionXId is the field that defines the 3DS version.The presence of this field in the HTTP request specifies that the transaction will be processed with 3DS 2.x.TransactionXId can be obtained by executing the /authentication method. |
|
outside3ds.cavvAlgorithm |
String |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm |
|
outside3ds.eci |
String |
@Length must be between 1 and 2 inclusive, @Must match 01 or 02 or 05 or 06, @Must not be null |
Electronic Commerce Indicator: 5 (Visa) or 2 (SecureCode) - The cardholder was successfully authenticated. 6 (Visa) or 1 (SecureCode) - Authentication was attempted, but the cardholder was not enrolled. Chargeback protection applies. |
outside3ds.authenticationStatus |
String |
@Must match Y or A, @Must not be null |
Authentication status: Y - (Full Authentication) - The customer was successfully authenticated. A - (Successful Attempted Authentication) - Authentication was not available, but functionality was available to generate a proof of authentication attempt. |
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
cipherCardNumber |
String |
@Optional |
Cipher card number. More in Payment API - JWE chapter |
keysVersion |
Number |
@Optional |
Field informs about keys version that was used to encrypt card number in cipherCardNumber field. More in Payment API - JWE chapter |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
6.4.2. Response
Response status
Status | Description |
---|---|
|
Returned when transaction was successfully authorized. |
|
STATUS: E8000 - Returned when request is incorrect, required fields are missing or the values are not valid. |
|
STATUS: E8002 - Returned when you are the problem with authorized to your PSP. |
|
STATUS: E8001 - Returned when server understood the request but refuses to authorize it. |
|
STATUS: E0122 - Returned when merchant is not existing. STATUS: E0132 - Returned when terminal is not existing. STATUS: E0135 - Returned when terminal for merchant not exist or all of them are inactive. STATUS: E0137 - Returned when there is not terminal marked as default STATUS: E06003 - Returned when DataCenter card was not found. |
|
STATUS: E0150 - Returned when transaction is rejected. STATUS: E0151 - Returned when transaction is rejected, because currency is not supported. STATUS: E0152 - Returned when transaction is rejected, because issuer is not supported. STATUS: E01580 - Returned when transaction is rejected, because DataCenter card was expired. STATUS: E01581 - Returned when transaction is rejected, because not found Card Authentication (3DS 2.X) STATUS: E01582 - Returned when transaction is rejected, because Card Authentication not match to transaction type (3DS 2.X) STATUS: E0159 - Returned when transaction is rejected, because restricted transaction amount has occurred STATUS: E01594 - Returned when transaction is rejected, because transactionXId parameter had registered for another transaction STATUS: E01596 - Returned when transaction is rejected, because terminal has blocked transaction with card issued in restricted country STATUS: E01597 - Returned when transaction is rejected, because 3DS version of terminal are not compatible with 3DS version defined in request STATUS: E01600 - Transaction rejected, 3DS 2.X flow invoked for other card number than specified in the request STATUS: E01601 - Returned when transaction is rejected, because terminal is blocked for provider STATUS: E01602 - Transaction rejected, geographic scope is not permitted for this transaction STATUS: E01607 - Transaction rejected, internal server error during authorization request generation STATUS: E10000 - Transaction rejected, terminal daily card transaction limit exceeded STATUS: E10001 - Transaction rejected, terminal daily transaction limit exceeded STATUS: E10002 - Transaction rejected, terminal monthly transaction limit exceeded STATUS: E0200 - Returned when transaction is rejected, because card is blocked in Fenige System STATUS: E0201 - Returned when transaction is rejected, because BIN is blocked in Fenige System STATUS: E0202 - Returned when transaction is rejected, because Terminal is blocked in Fenige System STATUS: E0204 - Returned when transaction is rejected, because user’s personal data was found on AML (sanctions) list STATUS: E0205 - Returned when transaction is rejected, because Bank is blocked in Fenige System STATUS: E0206 - Returned when transaction is rejected, because to many reject transactions and card is blocked STATUS: E0207 - Returned when transaction is rejected, bacause to many attempts declined and card is blocked STATUS: E0208 - Transaction rejected, second transaction with merchant advice code 03 or 21 within 30 days STATUS: E0209 - Returned when sender or receiver name contains fraudulent phrase STATUS: E0210 - Returned when sender has suspicious name STATUS: E11000 - Returned when transaction processing time set by terminal was exceeded |
|
STATUS: E0153 - Returned when transaction is declined, by problem with MIP connection. STATUS: E01599 - Transaction declined, processing timeout. STATUS: E0142 - Returned when commission configuration is not added for terminal. STATUS: E0190 - Returned when currency rate is invalid. STATUS: E9000 - Returned when reason is unknown. STATUS: E9008 - Returned when mpi received 3ds initialize failed. |
|
STATUS: E9001 - Returned when is error acquirer connection. STATUS: E9002 - Returned when is error mpi connection. STATUS: E9010 - Returned when is error DataCenter connection. STATUS: E9011 - Returned when is error Limit connection. |
{
"requestUuid" : "25545ce0-2af7-4085-81d6-e3dfb9de6246",
"transactionStatus" : "APPROVED",
"responseCode" : "CODE_00",
"status" : "S0002",
"message" : "Success transaction",
"httpStatus" : "OK"
}
Path | Type | Description |
---|---|---|
|
|
Request unique uuid in system |
|
|
Transaction status |
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Response code |
HTTP/1.1 400 Bad Request
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:11:11 GMT
Connection: close
Content-Length: 485
{
"errors" : {
"expiryDate" : [ "invalid card format expiration date" ],
"firstName" : [ "must not be null", "must not be blank" ],
"lastName" : [ "must not be blank", "must not be null" ],
"amount" : [ "must not be null" ],
"merchantUuid" : [ "must not be null" ],
"requestUuid" : [ "must not be null" ],
"currency" : [ "must not be null" ]
},
"status" : "E8000",
"httpStatus" : "BAD_REQUEST",
"traceId" : "4ad3b22d-c671-4b0e-8536-3930b69daa61"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 400 Bad Request
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:11:11 GMT
Connection: close
Content-Length: 485
{
"errors" : {
"expiryDate" : [ "invalid card format expiration date" ],
"firstName" : [ "must not be null", "must not be blank" ],
"lastName" : [ "must not be blank", "must not be null" ],
"amount" : [ "must not be null" ],
"merchantUuid" : [ "must not be null" ],
"requestUuid" : [ "must not be null" ],
"currency" : [ "must not be null" ]
},
"status" : "E8000",
"httpStatus" : "BAD_REQUEST",
"traceId" : "4ad3b22d-c671-4b0e-8536-3930b69daa61"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 400 Bad Request
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:11:11 GMT
Connection: close
Content-Length: 679
{
"errors" : {
"expiryDate" : [ "Card id was provided, expiryDate is obtained from data center card: 1906455" ],
"lastName" : [ "Card id was provided, lastName is obtained from data center card: 1906455" ],
"firstName" : [ "Card id was provided, firstName is obtained from data center card: 1906455" ],
"cardId" : [ "Please provide cardId for DATACENTER transaction or fields: cardNumber, expiryDate, firstName, lastName for PLAIN transaction" ],
"cardNumber" : [ "Card id was provided, cardNumber is obtained from data center card: 1906455" ]
},
"status" : "E8000",
"httpStatus" : "BAD_REQUEST",
"traceId" : "8cc7a40d-0333-4e81-9c20-53605053ad8b"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic realm="Realm"
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 141
Date: Mon, 25 Sep 2023 11:11:11 GMT
{
"status" : "E8002",
"message" : "Unauthorized",
"httpStatus" : "UNAUTHORIZED",
"traceId" : "137b4d26-cede-4575-b117-1e949e784e36"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 403 Forbidden
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 135
Date: Mon, 25 Sep 2023 11:11:13 GMT
{
"status" : "E8001",
"message" : "Forbidden",
"httpStatus" : "FORBIDDEN",
"traceId" : "4595c839-13ca-48c0-90e8-2512f9e24e2e"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 146
{
"status" : "E0122",
"message" : "Merchant not exists.",
"httpStatus" : "NOT_FOUND",
"traceId" : "cf671aa6-a684-4a66-8f2d-24a99d466899"
}
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 146
{
"status" : "E0132",
"message" : "Terminal not exists.",
"httpStatus" : "NOT_FOUND",
"traceId" : "0e3e023e-14dd-4161-9cc4-615f899ab794"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 163
{
"status" : "E0137",
"message" : "Default terminal not exist",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "538815db-2016-4ca5-a430-dbdfe9d018ad"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 159
{
"status" : "E0135",
"message" : "Terminals for merchant not exists",
"httpStatus" : "NOT_FOUND",
"traceId" : "45d84472-4cf9-4d4c-b1c5-0147eeb66faf"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 246
{
"requestUuid" : "62fb77f4-974a-4b7b-b34a-7c76ce9f2508",
"transactionStatus" : "REJECTED",
"status" : "E06003",
"message" : "Datacenter card not found",
"httpStatus" : "NOT_FOUND",
"traceId" : "42e77860-f3d3-4576-b427-af023359f483"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 251
{
"requestUuid" : "b2b2a9e4-8781-45ab-a7c3-dad3477e6a57",
"transactionStatus" : "REJECTED",
"status" : "E0150",
"message" : "Transaction rejected",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "cef66f9c-ecc9-4332-92d6-628f965ba7d1"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 275
{
"requestUuid" : "a437a759-7140-4442-b886-1c319480e9cc",
"transactionStatus" : "REJECTED",
"status" : "E0151",
"message" : "Transaction rejected, currency not supported",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "f9598156-3156-4502-a1d5-fc3eb5fe8185"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 278
{
"requestUuid" : "e9da552b-d921-4c91-b8fb-abed338cb644",
"transactionStatus" : "REJECTED",
"status" : "E0152",
"message" : "Transaction rejected, issuer card not supported",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "d08790f3-a384-438d-8970-43e9b74e75e6"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 270
{
"requestUuid" : "bebf0399-19ff-4d85-b5d9-ab66f9aae69f",
"transactionStatus" : "REJECTED",
"status" : "E01580",
"message" : "Transaction rejected. Card is expired.",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "5299f5eb-b2dd-4241-96b7-da478eee625b"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 295
{
"requestUuid" : "4fc128e7-5d17-4a9b-83d8-e2daef1d4df9",
"transactionStatus" : "REJECTED",
"status" : "E0159",
"message" : "Transaction rejected, restricted transaction amount has occurred",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "55f93964-609d-466b-91fd-ea6651ba5a88"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 267
{
"requestUuid" : "3ae36bda-f000-4bf5-b2c6-aabd1bab1866",
"transactionStatus" : "REJECTED",
"status" : "E0201",
"message" : "Transaction rejected, bin is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "cb2e2869-5ef4-40f2-bcdc-074c5e1ab4c2"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 272
{
"requestUuid" : "7e097de6-6786-4510-9b00-99f657880f01",
"transactionStatus" : "REJECTED",
"status" : "E0202",
"message" : "Transaction rejected, terminal is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "231cff55-be46-4412-96c8-3247689aa7fe"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 272
{
"requestUuid" : "66cf4a92-8cc8-48b9-989d-2d6512f25a64",
"transactionStatus" : "REJECTED",
"status" : "E0204",
"message" : "Transaction rejected, user is on aml list",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "bd6d07a3-d5b8-4769-81f7-4d737be92dcc"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 268
{
"requestUuid" : "8cd04a81-ca5d-4ff4-b8bb-93002a45acae",
"transactionStatus" : "REJECTED",
"status" : "E0205",
"message" : "Transaction rejected, bank is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "2e2b156f-b7e5-4a9b-ac60-eefab823caaa"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 300
{
"requestUuid" : "89ec0012-bae4-476a-9e6b-31f04a07781b",
"transactionStatus" : "REJECTED",
"status" : "E0206",
"message" : "Transaction rejected, to many reject transactions and card is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "f4f01cbc-ab6a-4465-9972-f8a62d9de3a6"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 298
{
"requestUuid" : "334b8bba-5d2a-469f-9e8d-5d916d921d3b",
"transactionStatus" : "REJECTED",
"status" : "E0207",
"message" : "Transaction rejected, to many attempts declined and card is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "e5a80813-9137-4cd3-a059-27e9533e7cd3"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 321
{
"requestUuid" : "7913e5e1-4edd-468c-902b-124cd6d2fc86",
"transactionStatus" : "REJECTED",
"status" : "E0208",
"message" : "Transaction rejected, second transaction with merchant advice code 03 or 21 within 30 days",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "169c8549-4ae7-4251-b3d4-516d56ae3b73"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 292
{
"requestUuid" : "ed7eeeb7-b06c-47d6-9e1a-eaef68f86bbf",
"transactionStatus" : "REJECTED",
"status" : "E0209",
"message" : "Transaction rejected, sender name contains fraudulent phrase.",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "91d96a8a-470c-42bb-a0d7-358d61cdff07"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 276
{
"requestUuid" : "f964b50e-5ce7-4d3e-a596-c92be96df428",
"transactionStatus" : "REJECTED",
"status" : "E0210",
"message" : "Transaction rejected, suspicious sender name.",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "d72fb2a4-d482-425f-a43a-a38facecf344"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 317
{
"requestUuid" : "7c3e7255-46ba-4cda-9a20-18bbf33a7527",
"transactionStatus" : "REJECTED",
"status" : "E01594",
"message" : "Transaction rejected, transactionXId parameter had registered for another transaction",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "501c522a-bc3e-42eb-8097-37643a3adf0d"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 321
{
"requestUuid" : "fe1a6267-ac9a-4453-af75-f2c205526d73",
"transactionStatus" : "REJECTED",
"status" : "E01596",
"message" : "Transaction rejected, terminal blocks transactions with card issued in given card country",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "ece517ad-6e61-4896-9bef-de1564be744a"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 369
{
"requestUuid" : "078ec5b0-bba5-4259-a272-703dd8703505",
"transactionStatus" : "REJECTED",
"status" : "E01597",
"message" : "Transaction rejected, 3DS version of terminal are not compatible with 3DS version defined in request. Please contact the sales department",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "a48a4aa6-c234-4537-b577-a184c053bef3"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 315
{
"requestUuid" : "b1d61203-82ac-40b4-9101-e02a81f91bad",
"transactionStatus" : "REJECTED",
"status" : "E01607",
"message" : "Transaction rejected, internal server error during authorization request generation",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "63f44911-5740-4e12-ad1f-bbba388a0a51"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 298
{
"requestUuid" : "c99f9d2a-4781-405d-af9a-46c999203ca1",
"transactionStatus" : "REJECTED",
"status" : "E01598",
"message" : "Transaction rejected, ECI value is not available for card provider",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "3841e430-89f9-4d96-9b8c-8d568ad0d78a"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 381
{
"requestUuid" : "694ed51c-05b2-4088-9f59-6702541e0f3c",
"transactionStatus" : "REJECTED",
"cardBlockadeAdditionalData" : {
"blockType" : "TEMP",
"blockedUntil" : "2022-11-01T12:51:32.000"
},
"status" : "E0200",
"message" : "Transaction rejected, card is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "fe6babac-8d8d-4b40-966e-3a9d04d1ddb5"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
|
|
Block type. Possible values: TEMP - temporary, PERMANENT - permanent. |
|
|
Date until card will be blocked in yyyy-MM-ddThh-mm-ss.SSS format. |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 326
{
"requestUuid" : "66e5353d-b968-4cbe-b13f-c92f6451f311",
"transactionStatus" : "REJECTED",
"status" : "E01584",
"message" : "Transaction rejected, 3DS 2.X flow invoked for other card number than specified in the request",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "8df2980f-e409-4636-8407-2721b82a5ee7"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 286
{
"requestUuid" : "b358cd55-3af8-45f6-b74d-09a377a45e00",
"transactionStatus" : "REJECTED",
"status" : "E01601",
"message" : "Transaction rejected, terminal is blocked for provider",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "d00b6d7a-e493-425f-92d0-5c774b0e1251"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 308
{
"requestUuid" : "14ccfe81-1ad7-4c95-a518-3bf2545fcefb",
"transactionStatus" : "REJECTED",
"status" : "E01602",
"message" : "Transaction rejected, geographic scope is not permitted for this transaction",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "987245a7-6ea8-4bb4-bd3a-43198113a342"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 300
{
"requestUuid" : "2362aeac-fd5d-4377-bbaf-a8410132df46",
"transactionStatus" : "REJECTED",
"status" : "E10000",
"message" : "Transaction rejected, terminal daily card transaction limit exceeded",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "f4962fd5-5809-4ac8-ae8e-b470e44d5f6d"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 295
{
"requestUuid" : "cf6f3a9d-8185-4be4-8b15-a7a688a749bd",
"transactionStatus" : "REJECTED",
"status" : "E10001",
"message" : "Transaction rejected, terminal daily transaction limit exceeded",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "2b8d5fe8-5d72-426a-ad6e-44d746ca13f6"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 297
{
"requestUuid" : "6a9d40d9-8ca1-44bf-a157-ed88bbf601e2",
"transactionStatus" : "REJECTED",
"status" : "E10002",
"message" : "Transaction rejected, terminal monthly transaction limit exceeded",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "fee8a117-c8e3-4ffb-b18d-240b0556d5da"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 183
{
"status" : "E0142",
"message" : "Commission configuration not add for terminal",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "9f49d2e7-3bd2-4ce2-9276-49856b4d641d"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 280
{
"requestUuid" : "8e5e1243-d146-435d-b53d-d5a2ecd9f718",
"transactionStatus" : "PENDING",
"status" : "E0153",
"message" : "Transaction declined, problem with MIP connection",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "021377cb-3070-4327-a508-71559e4572e6"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 273
{
"requestUuid" : "b3250b19-4e6b-4d14-a271-03f33dc9686c",
"transactionStatus" : "DECLINED",
"status" : "E01599",
"message" : "Transaction declined, processing timeout",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "a4a3c613-8972-451b-bd4e-8cead0e3f3dd"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 166
{
"status" : "E0190",
"message" : "Failed to get currency rates",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "f982ef3a-ce31-4891-8cf0-5027e6ad56fd"
}
HTTP/1.1 500 Internal Server Error
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:19 GMT
Connection: close
Content-Length: 150
{
"status" : "E9000",
"message" : "Domain error",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "3c268696-8733-4d27-a65d-64f672197318"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 265
{
"requestUuid" : "3ef97403-97e6-49f6-84d3-87d96b1c7948",
"transactionStatus" : "DECLINED",
"status" : "E9008",
"message" : "Error mpi - 3ds initialize failed",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "695fcae1-926a-4a2c-825e-fba42cd0e19a"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 503 Service Unavailable
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:05 GMT
Connection: close
Content-Length: 161
{
"status" : "E9001",
"message" : "Error acquirer connection",
"httpStatus" : "SERVICE_UNAVAILABLE",
"traceId" : "da762af3-a5fc-4c96-8378-c3b5b2a0d9b1"
}
HTTP/1.1 503 Service Unavailable
Content-Type: application/json
Content-Length: 250
{
"requestUuid" : "0e762454-b16c-43cd-8b10-269a7d40ca6b",
"transactionStatus" : "DECLINED",
"status" : "E9002",
"message" : "Error mpi connection",
"httpStatus" : "SERVICE_UNAVAILABLE",
"traceId" : "6775d80c-292c-407c-81ca-f176ca9ffa8b"
}
HTTP/1.1 503 Service Unavailable
Content-Type: application/json
Content-Length: 258
{
"requestUuid" : "75a01ad7-4b0b-496c-b5a6-b11cfe179321",
"transactionStatus" : "REJECTED",
"status" : "E9010",
"message" : "Error data center connection",
"httpStatus" : "SERVICE_UNAVAILABLE",
"traceId" : "8be63987-c139-4b2b-ae19-e5f8b2b902dc"
}
HTTP/1.1 503 Service Unavailable
Content-Type: application/json
Content-Length: 249
{
"requestUuid" : "000e0e3a-1c3e-45a5-a3de-2bfe5a5871b8",
"transactionStatus" : "ERROR",
"status" : "E9011",
"message" : "Error limit connection",
"httpStatus" : "SERVICE_UNAVAILABLE",
"traceId" : "566bb255-7806-4fdc-b483-1b3ee6a3c65e"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
6.5. MO/TO payment
MO/TO is a type of transaction where the customer makes a purchase in the merchant's shop by phone or e-mail. All required transactional data are obtained through a call to the merchant's consultant and sensitive data, e.g. by typing cvc, expiry date, card number on the phone keypad. The MO/TO transaction has two possible types of authentication: CVC (using the card's cvc) or AVS (using the cardholder's address - postcode and address e.g. house number).
Merchant has the ability to make a payment for goods which causes the cardholder to be debited in the currency of purchase, terminal or card currency based on the parameters provided: currency of transaction, different currency terminals held and currencies supported by the card. The optional terminalUuid field provided during any of the authorisation methods forces the card to be debited in the currency of the terminal specified if the purchase currency is different from the terminal currency a currency conversion will take place.
The Fenige Payment API methods optionally allows merchants to store card data and sensitive personal data in order to allow performing subsequent transactions. If merchant decides to use DataCenter transaction flow then is required to provide the card id of the card previously stored in the Fenige DataCenter, from which card the relevant required parameters will be downloaded and used for authorization. Card data and sensitive personal data according to the Fenige API specification are: cardNumber, expiryDate, firstName, lastName and email. All card data are stored securely on Fenige DataCenter servers in accordance with applicable security requirements.
From January 2021, there is an internal functionality to restrict access for the PSP to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The PSP will be informed about each access restriction action. |
When performing authorization, remember that there are currencies with different number of decimal places. For example: VND has no pennies and KWD has three decimal places. Please take this into account in the Amout field. For more information on other currencies, see ISO 4217. |




6.5.1. Request
POST /client/payments/moto/auth HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 677
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "ac8dbfc0-967a-4867-8978-896cdbfb6bc1",
"requestUuid" : "7a7b35fe-304d-4a89-bf67-98c8b6402f0e",
"firstName" : "user",
"lastName" : "testUser",
"amount" : 1000,
"currency" : "USD",
"cardNumber" : "5453131785534417",
"expiryDate" : "11/26",
"cvc2" : "123",
"email" : "test@fenige.pl",
"motoType" : "CVC",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"province" : "NY",
"postalCode" : "24-110"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
firstName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
First name of cardholder |
lastName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
Last name of cardholder |
amount |
Number |
@Must be at least 100, @Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
cardNumber |
String |
@Card number length must be between 12 and 19, @Must not be blank, @Must not be null |
Full cardholder’s card number must be between 12-digits and 19-digits |
expiryDate |
String |
@Must not be blank, @Must not be null |
Expiration date of card mm/yy |
cvc2 |
String |
@Length must be 3 characters, @Must not be null when MO/TO CVC @Must match regular expression: \d+ |
Cardholder’s card cvc2. Required only when moto verification type (motoType) is set to CVC value |
String |
Optional field, @Length(min = 1, max = 128) |
Cardholder’s email |
|
motoType |
String |
@Must not be null |
Allows to switch between CVC and AVS (Address Verification) methods of authentication |
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
cipherCardNumber |
String |
@Optional |
Cipher card number. More in Payment API - JWE chapter |
keysVersion |
Number |
@Optional |
Field informs about keys version that was used to encrypt card number in cipherCardNumber field. More in Payment API - JWE chapter |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
POST /client/payments/moto/auth HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 736
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "ea0bdd91-4372-4969-a21b-30491b3cdfad",
"terminalUuid" : "42f30faa-4d5f-4c50-8284-2edbdd1f5c2e",
"requestUuid" : "72f8e97a-6367-445f-9dc6-e12bdf9d8a5e",
"firstName" : "user",
"lastName" : "testUser",
"amount" : 1000,
"currency" : "USD",
"cardNumber" : "5453131785534417",
"expiryDate" : "11/26",
"cvc2" : "123",
"email" : "test@fenige.pl",
"motoType" : "CVC",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"postalCode" : "24-110",
"province" : "NY"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
terminalUuid |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
Terminals’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
firstName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
First name of cardholder |
lastName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
Last name of cardholder |
amount |
Number |
@Must be at least 100, @Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
cardNumber |
String |
@Card number length must be between 12 and 19, @Must not be blank, @Must not be null |
Full cardholder’s card number must be between 12-digits and 19-digits |
expiryDate |
String |
@Must not be blank, @Must not be null |
Expiration date of card mm/yy |
cvc2 |
String |
@Length must be 3 characters, @Must not be null when MO/TO CVC @Must match regular expression: \d+ |
Cardholder’s card cvc2. Required only when moto verification type (motoType) is set to CVC value |
String |
Optional field, @Length(min = 1, max = 128) |
Cardholder’s email |
|
motoType |
String |
@Must not be null |
Allows to switch between CVC and AVS (Address Verification) methods of authentication |
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
cipherCardNumber |
String |
@Optional |
Cipher card number. More in Payment API - JWE chapter |
keysVersion |
Number |
@Optional |
Field informs about keys version that was used to encrypt card number in cipherCardNumber field. More in Payment API - JWE chapter |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
POST /client/payments/moto/auth HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 690
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "ac8dbfc0-967a-4867-8978-896cdbfb6bc1",
"requestUuid" : "a77c4a2a-37a8-4a8e-953d-868b8df10fad",
"firstName" : "user",
"lastName" : "testUser",
"amount" : 1000,
"currency" : "USD",
"cardNumber" : "5453131785534417",
"expiryDate" : "11/26",
"email" : "test@fenige.pl",
"motoType" : "AVS",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"clientPostalCode" : "24-110",
"clientAddress" : "5",
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"province" : "NY"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
firstName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
First name of cardholder |
lastName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
Last name of cardholder |
amount |
Number |
@Must be at least 100, @Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
cardNumber |
String |
@Card number length must be between 12 and 19, @Must not be blank, @Must not be null |
Full cardholder’s card number must be between 12-digits and 19-digits |
expiryDate |
String |
@Must not be blank, @Must not be null |
Expiration date of card mm/yy |
String |
Optional field, @Length(min = 1, max = 128) |
Cardholder’s email |
|
motoType |
String |
@Must not be null |
Allows to switch between CVC and AVS (Address Verification) methods of authentication |
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
clientPostalCode |
String |
@Length must be between 1 and 10 inclusive, @Must not be blank, @Must not be null when AVS |
Client postal code required in AVS service to authorize cardholder in bank issuer during MO/TO transaction |
clientAddress |
String |
@Must not be null when AVS |
Client address (e.g. house number) required in AVS service to authorize cardholder in bank issuer during MO/TO transaction |
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
cipherCardNumber |
String |
@Optional |
Cipher card number. More in Payment API - JWE chapter |
keysVersion |
Number |
@Optional |
Field informs about keys version that was used to encrypt card number in cipherCardNumber field. More in Payment API - JWE chapter |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
POST /client/payments/moto/auth HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 749
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "ea0bdd91-4372-4969-a21b-30491b3cdfad",
"terminalUuid" : "42f30faa-4d5f-4c50-8284-2edbdd1f5c2e",
"requestUuid" : "2499e126-2a99-4d02-9d0e-2cbfe2b3bde1",
"firstName" : "user",
"lastName" : "testUser",
"amount" : 1000,
"currency" : "USD",
"cardNumber" : "5453131785534417",
"expiryDate" : "11/26",
"email" : "test@fenige.pl",
"motoType" : "AVS",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"clientPostalCode" : "24-110",
"clientAddress" : "5",
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"province" : "NY"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
terminalUuid |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
Terminals’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
firstName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
First name of cardholder |
lastName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
Last name of cardholder |
amount |
Number |
@Must be at least 100, @Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
cardNumber |
String |
@Card number length must be between 12 and 19, @Must not be blank, @Must not be null |
Full cardholder’s card number must be between 12-digits and 19-digits |
expiryDate |
String |
@Must not be blank, @Must not be null |
Expiration date of card mm/yy |
String |
Optional field, @Length(min = 1, max = 128) |
Cardholder’s email |
|
motoType |
String |
@Must not be null |
Allows to switch between CVC and AVS (Address Verification) methods of authentication |
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
clientPostalCode |
String |
@Length must be between 1 and 10 inclusive, @Must not be blank, @Must not be null when AVS |
Client postal code required in AVS service to authorize cardholder in bank issuer during MO/TO transaction |
clientAddress |
String |
@Must not be null when AVS |
Client address (e.g. house number) required in AVS service to authorize cardholder in bank issuer during MO/TO transaction |
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
cipherCardNumber |
String |
@Optional |
Cipher card number. More in Payment API - JWE chapter |
keysVersion |
Number |
@Optional |
Field informs about keys version that was used to encrypt card number in cipherCardNumber field. More in Payment API - JWE chapter |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
POST /client/payments/moto/auth HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 555
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "ac8dbfc0-967a-4867-8978-896cdbfb6bc1",
"requestUuid" : "421f7eb5-b1cb-46d8-9662-2b42e6a1b3c9",
"amount" : 1000,
"currency" : "USD",
"cardId" : 1906455,
"cvc2" : "123",
"motoType" : "CVC",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"province" : "NY",
"postalCode" : "24-110"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
amount |
Number |
@Must be at least 100, @Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
cvc2 |
String |
@Length must be 3 characters, @Must not be null when MO/TO CVC @Must match regular expression: \d+ |
Cardholder’s card cvc2. Required only when moto verification type (motoType) is set to CVC value |
cardId |
Number |
@Must not be null, @Numeric |
DataCenter card id. Required to obtain card information data from DataCenter such as (cardNumber, expiryDate, firstName, lastName, email) |
motoType |
String |
@Must not be null |
Allows to switch between CVC and AVS (Address Verification) methods of authentication |
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
cipherCardNumber |
String |
@Optional |
Cipher card number. More in Payment API - JWE chapter |
keysVersion |
Number |
@Optional |
Field informs about keys version that was used to encrypt card number in cipherCardNumber field. More in Payment API - JWE chapter |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
6.5.2. Response
Response status
Status | Description |
---|---|
|
Returned when transaction was successfully authorized. |
|
STATUS: E8000 - Returned when request is incorrect, required fields are missing or the values are not valid. |
|
STATUS: E8002 - Returned when you are the problem with authorized to your PSP. |
|
STATUS: E8001 - Returned when server understood the request but refuses to authorize it. |
|
STATUS: E0122 - Returned when merchant is not existing. STATUS: E0132 - Returned when terminal is not existing. STATUS: E0135 - Returned when terminal for merchant not exist or all of them are inactive. STATUS: E0137 - Returned when there is not terminal marked as default STATUS: E06003 - Returned when DataCenter card was not found. |
|
STATUS: E0150 - Returned when transaction is rejected. STATUS: E0151 - Returned when transaction is rejected, because currency is not supported. STATUS: E0152 - Returned when transaction is rejected, because issuer is not supported. STATUS: E01580 - Returned when transaction is rejected, because DataCenter card was expired. STATUS: E0159 - Returned when transaction is rejected, because restricted transaction amount has occurred STATUS: E01596 - Returned when transaction is rejected, because terminal has blocked transaction with card issued in restricted country STATUS: E01601 - Returned when transaction is rejected, because terminal is blocked for provider STATUS: E01602 - Transaction rejected, geographic scope is not permitted for this transaction STATUS: E01607 - Transaction rejected, internal server error during authorization request generation STATUS: E0200 - Returned when transaction is rejected, because card is blocked in Fenige System STATUS: E0201 - Returned when transaction is rejected, because BIN is blocked in Fenige System STATUS: E0202 - Returned when transaction is rejected, because Terminal is blocked in Fenige System STATUS: E0204 - Returned when transaction is rejected, because user’s personal data was found on AML (sanctions) list STATUS: E0205 - Returned when transaction is rejected, because Bank is blocked in Fenige System STATUS: E0206 - Returned when transaction is rejected, because to many reject transactions and card is blocked STATUS: E0207 - Returned when transaction is rejected, bacause to many attempts declined and card is blocked STATUS: E0208 - Transaction rejected, second transaction with merchant advice code 03 or 21 within 30 days STATUS: E0209 - Returned when sender or receiver name contains fraudulent phrase STATUS: E0210 - Returned when sender has suspicious name STATUS: E11000 - Returned when transaction processing time set by terminal was exceeded |
|
STATUS: E0153 - Returned when transaction is declined, by problem with MIP connection. STATUS: E01599 - Transaction declined, processing timeout. STATUS: E0142 - Returned when commission configuration is not added for terminal. STATUS: E0190 - Returned when currency rate is invalid. STATUS: E9000 - Returned when reason is unknown. STATUS: E9010 - Returned when is error DataCenter connection. |
|
STATUS: E9001 - Returned when is error acquirer connection. |
{
"requestUuid" : "a671663e-bb4a-402f-9d87-3838fa109d15",
"transactionStatus" : "APPROVED",
"responseCode" : "CODE_00",
"status" : "S0002",
"message" : "Success transaction",
"httpStatus" : "OK"
}
Path | Type | Description |
---|---|---|
|
|
Request unique uuid in system |
|
|
Transaction status |
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Response code |
HTTP/1.1 400 Bad Request
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:11:11 GMT
Connection: close
Content-Length: 485
{
"errors" : {
"expiryDate" : [ "invalid card format expiration date" ],
"firstName" : [ "must not be null", "must not be blank" ],
"lastName" : [ "must not be blank", "must not be null" ],
"amount" : [ "must not be null" ],
"merchantUuid" : [ "must not be null" ],
"requestUuid" : [ "must not be null" ],
"currency" : [ "must not be null" ]
},
"status" : "E8000",
"httpStatus" : "BAD_REQUEST",
"traceId" : "4ad3b22d-c671-4b0e-8536-3930b69daa61"
}
HTTP/1.1 400 Bad Request
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:11:01 GMT
Connection: close
Content-Length: 170
{
"errors" : {
"motoType" : [ "must not be null" ]
},
"status" : "E8000",
"httpStatus" : "BAD_REQUEST",
"traceId" : "6f1ed420-1f6f-4259-9fc8-1602b3108fb1"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 400 Bad Request
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:11:11 GMT
Connection: close
Content-Length: 679
{
"errors" : {
"expiryDate" : [ "Card id was provided, expiryDate is obtained from data center card: 1906455" ],
"lastName" : [ "Card id was provided, lastName is obtained from data center card: 1906455" ],
"firstName" : [ "Card id was provided, firstName is obtained from data center card: 1906455" ],
"cardId" : [ "Please provide cardId for DATACENTER transaction or fields: cardNumber, expiryDate, firstName, lastName for PLAIN transaction" ],
"cardNumber" : [ "Card id was provided, cardNumber is obtained from data center card: 1906455" ]
},
"status" : "E8000",
"httpStatus" : "BAD_REQUEST",
"traceId" : "8cc7a40d-0333-4e81-9c20-53605053ad8b"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic realm="Realm"
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 141
Date: Mon, 25 Sep 2023 11:11:11 GMT
{
"status" : "E8002",
"message" : "Unauthorized",
"httpStatus" : "UNAUTHORIZED",
"traceId" : "137b4d26-cede-4575-b117-1e949e784e36"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 403 Forbidden
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 135
Date: Mon, 25 Sep 2023 11:11:13 GMT
{
"status" : "E8001",
"message" : "Forbidden",
"httpStatus" : "FORBIDDEN",
"traceId" : "4595c839-13ca-48c0-90e8-2512f9e24e2e"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 146
{
"status" : "E0122",
"message" : "Merchant not exists.",
"httpStatus" : "NOT_FOUND",
"traceId" : "cf671aa6-a684-4a66-8f2d-24a99d466899"
}
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 146
{
"status" : "E0132",
"message" : "Terminal not exists.",
"httpStatus" : "NOT_FOUND",
"traceId" : "0e3e023e-14dd-4161-9cc4-615f899ab794"
}
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 159
{
"status" : "E0135",
"message" : "Terminals for merchant not exists",
"httpStatus" : "NOT_FOUND",
"traceId" : "45d84472-4cf9-4d4c-b1c5-0147eeb66faf"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 163
{
"status" : "E0137",
"message" : "Default terminal not exist",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "538815db-2016-4ca5-a430-dbdfe9d018ad"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 246
{
"requestUuid" : "62fb77f4-974a-4b7b-b34a-7c76ce9f2508",
"transactionStatus" : "REJECTED",
"status" : "E06003",
"message" : "Datacenter card not found",
"httpStatus" : "NOT_FOUND",
"traceId" : "42e77860-f3d3-4576-b427-af023359f483"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 251
{
"requestUuid" : "b2b2a9e4-8781-45ab-a7c3-dad3477e6a57",
"transactionStatus" : "REJECTED",
"status" : "E0150",
"message" : "Transaction rejected",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "cef66f9c-ecc9-4332-92d6-628f965ba7d1"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 275
{
"requestUuid" : "a437a759-7140-4442-b886-1c319480e9cc",
"transactionStatus" : "REJECTED",
"status" : "E0151",
"message" : "Transaction rejected, currency not supported",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "f9598156-3156-4502-a1d5-fc3eb5fe8185"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 278
{
"requestUuid" : "e9da552b-d921-4c91-b8fb-abed338cb644",
"transactionStatus" : "REJECTED",
"status" : "E0152",
"message" : "Transaction rejected, issuer card not supported",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "d08790f3-a384-438d-8970-43e9b74e75e6"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 295
{
"requestUuid" : "4fc128e7-5d17-4a9b-83d8-e2daef1d4df9",
"transactionStatus" : "REJECTED",
"status" : "E0159",
"message" : "Transaction rejected, restricted transaction amount has occurred",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "55f93964-609d-466b-91fd-ea6651ba5a88"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 270
{
"requestUuid" : "bebf0399-19ff-4d85-b5d9-ab66f9aae69f",
"transactionStatus" : "REJECTED",
"status" : "E01580",
"message" : "Transaction rejected. Card is expired.",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "5299f5eb-b2dd-4241-96b7-da478eee625b"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 267
{
"requestUuid" : "3ae36bda-f000-4bf5-b2c6-aabd1bab1866",
"transactionStatus" : "REJECTED",
"status" : "E0201",
"message" : "Transaction rejected, bin is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "cb2e2869-5ef4-40f2-bcdc-074c5e1ab4c2"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 272
{
"requestUuid" : "7e097de6-6786-4510-9b00-99f657880f01",
"transactionStatus" : "REJECTED",
"status" : "E0202",
"message" : "Transaction rejected, terminal is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "231cff55-be46-4412-96c8-3247689aa7fe"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 272
{
"requestUuid" : "66cf4a92-8cc8-48b9-989d-2d6512f25a64",
"transactionStatus" : "REJECTED",
"status" : "E0204",
"message" : "Transaction rejected, user is on aml list",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "bd6d07a3-d5b8-4769-81f7-4d737be92dcc"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 268
{
"requestUuid" : "8cd04a81-ca5d-4ff4-b8bb-93002a45acae",
"transactionStatus" : "REJECTED",
"status" : "E0205",
"message" : "Transaction rejected, bank is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "2e2b156f-b7e5-4a9b-ac60-eefab823caaa"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 300
{
"requestUuid" : "89ec0012-bae4-476a-9e6b-31f04a07781b",
"transactionStatus" : "REJECTED",
"status" : "E0206",
"message" : "Transaction rejected, to many reject transactions and card is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "f4f01cbc-ab6a-4465-9972-f8a62d9de3a6"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 298
{
"requestUuid" : "334b8bba-5d2a-469f-9e8d-5d916d921d3b",
"transactionStatus" : "REJECTED",
"status" : "E0207",
"message" : "Transaction rejected, to many attempts declined and card is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "e5a80813-9137-4cd3-a059-27e9533e7cd3"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 321
{
"requestUuid" : "7913e5e1-4edd-468c-902b-124cd6d2fc86",
"transactionStatus" : "REJECTED",
"status" : "E0208",
"message" : "Transaction rejected, second transaction with merchant advice code 03 or 21 within 30 days",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "169c8549-4ae7-4251-b3d4-516d56ae3b73"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 292
{
"requestUuid" : "ed7eeeb7-b06c-47d6-9e1a-eaef68f86bbf",
"transactionStatus" : "REJECTED",
"status" : "E0209",
"message" : "Transaction rejected, sender name contains fraudulent phrase.",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "91d96a8a-470c-42bb-a0d7-358d61cdff07"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 276
{
"requestUuid" : "f964b50e-5ce7-4d3e-a596-c92be96df428",
"transactionStatus" : "REJECTED",
"status" : "E0210",
"message" : "Transaction rejected, suspicious sender name.",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "d72fb2a4-d482-425f-a43a-a38facecf344"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 315
{
"requestUuid" : "b1d61203-82ac-40b4-9101-e02a81f91bad",
"transactionStatus" : "REJECTED",
"status" : "E01607",
"message" : "Transaction rejected, internal server error during authorization request generation",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "63f44911-5740-4e12-ad1f-bbba388a0a51"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 321
{
"requestUuid" : "fe1a6267-ac9a-4453-af75-f2c205526d73",
"transactionStatus" : "REJECTED",
"status" : "E01596",
"message" : "Transaction rejected, terminal blocks transactions with card issued in given card country",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "ece517ad-6e61-4896-9bef-de1564be744a"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 381
{
"requestUuid" : "694ed51c-05b2-4088-9f59-6702541e0f3c",
"transactionStatus" : "REJECTED",
"cardBlockadeAdditionalData" : {
"blockType" : "TEMP",
"blockedUntil" : "2022-11-01T12:51:32.000"
},
"status" : "E0200",
"message" : "Transaction rejected, card is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "fe6babac-8d8d-4b40-966e-3a9d04d1ddb5"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
|
|
Block type. Possible values: TEMP - temporary, PERMANENT - permanent. |
|
|
Date until card will be blocked in yyyy-MM-ddThh-mm-ss.SSS format. |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 286
{
"requestUuid" : "b358cd55-3af8-45f6-b74d-09a377a45e00",
"transactionStatus" : "REJECTED",
"status" : "E01601",
"message" : "Transaction rejected, terminal is blocked for provider",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "d00b6d7a-e493-425f-92d0-5c774b0e1251"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 308
{
"requestUuid" : "14ccfe81-1ad7-4c95-a518-3bf2545fcefb",
"transactionStatus" : "REJECTED",
"status" : "E01602",
"message" : "Transaction rejected, geographic scope is not permitted for this transaction",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "987245a7-6ea8-4bb4-bd3a-43198113a342"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 183
{
"status" : "E0142",
"message" : "Commission configuration not add for terminal",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "9f49d2e7-3bd2-4ce2-9276-49856b4d641d"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 280
{
"requestUuid" : "8e5e1243-d146-435d-b53d-d5a2ecd9f718",
"transactionStatus" : "PENDING",
"status" : "E0153",
"message" : "Transaction declined, problem with MIP connection",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "021377cb-3070-4327-a508-71559e4572e6"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 273
{
"requestUuid" : "b3250b19-4e6b-4d14-a271-03f33dc9686c",
"transactionStatus" : "DECLINED",
"status" : "E01599",
"message" : "Transaction declined, processing timeout",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "a4a3c613-8972-451b-bd4e-8cead0e3f3dd"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 166
{
"status" : "E0190",
"message" : "Failed to get currency rates",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "f982ef3a-ce31-4891-8cf0-5027e6ad56fd"
}
HTTP/1.1 500 Internal Server Error
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:19 GMT
Connection: close
Content-Length: 150
{
"status" : "E9000",
"message" : "Domain error",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "3c268696-8733-4d27-a65d-64f672197318"
}
Path | Type | Description |
---|---|---|
|
|
Message for response code from Fenige system |
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
UUID that helps to identify request in system |
HTTP/1.1 503 Service Unavailable
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:05 GMT
Connection: close
Content-Length: 161
{
"status" : "E9001",
"message" : "Error acquirer connection",
"httpStatus" : "SERVICE_UNAVAILABLE",
"traceId" : "da762af3-a5fc-4c96-8378-c3b5b2a0d9b1"
}
HTTP/1.1 503 Service Unavailable
Content-Type: application/json
Content-Length: 250
{
"requestUuid" : "0e762454-b16c-43cd-8b10-269a7d40ca6b",
"transactionStatus" : "DECLINED",
"status" : "E9002",
"message" : "Error mpi connection",
"httpStatus" : "SERVICE_UNAVAILABLE",
"traceId" : "6775d80c-292c-407c-81ca-f176ca9ffa8b"
}
HTTP/1.1 503 Service Unavailable
Content-Type: application/json
Content-Length: 258
{
"requestUuid" : "75a01ad7-4b0b-496c-b5a6-b11cfe179321",
"transactionStatus" : "REJECTED",
"status" : "E9010",
"message" : "Error data center connection",
"httpStatus" : "SERVICE_UNAVAILABLE",
"traceId" : "8be63987-c139-4b2b-ae19-e5f8b2b902dc"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
6.6. Token payment
The token payment method is a solution that allows merchant customers to make payments using mobile applications. The merchant uses a card number in the form of a token (Apple pay) and dynamic cryptographic data to authenticate the cardholder. The merchant receives this data from the token requestor it uses. Then Fenige authorizes the transaction in Mastercard or VISA and depending on the result, returns the corresponding status to the merchant. An additional option not required is to send an additional authentication in the form of an outside3ds object containing the authentication data for the 3DS version 1.0 or 2.x execution confirmation.
Merchant has the ability to make a payment for goods which causes the cardholder to be debited in the currency of purchase, terminal or card currency based on the parameters provided: currency of transaction, different currency terminals held and currencies supported by the card. The optional terminalUuid field provided during any of the authorisation methods forces the card to be debited in the currency of the terminal specified if the purchase currency is different from the terminal currency a currency conversion will take place.
Google pay - payment with Google pay is a standard ecommerce payment for which you can use the 6.4. Payment method except that there is no CVC2 field |
This endpoint is idempotent so if you execute more than one requests with the same data even at the same time, only first registered transaction will be processed further. In response, we receive transaction status.
From January 2021, there is an internal functionality to restrict access for the PSP to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The PSP will be informed about each access restriction action. |
When performing authorization, remember that there are currencies with different number of decimal places. For example: VND has no pennies and KWD has three decimal places. Please take this into account in the Amout field. For more information on other currencies, see ISO 4217. |

6.6.1. Request
POST /client/payments/token/auth HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 1117
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "a304b47c-f892-4918-bac9-7a265cd722ef",
"terminalUuid" : "be73583e-ef7c-4d1e-8a15-af90b334b892",
"requestUuid" : "0bdc9530-3134-4ad6-8284-e8ee8508523f",
"firstName" : "user",
"lastName" : "testUser",
"amount" : 100,
"currency" : "USD",
"tokenPan" : "5127482301411937126",
"authMethod" : "CRYPTOGRAM_3DS",
"tokenType" : "GOOGLE_PAY",
"expiryDate" : "11/26",
"email" : "test@fenige.pl",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"terminalLocation" : "HOME",
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"paymentData" : {
"onlinePaymentCryptogram" : "/0OL1zEABL+gk70RYJ8lMAABAAA=",
"eciIndicator" : "02"
},
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"eci" : "02",
"authenticationStatus" : "Y",
"transactionXId" : "d543820d-683e-4589-86d9-6c9e40db4b53"
},
"receiverAmount" : 90,
"countryOfResidence" : "PL",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"province" : "NY",
"postalCode" : "24-110"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
amount |
Number |
@Must be at least 100, @Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
firstName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
First name of cardholder |
lastName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
Last name of cardholder |
expiryDate |
String |
@Must not be blank, @Must not be null |
Expiration date of card mm/yy |
String |
Optional field, @Length(min = 1, max = 128) |
Cardholder’s email |
|
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
tokenPan |
String |
@Must be not null, @Must be not blank, @Length must be between 16 and 19 |
Token that is used in place of sender’s card number (PAN). Token form payment gateway or native apps from google, apple etc |
terminalLocation |
String |
@Must not be null |
Location of terminal - value must be set as |
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
paymentData |
Object |
Required payment tokenization data object. Not required when tokenType = 'GOOGLE_PAY' and authMethod = 'PAN_ONLY'. |
|
paymentData.onlinePaymentCryptogram |
String |
Payment secure cryptogram obtained during merchant card tokenization in mobile app (TAVV in GOOGLE_PAY case). Base64 encoded payment crypto value. |
|
paymentData.eciIndicator |
String |
@Must match 01 or 02 or 05 or 06 |
Eci value returned only for tokens on the Visa card network. The value should be passed by merchant if present with payment cryptogram. Optional value. If tokenType = 'GOOGLE_PAY' and authMethod = 'CRYPTOGRAM_3DS' and provider is 'VISA' then this field is required. Possible values for VISA are 05, 06. |
outside3ds |
Object |
There are outside 3ds data authorization that have been send to our API |
|
outside3ds.cavv |
String |
Cardholder Authentication Verification Value |
|
outside3ds.transactionXId |
String |
The transactionXId is the field that defines the 3DS version.The presence of this field in the HTTP request specifies that the transaction will be processed with 3DS 2.x.TransactionXId can be obtained by executing the /authentication method. |
|
outside3ds.cavvAlgorithm |
String |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm |
|
outside3ds.eci |
String |
@Length must be between 1 and 2 inclusive, @Must match 00 or 01 or 02 or 05 or 06 or 07, @Must not be null |
Electronic Commerce Indicator: 5 (Visa) or 2 (SecureCode) - The cardholder was successfully authenticated. 6 (Visa) or 1 (SecureCode) - Authentication was attempted, but the cardholder was not enrolled. More info. |
outside3ds.authenticationStatus |
String |
@Must match Y or A or U, @Must not be null |
Authentication status: Y - (Full Authentication) - The customer was successfully authenticated. A - (Successful Attempted Authentication) - Authentication was not available, but functionality was available to generate a proof of authentication attempt. U - (Technical or other problem) - No liability shift, consider whether to proceed with the transaction |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
tokenType |
String |
@Optional |
Token used - value may be set as |
authMethod |
String |
@Optional |
Required only if tokenType is 'GOOGLE_PAY'. Type of token transaction authorization - value may be set as If authMethod is 'CRYPTOGRAM_3DS' then paymentData is required and outside3ds is optional. If authMethod is 'PAN_ONLY' then outside3ds is required and there is no paymentData. |
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
terminalUuid |
String |
Terminals’s unique uuid in system |
POST /client/payments/token/auth HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 1054
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "a304b47c-f892-4918-bac9-7a265cd722ef",
"terminalUuid" : "be73583e-ef7c-4d1e-8a15-af90b334b892",
"requestUuid" : "0bdc9530-3134-4ad6-8284-e8ee8508523f",
"firstName" : "user",
"lastName" : "testUser",
"amount" : 100,
"currency" : "USD",
"authMethod" : "CRYPTOGRAM_3DS",
"tokenType" : "GOOGLE_PAY",
"tokenPan" : "5127482301411937126",
"expiryDate" : "11/26",
"email" : "test@fenige.pl",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"terminalLocation" : "HOME",
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"paymentData" : {
"onlinePaymentCryptogram" : "/0OL1zEABL+gk70RYJ8lMAABAAA=",
"eciIndicator" : "02"
},
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"eci" : "02",
"authenticationStatus" : "Y"
},
"receiverAmount" : 90,
"countryOfResidence" : "PL",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"province" : "NY",
"postalCode" : "24-110"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
amount |
Number |
@Must be at least 100, @Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
firstName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
First name of cardholder |
lastName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
Last name of cardholder |
expiryDate |
String |
@Must not be blank, @Must not be null |
Expiration date of card mm/yy |
String |
Optional field, @Length(min = 1, max = 128) |
Cardholder’s email |
|
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
tokenPan |
String |
@Must be not null, @Must be not blank, @Length must be between 16 and 19 |
Token that is used in place of sender’s card number (PAN). Token form payment gateway or native apps from google, apple etc |
terminalLocation |
String |
@Must not be null |
Location of terminal - value must be set as |
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
paymentData |
Object |
Required payment tokenization data object. Not required when tokenType = 'GOOGLE_PAY' and authMethod = 'PAN_ONLY'. |
|
paymentData.onlinePaymentCryptogram |
String |
Payment secure cryptogram obtained during merchant card tokenization in mobile app (TAVV in GOOGLE_PAY case). Base64 encoded payment crypto value. |
|
paymentData.eciIndicator |
String |
@Must match 01 or 02 or 05 or 06 |
Eci value returned only for tokens on the Visa card network. The value should be passed by merchant if present with payment cryptogram. Optional value. If tokenType = 'GOOGLE_PAY' and authMethod = 'CRYPTOGRAM_3DS' and provider is 'VISA' then this field is required. Possible values for VISA are 05, 06. |
outside3ds |
Object |
There are outside 3ds data authorization that have been send to our API |
|
outside3ds.cavv |
String |
Cardholder Authentication Verification Value. |
|
outside3ds.cavvAlgorithm |
String |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm |
|
outside3ds.eci |
String |
@Length must be between 1 and 2 inclusive, @Must match 00 or 01 or 02 or 05 or 06 or 07, @Must not be null |
Electronic Commerce Indicator: 5 (Visa) or 2 (SecureCode) - The cardholder was successfully authenticated. 6 (Visa) or 1 (SecureCode) - Authentication was attempted, but the cardholder was not enrolled. More info. |
outside3ds.authenticationStatus |
String |
@Must match Y or A or U, @Must not be null |
Authentication status: Y - (Full Authentication) - The customer was successfully authenticated. A - (Successful Attempted Authentication) - Authentication was not available, but functionality was available to generate a proof of authentication attempt. U - (Technical or other problem) - No liability shift, consider whether to proceed with the transaction |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
tokenType |
String |
@Optional |
Token used - value may be set as |
authMethod |
String |
@Optional |
Required only if tokenType is 'GOOGLE_PAY'. Type of token transaction authorization - value may be set as If authMethod is 'CRYPTOGRAM_3DS' then paymentData is required and outside3ds is optional. If authMethod is 'PAN_ONLY' then outside3ds is required and there is no paymentData. |
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
terminalUuid |
String |
Terminals’s unique uuid in system |
POST /client/payments/token/auth HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 847
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "45e81e28-6104-48f2-8b04-f5fd46daaa1a",
"requestUuid" : "0bdc9530-3134-4ad6-8284-e8ee8508523f",
"firstName" : "user",
"lastName" : "testUser",
"amount" : 100,
"currency" : "USD",
"authMethod" : "CRYPTOGRAM_3DS",
"tokenType" : "GOOGLE_PAY",
"tokenPan" : "5127482301411937126",
"expiryDate" : "11/26",
"email" : "test@fenige.pl",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"terminalLocation" : "HOME",
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"paymentData" : {
"onlinePaymentCryptogram" : "/0OL1zEABL+gk70RYJ8lMAABAAA=",
"eciIndicator" : "02"
},
"receiverAmount" : 90,
"countryOfResidence" : "PL",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"province" : "NY",
"postalCode" : "24-110"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
amount |
Number |
@Must be at least 100, @Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
firstName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
First name of cardholder |
lastName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
Last name of cardholder |
expiryDate |
String |
@Must not be blank, @Must not be null |
Expiration date of card mm/yy |
String |
Optional field, @Length(min = 1, max = 128) |
Cardholder’s email |
|
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
tokenPan |
String |
@Must be not null, @Must be not blank, @Length must be between 16 and 19 |
Token that is used in place of sender’s card number (PAN). Token form payment gateway or native apps from google, apple etc |
terminalLocation |
String |
@Must not be null |
Location of terminal - value must be set as |
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
paymentData |
Object |
Required payment tokenization data object. Not required when tokenType = 'GOOGLE_PAY' and authMethod = 'PAN_ONLY'. |
|
paymentData.onlinePaymentCryptogram |
String |
Payment secure cryptogram obtained during merchant card tokenization in mobile app (TAVV in GOOGLE_PAY case). Base64 encoded payment crypto value. |
|
paymentData.eciIndicator |
String |
@Must match 01 or 02 or 05 or 06 |
Eci value returned only for tokens on the Visa card network. The value should be passed by merchant if present with payment cryptogram. Optional value. If tokenType = 'GOOGLE_PAY' and authMethod = 'CRYPTOGRAM_3DS' and provider is 'VISA' then this field is required. Possible values for VISA are 05, 06. |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
tokenType |
String |
@Optional |
Token used - value may be set as |
authMethod |
String |
@Optional |
Required only if tokenType is 'GOOGLE_PAY'. Type of token transaction authorization - value may be set as If authMethod is 'CRYPTOGRAM_3DS' then paymentData is required and outside3ds is optional. If authMethod is 'PAN_ONLY' then outside3ds is required and there is no paymentData. |
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
POST /client/payments/token/auth HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 906
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "a304b47c-f892-4918-bac9-7a265cd722ef",
"terminalUuid" : "be73583e-ef7c-4d1e-8a15-af90b334b892",
"requestUuid" : "0bdc9530-3134-4ad6-8284-e8ee8508523f",
"firstName" : "user",
"lastName" : "testUser",
"amount" : 100,
"currency" : "USD",
"authMethod" : "CRYPTOGRAM_3DS",
"tokenType" : "GOOGLE_PAY",
"tokenPan" : "5127482301411937126",
"expiryDate" : "11/26",
"email" : "test@fenige.pl",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"terminalLocation" : "HOME",
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"paymentData" : {
"onlinePaymentCryptogram" : "/0OL1zEABL+gk70RYJ8lMAABAAA=",
"eciIndicator" : "02"
},
"receiverAmount" : 90,
"countryOfResidence" : "PL",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"province" : "NY",
"postalCode" : "24-110"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
amount |
Number |
@Must be at least 100, @Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
firstName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
First name of cardholder |
lastName |
String |
@Length must be between 2 and 35, @Must match the regular expression [0-9]+$, @Must not be blank, @Must not be null |
Last name of cardholder |
expiryDate |
String |
@Must not be blank, @Must not be null |
Expiration date of card mm/yy |
String |
Optional field, @Length(min = 1, max = 128) |
Cardholder’s email |
|
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
tokenPan |
String |
@Must be not null, @Must be not blank, @Length must be between 16 and 19 |
Token that is used in place of sender’s card number (PAN). Token form payment gateway or native apps from google, apple etc |
terminalLocation |
String |
@Must not be null |
Location of terminal - value must be set as |
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
paymentData |
Object |
Required payment tokenization data object. Not required when tokenType = 'GOOGLE_PAY' and authMethod = 'PAN_ONLY'. |
|
paymentData.onlinePaymentCryptogram |
String |
Payment secure cryptogram obtained during merchant card tokenization in mobile app (TAVV in GOOGLE_PAY case). Base64 encoded payment crypto value. |
|
paymentData.eciIndicator |
String |
@Must match 01 or 02 or 05 or 06 |
Eci value returned only for tokens on the Visa card network. The value should be passed by merchant if present with payment cryptogram. Optional value. If tokenType = 'GOOGLE_PAY' and authMethod = 'CRYPTOGRAM_3DS' and provider is 'VISA' then this field is required. Possible values for VISA are 05, 06. |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
tokenType |
String |
@Optional |
Token used - value may be set as |
authMethod |
String |
@Optional |
Required only if tokenType is 'GOOGLE_PAY'. Type of token transaction authorization - value may be set as If authMethod is 'CRYPTOGRAM_3DS' then paymentData is required and outside3ds is optional. If authMethod is 'PAN_ONLY' then outside3ds is required and there is no paymentData. |
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
terminalUuid |
String |
Terminals’s unique uuid in system |
6.6.2. Response
Response status
Status | Description |
---|---|
|
Returned when transaction was successfully authorized with Token. |
|
STATUS: E8000 - Returned when request is incorrect, required fields are missing or the values are not valid. |
|
STATUS: E8002 - Returned when there was a problem with authorization to your PSP. |
|
STATUS: E8001 - Returned when server understood the request but refuses to authorizeToken it. |
|
STATUS: E0122 - Returned when merchant is not existing. STATUS: E0132 - Returned when terminal is not existing. STATUS: E0135 - Returned when terminal for merchant not exist or all of them are inactive. STATUS: E0137 - Returned when there is not terminal marked as default |
|
STATUS: E0150 - Returned when transaction is rejected. STATUS: E0151 - Returned when transaction is rejected, because currency is not supported. STATUS: E0152 - Returned when transaction is rejected, because issuer is not supported. STATUS: E0156 - Returned where terminal used for process transaction do not support 3DS STATUS: E0157 - Returned where card used for process transaction do not support 3DS STATUS: E01583 - Returned when transaction is rejected, because outside3ds object was not provided in transaction request STATUS: E0159 - Returned when transaction is rejected, because restricted transaction amount has occurred STATUS: E01596 - Returned when transaction is rejected, because terminal has blocked transaction with card issued in restricted country STATUS: E01597 - Transaction rejected, 3DS version of terminal are not compatible with 3DS version defined in request. Please contact the sales department STATUS: E01598 - Transaction rejected, ECI value is not available for card provider STATUS: E01600 - Transaction rejected, 3DS 2.X flow invoked for other card number than specified in the request STATUS: E01601 - Returned when transaction is rejected, because terminal is blocked for provider STATUS: E01602 - Transaction rejected, geographic scope is not permitted for this transaction STATUS: E01607 - Transaction rejected, internal server error during authorization request generation STATUS: E0200 - Returned when transaction is rejected, because card is blocked in Fenige System STATUS: E0201 - Returned when transaction is rejected, because BIN is blocked in Fenige System STATUS: E0202 - Returned when transaction is rejected, because Terminal is blocked in Fenige System STATUS: E0203 - Returned when transaction is rejected, because Token is blocked in Fenige System STATUS: E0204 - Returned when transaction is rejected, because user’s personal data was found on AML (sanctions) list STATUS: E0205 - Returned when transaction is rejected, because Bank is blocked in Fenige System STATUS: E0206 - Returned when transaction is rejected, because to many reject transactions and card is blocked STATUS: E0207 - Returned when transaction is rejected, bacause to many attempts declined and card is blocked STATUS: E0208 - Transaction rejected, second transaction with merchant advice code 03 or 21 within 30 days STATUS: E0209 - Returned when sender or receiver name contains fraudulent phrase STATUS: E0210 - Returned when sender has suspicious name STATUS: E11000 - Returned when transaction processing time set by terminal was exceeded |
|
STATUS: E0153 - Returned when transaction is declined, by problem with MIP connection. STATUS: E01599 - Transaction declined, processing timeout. STATUS: E0142 - Returned when commission configuration is not added for terminal. STATUS: E0190 - Returned when currency rate is invalid. STATUS: E9000 - Returned when reason is unknown. STATUS: E9008 - Returned when mpi received 3ds initialize failed. |
|
STATUS: E9001 - Returned when is error acquirer connection. STATUS: E9002 - Returned when is error mpi connection. |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 208
{
"requestUuid" : "912c393f-3499-488f-a202-9dfd452b3a90",
"transactionStatus" : "APPROVED",
"responseCode" : "CODE_00",
"status" : "S0002",
"message" : "Success transaction",
"httpStatus" : "OK"
}
Path | Type | Description |
---|---|---|
|
|
Request unique uuid in system |
|
|
Transaction status |
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Response code |
HTTP/1.1 400 Bad Request
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:10:35 GMT
Connection: close
Content-Length: 575
{
"errors" : {
"expiryDate" : [ "must not be null", "invalid card format expiration date", "must not be blank" ],
"lastName" : [ "must not be null", "must not be blank" ],
"firstName" : [ "must not be null", "must not be blank" ],
"amount" : [ "must not be null" ],
"merchantUuid" : [ "must not be null" ],
"terminalLocation" : [ "must not be null" ],
"requestUuid" : [ "must not be null" ],
"currency" : [ "must not be null" ]
},
"status" : "E8000",
"httpStatus" : "BAD_REQUEST",
"traceId" : "d94f5cb9-2ebb-4e64-bd46-004b5f468c1f"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic realm="Realm"
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 141
Date: Mon, 25 Sep 2023 11:10:35 GMT
{
"status" : "E8002",
"message" : "Unauthorized",
"httpStatus" : "UNAUTHORIZED",
"traceId" : "4b683c5e-e8a1-448a-b0bf-769c5ed0336c"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 403 Forbidden
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 135
Date: Mon, 25 Sep 2023 11:11:13 GMT
{
"status" : "E8001",
"message" : "Forbidden",
"httpStatus" : "FORBIDDEN",
"traceId" : "4595c839-13ca-48c0-90e8-2512f9e24e2e"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 146
{
"status" : "E0122",
"message" : "Merchant not exists.",
"httpStatus" : "NOT_FOUND",
"traceId" : "9cb01ee2-222c-40ae-8437-d4da75a28919"
}
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 159
{
"status" : "E0135",
"message" : "Terminals for merchant not exists",
"httpStatus" : "NOT_FOUND",
"traceId" : "cc603592-6395-44cb-b412-fe1516c35d11"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 251
{
"requestUuid" : "897bc0c0-a22f-4fa5-bc9b-c9e82adf8b3b",
"transactionStatus" : "REJECTED",
"status" : "E0150",
"message" : "Transaction rejected",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "ebf88433-c07a-483c-997b-6c0d6c59906c"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 275
{
"requestUuid" : "6e2758a1-a6aa-4d67-82ae-22b7b0bd78dc",
"transactionStatus" : "REJECTED",
"status" : "E0151",
"message" : "Transaction rejected, currency not supported",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "6a0a3e65-e301-4dd8-8b11-cb13c71d4fbc"
}
E01585 .HTTP Response - STATUS: E0152
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 278
{
"requestUuid" : "2ac91b37-4b6e-46c9-976c-0e7453eb8619",
"transactionStatus" : "REJECTED",
"status" : "E0152",
"message" : "Transaction rejected, issuer card not supported",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "8053b646-5be4-4a1f-af07-fdada1bbf7cd"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 185
{
"status" : "E0156",
"message" : "Transaction rejected, terminal not supported 3ds",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "ee7922ab-e6c9-4495-8c40-fdf2af516e90"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 181
{
"status" : "E0157",
"message" : "Transaction rejected, card not supported 3ds",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "8af9481a-a780-439c-b784-149c243b05cf"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 295
{
"requestUuid" : "4fc128e7-5d17-4a9b-83d8-e2daef1d4df9",
"transactionStatus" : "REJECTED",
"status" : "E0159",
"message" : "Transaction rejected, restricted transaction amount has occurred",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "55f93964-609d-466b-91fd-ea6651ba5a88"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 273
{
"requestUuid" : "6259b221-75fb-487b-80ee-4f589198aa2e",
"transactionStatus" : "DECLINED",
"status" : "E01599",
"message" : "Transaction declined, processing timeout",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "c91c7816-745c-44b6-a746-ef5b260c673b"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 267
{
"requestUuid" : "66a1555b-c6c9-4a5a-b4e3-98a608126244",
"transactionStatus" : "REJECTED",
"status" : "E0201",
"message" : "Transaction rejected, bin is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "48cedb64-6ccc-482e-ac36-34d305255576"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 272
{
"requestUuid" : "4ed83438-7758-47b0-a28d-91234022013c",
"transactionStatus" : "REJECTED",
"status" : "E0202",
"message" : "Transaction rejected, terminal is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "a794ddfc-7883-4d12-96b5-7bae9328e891"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 269
{
"requestUuid" : "c6005949-87a4-457f-bca9-37725dc558ff",
"transactionStatus" : "REJECTED",
"status" : "E0203",
"message" : "Transaction rejected, token is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "7e97511b-5b44-4f8c-b646-30f4f6b2e7b9"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 272
{
"requestUuid" : "98ceab47-52b0-4f98-a67d-cc5038679bbc",
"transactionStatus" : "REJECTED",
"status" : "E0204",
"message" : "Transaction rejected, user is on aml list",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "503dc537-b096-4d5f-a0a9-dfdcfbb57eb0"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 268
{
"requestUuid" : "5fbb38a1-5261-4432-a1ee-9215f47c2530",
"transactionStatus" : "REJECTED",
"status" : "E0205",
"message" : "Transaction rejected, bank is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "2c39a734-4c5a-413f-8e3f-c17d338edd0e"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 300
{
"requestUuid" : "89ec0012-bae4-476a-9e6b-31f04a07781b",
"transactionStatus" : "REJECTED",
"status" : "E0206",
"message" : "Transaction rejected, to many reject transactions and card is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "f4f01cbc-ab6a-4465-9972-f8a62d9de3a6"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 298
{
"requestUuid" : "334b8bba-5d2a-469f-9e8d-5d916d921d3b",
"transactionStatus" : "REJECTED",
"status" : "E0207",
"message" : "Transaction rejected, to many attempts declined and card is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "e5a80813-9137-4cd3-a059-27e9533e7cd3"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 321
{
"requestUuid" : "7913e5e1-4edd-468c-902b-124cd6d2fc86",
"transactionStatus" : "REJECTED",
"status" : "E0208",
"message" : "Transaction rejected, second transaction with merchant advice code 03 or 21 within 30 days",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "169c8549-4ae7-4251-b3d4-516d56ae3b73"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 292
{
"requestUuid" : "ed7eeeb7-b06c-47d6-9e1a-eaef68f86bbf",
"transactionStatus" : "REJECTED",
"status" : "E0209",
"message" : "Transaction rejected, sender name contains fraudulent phrase.",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "91d96a8a-470c-42bb-a0d7-358d61cdff07"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 276
{
"requestUuid" : "f964b50e-5ce7-4d3e-a596-c92be96df428",
"transactionStatus" : "REJECTED",
"status" : "E0210",
"message" : "Transaction rejected, suspicious sender name.",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "d72fb2a4-d482-425f-a43a-a38facecf344"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 290
{
"requestUuid" : "d7c7450d-9629-4fdb-8c6e-c8498be0f5ea",
"transactionStatus" : "REJECTED",
"status" : "E01583",
"message" : "Transaction rejected. Outside 3ds is required for terminal",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "ef77d4b7-908b-4aa4-9ec6-9f17818dfcd5"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 321
{
"requestUuid" : "fe1a6267-ac9a-4453-af75-f2c205526d73",
"transactionStatus" : "REJECTED",
"status" : "E01596",
"message" : "Transaction rejected, terminal blocks transactions with card issued in given card country",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "ece517ad-6e61-4896-9bef-de1564be744a"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 369
{
"requestUuid" : "078ec5b0-bba5-4259-a272-703dd8703505",
"transactionStatus" : "REJECTED",
"status" : "E01597",
"message" : "Transaction rejected, 3DS version of terminal are not compatible with 3DS version defined in request. Please contact the sales department",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "a48a4aa6-c234-4537-b577-a184c053bef3"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 315
{
"requestUuid" : "b1d61203-82ac-40b4-9101-e02a81f91bad",
"transactionStatus" : "REJECTED",
"status" : "E01607",
"message" : "Transaction rejected, internal server error during authorization request generation",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "63f44911-5740-4e12-ad1f-bbba388a0a51"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 298
{
"requestUuid" : "c99f9d2a-4781-405d-af9a-46c999203ca1",
"transactionStatus" : "REJECTED",
"status" : "E01598",
"message" : "Transaction rejected, ECI value is not available for card provider",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "3841e430-89f9-4d96-9b8c-8d568ad0d78a"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 381
{
"requestUuid" : "b6c0ded7-f68b-46cf-a0e1-f71333007b83",
"transactionStatus" : "REJECTED",
"cardBlockadeAdditionalData" : {
"blockType" : "TEMP",
"blockedUntil" : "2022-11-01T12:51:32.000"
},
"status" : "E0200",
"message" : "Transaction rejected, card is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "56e9aa9a-72bd-4d4d-968c-ef10c9ef9bfe"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
|
|
Block type. Possible values: TEMP - temporary, PERMANENT - permanent. |
|
|
Date until card will be blocked in yyyy-MM-ddThh-mm-ss.SSS format. |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 326
{
"requestUuid" : "66e5353d-b968-4cbe-b13f-c92f6451f311",
"transactionStatus" : "REJECTED",
"status" : "E01584",
"message" : "Transaction rejected, 3DS 2.X flow invoked for other card number than specified in the request",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "8df2980f-e409-4636-8407-2721b82a5ee7"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 286
{
"requestUuid" : "b358cd55-3af8-45f6-b74d-09a377a45e00",
"transactionStatus" : "REJECTED",
"status" : "E01601",
"message" : "Transaction rejected, terminal is blocked for provider",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "d00b6d7a-e493-425f-92d0-5c774b0e1251"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 308
{
"requestUuid" : "14ccfe81-1ad7-4c95-a518-3bf2545fcefb",
"transactionStatus" : "REJECTED",
"status" : "E01602",
"message" : "Transaction rejected, geographic scope is not permitted for this transaction",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "987245a7-6ea8-4bb4-bd3a-43198113a342"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 280
{
"requestUuid" : "fde958ed-c016-4e70-b9c1-e100ff1d9354",
"transactionStatus" : "PENDING",
"status" : "E0153",
"message" : "Transaction declined, problem with MIP connection",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "4bf56df2-34fd-4328-943d-3dfda2956ba1"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 183
{
"status" : "E0142",
"message" : "Commission configuration not add for terminal",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "c7a2cc39-1f97-4b75-8135-6fdbee825dd5"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 166
{
"status" : "E0190",
"message" : "Failed to get currency rates",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "7ac7a25d-7b54-4e97-803c-434a67889c5b"
}
HTTP/1.1 500 Internal Server Error
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:19 GMT
Connection: close
Content-Length: 150
{
"status" : "E9000",
"message" : "Domain error",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "3c268696-8733-4d27-a65d-64f672197318"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 265
{
"requestUuid" : "cef6b458-35e1-4336-9987-ab15ea505959",
"transactionStatus" : "DECLINED",
"status" : "E9008",
"message" : "Error mpi - 3ds initialize failed",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "c99b4f38-77e6-4819-8c82-5900f00076de"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 503 Service Unavailable
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:05 GMT
Connection: close
Content-Length: 161
{
"status" : "E9001",
"message" : "Error acquirer connection",
"httpStatus" : "SERVICE_UNAVAILABLE",
"traceId" : "da762af3-a5fc-4c96-8378-c3b5b2a0d9b1"
}
HTTP/1.1 503 Service Unavailable
Content-Type: application/json
Content-Length: 250
{
"requestUuid" : "b17e9ef0-c90b-4a33-ba54-604cc83cac84",
"transactionStatus" : "DECLINED",
"status" : "E9002",
"message" : "Error mpi connection",
"httpStatus" : "SERVICE_UNAVAILABLE",
"traceId" : "97735849-b2e2-4b01-8da5-142d07042ced"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
6.7. CoF payment
A CoF (credential on file transaction) is a transaction where a cardholder authorizes a merchant to store account information such as (PAN and expiration date, and the cardholder subsequently authorizes that same merchant to bill the cardholder’s stored account. The method is used to charge the cardholder with no need to collect account data (PAN, exp date) from merchant at every transaction. Using this method, we can authorize and process entire transaction using stored payment details. CoF supports both 3DS and without 3DS transactions. How the transaction will be initiated depends on the terminal settings (look at 'is3dsEnable' field). This endpoint is idempotent so if you execute more than one requests with the same data even at the same time, only first registered transaction will be processed further. In response, we receive transaction status.
The cof transaction consists of two parts: initial and subsequent, which are discussed in detail below. Please see detailed CoF transaction flow described on below listings.
Merchant has the ability to make a payment for goods which causes the cardholder to be debited in the currency of purchase, terminal or card currency based on the parameters provided: currency of transaction, different currency terminals held and currencies supported by the card. The optional terminalUuid field provided during any of the authorisation methods forces the card to be debited in the currency of the terminal specified if the purchase currency is different from the terminal currency a currency conversion will take place.
The Fenige Payment API methods optionally allows merchants to store card data and sensitive personal data in order to allow performing subsequent transactions. If merchant decides to use DataCenter transaction flow then is required to provide the card id of the card previously stored in the Fenige DataCenter, from which card the relevant required parameters will be downloaded and used for authorization. Card data and sensitive personal data according to the Fenige API specification are: cardNumber, expiryDate, firstName, lastName and email. All card data are stored securely on Fenige DataCenter servers in accordance with applicable security requirements.
From January 2021, there is an internal functionality to restrict access for the PSP to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The PSP will be informed about each access restriction action. |
When performing authorization, remember that there are currencies with different number of decimal places. For example: VND has no pennies and KWD has three decimal places. Please take this into account in the Amout field. For more information on other currencies, see ISO 4217. |




6.7.1. CoF Initial transaction
The first stage is a one-time initial transaction, which is a simple e-commerce payment but contains the customer's consent to store card data for subsequent purchases. Card data is stored in a secure FENIGE environment. After completing the initial merchant receives the unique cofInitialUuid identifier needed to perform subsequent CoF transactions without having to enter card data.
From January 2021, there is an internal functionality to restrict access for the PSP to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The PSP will be informed about each access restriction action. |
Request
POST /client/payments/cof/initial HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 897
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "ac8dbfc0-967a-4867-8978-896cdbfb6bc1",
"requestUuid" : "e259c689-85e8-417e-9785-b49fc02cfad8",
"firstName" : "user",
"lastName" : "testUser",
"amount" : 1000,
"currency" : "USD",
"cardNumber" : "5453131785534417",
"expiryDate" : "11/26",
"cvc2" : "123",
"email" : "test@fenige.pl",
"phoneNumber" : "500500500",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"eci" : "02",
"authenticationStatus" : "Y",
"transactionXId" : "d543820d-683e-4589-86d9-6c9e40db4b53"
},
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"postalCode" : "24-110",
"province" : "NY"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
firstName |
String |
First name of cardholder |
|
lastName |
String |
Last name of cardholder |
|
cardNumber |
String |
Full cardholder’s card number must be between 12-digits and 19-digits |
|
expiryDate |
String |
Expiration date of card mm/yy |
|
cvc2 |
String |
@Optional only for Google pay, @Length must be 3 characters, @Must match regular expression: \d+ |
Cardholder’s card cvc2 |
amount |
Number |
@Must not be null |
The total transfer amount (in pennies). If the amount is equal to zero there is sent account status inquiry to validate aspects of a cardholder account. |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
String |
Optional field, @Length(min = 1, max = 128) |
Cardholder’s email |
|
phoneNumber |
String |
@Optional @Must match regular expression [0-9]{3,14} |
Cardholder’s phone number |
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
outside3ds |
Object |
There are outside 3ds data authorization that have been send to our API |
|
outside3ds.cavv |
String |
Cardholder Authentication Verification Value |
|
outside3ds.transactionXId |
String |
Cardholder Authentication Verification Value. The transactionXId is the field that defines the 3DS version.The presence of this field in the HTTP request specifies that the transaction will be processed with 3DS 2.x.TransactionXId can be obtained by executing the /authentication method. |
|
outside3ds.cavvAlgorithm |
String |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm |
|
outside3ds.eci |
String |
@Length must be between 1 and 2 inclusive, @Must match 01 or 02 or 05 or 06, @Must not be null |
Electronic Commerce Indicator: 5 (Visa) or 2 (SecureCode) - The cardholder was successfully authenticated. 6 (Visa) or 1 (SecureCode) - Authentication was attempted, but the cardholder was not enrolled. Chargeback protection applies. |
outside3ds.authenticationStatus |
String |
@Must match Y or A, @Must not be null |
Authentication status: Y - (Full Authentication) - The customer was successfully authenticated. A - (Successful Attempted Authentication) - Authentication was not available, but functionality was available to generate a proof of authentication attempt. |
cipherCardNumber |
String |
@Optional |
Cipher card number. More in Payment API - JWE chapter |
keysVersion |
Number |
@Optional |
Field informs about keys version that was used to encrypt card number in cipherCardNumber field. More in Payment API - JWE chapter |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
POST /client/payments/cof/initial HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 686
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "ac8dbfc0-967a-4867-8978-896cdbfb6bc1",
"requestUuid" : "2764bc51-264a-40bd-9eab-5ccddddd2dc8",
"firstName" : "user",
"lastName" : "testUser",
"amount" : 1000,
"currency" : "USD",
"cardNumber" : "5453131785534417",
"expiryDate" : "11/26",
"cvc2" : "123",
"email" : "test@fenige.pl",
"phoneNumber" : "500500500",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"postalCode" : "24-110",
"province" : "NY"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
firstName |
String |
First name of cardholder |
|
lastName |
String |
Last name of cardholder |
|
cardNumber |
String |
Full cardholder’s card number must be between 12-digits and 19-digits |
|
expiryDate |
String |
Expiration date of card mm/yy |
|
cvc2 |
String |
@Optional only for Google pay, @Length must be 3 characters, @Must match regular expression: \d+ |
Cardholder’s card cvc2 |
amount |
Number |
@Must not be null |
The total transfer amount (in pennies). If the amount is equal to zero there is sent account status inquiry to validate aspects of a cardholder account. |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
String |
Optional field, @Length(min = 1, max = 128) |
Cardholder’s email |
|
phoneNumber |
String |
@Optional @Must match regular expression [0-9]{3,14} |
Cardholder’s phone number |
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
cipherCardNumber |
String |
@Optional |
Cipher card number. More in Payment API - JWE chapter |
keysVersion |
Number |
@Optional |
Field informs about keys version that was used to encrypt card number in cipherCardNumber field. More in Payment API - JWE chapter |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
POST /client/payments/cof/initial HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 745
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "d50d50e9-ec82-4fed-ad76-fbc1798259aa",
"terminalUuid" : "2ca479ee-1af5-4d0d-a57f-61cecb11421e",
"requestUuid" : "cee85abb-a7f8-447e-9231-351305629425",
"firstName" : "user",
"lastName" : "testUser",
"amount" : 1000,
"currency" : "USD",
"cardNumber" : "5453131785534417",
"expiryDate" : "11/26",
"cvc2" : "123",
"email" : "test@fenige.pl",
"phoneNumber" : "500500500",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"postalCode" : "24-110",
"province" : "NY"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
firstName |
String |
First name of cardholder |
|
lastName |
String |
Last name of cardholder |
|
cardNumber |
String |
Full cardholder’s card number must be between 12-digits and 19-digits |
|
expiryDate |
String |
Expiration date of card mm/yy |
|
cvc2 |
String |
@Optional only for Google pay, @Length must be 3 characters, @Must match regular expression: \d+ |
Cardholder’s card cvc2 |
amount |
Number |
@Must not be null |
The total transfer amount (in pennies). If the amount is equal to zero there is sent account status inquiry to validate aspects of a cardholder account. |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
String |
Optional field, @Length(min = 1, max = 128) |
Cardholder’s email |
|
phoneNumber |
String |
@Optional @Must match regular expression [0-9]{3,14} |
Cardholder’s phone number |
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
cipherCardNumber |
String |
@Optional |
Cipher card number. More in Payment API - JWE chapter |
keysVersion |
Number |
@Optional |
Field informs about keys version that was used to encrypt card number in cipherCardNumber field. More in Payment API - JWE chapter |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
terminalUuid |
String |
Terminals’s unique uuid in system |
POST /client/payments/cof/initial HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 744
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "9fa8bf5a-f582-406b-b4ad-5725e21bff29",
"requestUuid" : "7c9f8da5-ddad-4af7-b13c-d302f303f26c",
"amount" : 1000,
"currency" : "USD",
"cardId" : 1906455,
"cvc2" : "123",
"addressIp" : "192.0.0.1",
"autoClear" : true,
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"eci" : "02",
"authenticationStatus" : "Y",
"transactionXId" : "d543820d-683e-4589-86d9-6c9e40db4b53"
},
"terminalUrl" : "https://ecom-staging.fenige.pl/payments",
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"province" : "NY",
"postalCode" : "24-110"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
cvc2 |
String |
@Optional only for Google pay, @Length must be 3 characters, @Must match regular expression: \d+ |
Cardholder’s card cvc2 |
cardId |
Number |
@Must not be null, @Numeric |
DataCenter card id. Required to obtain card information data from DataCenter such as (cardNumber, expiryDate, firstName, lastName, email) |
amount |
Number |
@Must not be null |
The total transfer amount (in pennies). If the amount is equal to zero there is sent account status inquiry to validate aspects of a cardholder account. |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
addressIp |
String |
Optional field, @Must match the regular expression ^([0-9]{1,3}.){3}[0-9]{1,3}$ |
The IP address of the order of transaction. Optional field, mandatory from 2021-05-03 |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
terminalUrl |
String |
@Optional |
Terminal identifier such as the business website URL or reverse domain name as presented to the consumer during checkout. Optional field, mandatory from 2021-05-03 |
outside3ds |
Object |
There are outside 3ds data authorization that have been send to our API |
|
outside3ds.cavv |
String |
Cardholder Authentication Verification Value |
|
outside3ds.transactionXId |
String |
Cardholder Authentication Verification Value. The transactionXId is the field that defines the 3DS version.The presence of this field in the HTTP request specifies that the transaction will be processed with 3DS 2.x.TransactionXId can be obtained by executing the /authentication method. |
|
outside3ds.cavvAlgorithm |
String |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm |
|
outside3ds.eci |
String |
@Length must be between 1 and 2 inclusive, @Must match 01 or 02 or 05 or 06, @Must not be null |
Electronic Commerce Indicator: 5 (Visa) or 2 (SecureCode) - The cardholder was successfully authenticated. 6 (Visa) or 1 (SecureCode) - Authentication was attempted, but the cardholder was not enrolled. Chargeback protection applies. |
outside3ds.authenticationStatus |
String |
@Must match Y or A, @Must not be null |
Authentication status: Y - (Full Authentication) - The customer was successfully authenticated. A - (Successful Attempted Authentication) - Authentication was not available, but functionality was available to generate a proof of authentication attempt. |
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
cipherCardNumber |
String |
@Optional |
Cipher card number. More in Payment API - JWE chapter |
keysVersion |
Number |
@Optional |
Field informs about keys version that was used to encrypt card number in cipherCardNumber field. More in Payment API - JWE chapter |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
Response
Status | Description |
---|---|
|
Returned when transaction was successfully authorized. |
|
STATUS: E8000 - Returned when request is incorrect, required fields are missing or the values are not valid. |
|
STATUS: E8002 - Returned when you are the problem with authorized to your PSP. |
|
STATUS: E8001 - Returned when server understood the request but refuses to authorize it. |
|
STATUS: E0122 - Returned when merchant is not existing. STATUS: E0132 - Returned when terminal is not existing. STATUS: E0135 - Returned when terminal for merchant not exist or all of them are inactive. STATUS: E0137 - Returned when there is not terminal marked as default STATUS: E06003 - Returned when DataCenter card was not found. |
|
STATUS: E0150 - Returned when transaction is rejected. STATUS: E0151 - Returned when transaction is rejected, because currency is not supported. STATUS: E0152 - Returned when transaction is rejected, because issuer is not supported. STATUS: E01580 - Returned when transaction is rejected, because DataCenter card was expired. STATUS: E0159 - Returned when transaction is rejected, because restricted transaction amount has occurred STATUS: E01596 - Returned when transaction is rejected, because terminal has blocked transaction with card issued in restricted country STATUS: E01601 - Returned when transaction is rejected, because terminal is blocked for provider STATUS: E01602 - Transaction rejected, geographic scope is not permitted for this transaction STATUS: E01607 - Transaction rejected, internal server error during authorization request generation STATUS: E0200 - Returned when transaction is rejected, because card is blocked in Fenige System STATUS: E0201 - Returned when transaction is rejected, because BIN is blocked in Fenige System STATUS: E0202 - Returned when transaction is rejected, because Terminal is blocked in Fenige System STATUS: E0204 - Returned when transaction is rejected, because user’s personal data was found on AML (sanctions) list STATUS: E0205 - Returned when transaction is rejected, because Bank is blocked in Fenige System STATUS: E0206 - Returned when transaction is rejected, because to many reject transactions and card is blocked STATUS: E0207 - Returned when transaction is rejected, bacause to many attempts declined and card is blocked STATUS: E0208 - Transaction rejected, second transaction with merchant advice code 03 or 21 within 30 days STATUS: E0209 - Returned when sender or receiver name contains fraudulent phrase STATUS: E0210 - Returned when sender has suspicious name STATUS: E01600 - Returned when transaction is declined, because 3DS 2.X flow invoked for other card number than specified in the request STATUS: E11000 - Returned when transaction processing time set by terminal was exceeded |
|
STATUS: E0142 - Returned when commission configuration is not added for terminal. STATUS: E0153 - Returned when transaction is declined, by problem with MIP connection. STATUS: E01599 - Transaction declined, processing timeout. STATUS: E0190 - Returned when currency rate is invalid. STATUS: E9000 - Returned when reason is unknown. STATUS: E9008 - Returned when mpi received 3ds initialize failed. |
|
STATUS: E9001 - Returned when is error acquirer connection. STATUS: E9002 - Returned when is error mpi connection. STATUS: E9010 - Returned when is error DataCenter connection. |
{
"requestUuid" : "58261061-7629-44b8-98ea-4b881c10c6a3",
"cofInitialUuid" : "20a00783-9f9a-47ad-bddd-2209790d5799",
"transactionStatus" : "APPROVED",
"responseCode" : "CODE_00",
"status" : "S0002",
"message" : "Success transaction",
"httpStatus" : "OK"
}
Path | Type | Description |
---|---|---|
|
|
Request unique uuid in system |
|
|
CoF transaction unique uuid in system |
|
|
Transaction status |
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Response code |
HTTP/1.1 400 Bad Request
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:11:20 GMT
Connection: close
Content-Length: 485
{
"errors" : {
"expiryDate" : [ "invalid card format expiration date" ],
"lastName" : [ "must not be blank", "must not be null" ],
"firstName" : [ "must not be blank", "must not be null" ],
"amount" : [ "must not be null" ],
"merchantUuid" : [ "must not be null" ],
"requestUuid" : [ "must not be null" ],
"currency" : [ "must not be null" ]
},
"status" : "E8000",
"httpStatus" : "BAD_REQUEST",
"traceId" : "69d3a089-5ff3-45e4-b27a-859449b85e1b"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 400 Bad Request
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:11:20 GMT
Connection: close
Content-Length: 679
{
"errors" : {
"expiryDate" : [ "Card id was provided, expiryDate is obtained from data center card: 1906455" ],
"firstName" : [ "Card id was provided, firstName is obtained from data center card: 1906455" ],
"lastName" : [ "Card id was provided, lastName is obtained from data center card: 1906455" ],
"cardId" : [ "Please provide cardId for DATACENTER transaction or fields: cardNumber, expiryDate, firstName, lastName for PLAIN transaction" ],
"cardNumber" : [ "Card id was provided, cardNumber is obtained from data center card: 1906455" ]
},
"status" : "E8000",
"httpStatus" : "BAD_REQUEST",
"traceId" : "e800161b-e9ec-4280-8e97-c814daa1bc13"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic realm="Realm"
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 141
Date: Mon, 25 Sep 2023 11:11:20 GMT
{
"status" : "E8002",
"message" : "Unauthorized",
"httpStatus" : "UNAUTHORIZED",
"traceId" : "4a812586-19b3-4828-b29b-299248d625a4"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 403 Forbidden
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 135
Date: Mon, 25 Sep 2023 11:11:21 GMT
{
"status" : "E8001",
"message" : "Forbidden",
"httpStatus" : "FORBIDDEN",
"traceId" : "7b598470-f400-4ff9-9735-370d2f65f104"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 146
{
"status" : "E0122",
"message" : "Merchant not exists.",
"httpStatus" : "NOT_FOUND",
"traceId" : "085e4ce0-a252-4526-bb6c-9eacb06c51b5"
}
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 146
{
"status" : "E0132",
"message" : "Terminal not exists.",
"httpStatus" : "NOT_FOUND",
"traceId" : "f19c0097-e022-43ba-99c3-e6dbd6752a07"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 163
{
"status" : "E0137",
"message" : "Default terminal not exist",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "b8046d00-d17e-4eb0-8989-ad0d467713ed"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 159
{
"status" : "E0135",
"message" : "Terminals for merchant not exists",
"httpStatus" : "NOT_FOUND",
"traceId" : "f2acd90d-08f4-4886-a6d8-70899960659e"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 246
{
"requestUuid" : "62fb77f4-974a-4b7b-b34a-7c76ce9f2508",
"transactionStatus" : "REJECTED",
"status" : "E06003",
"message" : "Datacenter card not found",
"httpStatus" : "NOT_FOUND",
"traceId" : "42e77860-f3d3-4576-b427-af023359f483"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 251
{
"requestUuid" : "38468645-d9d0-46b9-9ad7-4f801f7eda0b",
"transactionStatus" : "REJECTED",
"status" : "E0150",
"message" : "Transaction rejected",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "bac3376e-2112-4263-bf2c-6eb5478ef128"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 275
{
"requestUuid" : "e2e4b9d1-fa1d-4a2a-a890-29e251f8d419",
"transactionStatus" : "REJECTED",
"status" : "E0151",
"message" : "Transaction rejected, currency not supported",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "8c5d514c-c613-460e-a524-e315005654ef"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 278
{
"requestUuid" : "cc54c710-5145-48bb-9f0c-b917d33f53a5",
"transactionStatus" : "REJECTED",
"status" : "E0152",
"message" : "Transaction rejected, issuer card not supported",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "d21beeba-78e6-40ca-b027-17688329b9cd"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 270
{
"requestUuid" : "bebf0399-19ff-4d85-b5d9-ab66f9aae69f",
"transactionStatus" : "REJECTED",
"status" : "E01580",
"message" : "Transaction rejected. Card is expired.",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "5299f5eb-b2dd-4241-96b7-da478eee625b"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 295
{
"requestUuid" : "4fc128e7-5d17-4a9b-83d8-e2daef1d4df9",
"transactionStatus" : "REJECTED",
"status" : "E0159",
"message" : "Transaction rejected, restricted transaction amount has occurred",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "55f93964-609d-466b-91fd-ea6651ba5a88"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 267
{
"requestUuid" : "92f081cf-f19f-497a-8664-cc4633c083db",
"transactionStatus" : "REJECTED",
"status" : "E0201",
"message" : "Transaction rejected, bin is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "7e68c703-8f4a-4949-b503-0867b0355332"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 272
{
"requestUuid" : "0b06115e-bcb9-4ce1-83dd-7db3515e3c24",
"transactionStatus" : "REJECTED",
"status" : "E0202",
"message" : "Transaction rejected, terminal is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "05540602-e8c9-42c0-b093-503352916612"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 272
{
"requestUuid" : "b6e6b77a-176b-4ed9-b26e-9ab9a3926d4e",
"transactionStatus" : "REJECTED",
"status" : "E0204",
"message" : "Transaction rejected, user is on aml list",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "144f2f28-49bd-4d1b-9449-fdbc43bd77d7"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 268
{
"requestUuid" : "9ead5699-be93-4993-9e56-a98cc9183c58",
"transactionStatus" : "REJECTED",
"status" : "E0205",
"message" : "Transaction rejected, bank is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "11eac9c4-35db-4f90-a338-2b8603bc81bd"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 300
{
"requestUuid" : "89ec0012-bae4-476a-9e6b-31f04a07781b",
"transactionStatus" : "REJECTED",
"status" : "E0206",
"message" : "Transaction rejected, to many reject transactions and card is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "f4f01cbc-ab6a-4465-9972-f8a62d9de3a6"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 298
{
"requestUuid" : "334b8bba-5d2a-469f-9e8d-5d916d921d3b",
"transactionStatus" : "REJECTED",
"status" : "E0207",
"message" : "Transaction rejected, to many attempts declined and card is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "e5a80813-9137-4cd3-a059-27e9533e7cd3"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 321
{
"requestUuid" : "7913e5e1-4edd-468c-902b-124cd6d2fc86",
"transactionStatus" : "REJECTED",
"status" : "E0208",
"message" : "Transaction rejected, second transaction with merchant advice code 03 or 21 within 30 days",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "169c8549-4ae7-4251-b3d4-516d56ae3b73"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 292
{
"requestUuid" : "ed7eeeb7-b06c-47d6-9e1a-eaef68f86bbf",
"transactionStatus" : "REJECTED",
"status" : "E0209",
"message" : "Transaction rejected, sender name contains fraudulent phrase.",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "91d96a8a-470c-42bb-a0d7-358d61cdff07"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 276
{
"requestUuid" : "f964b50e-5ce7-4d3e-a596-c92be96df428",
"transactionStatus" : "REJECTED",
"status" : "E0210",
"message" : "Transaction rejected, suspicious sender name.",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "d72fb2a4-d482-425f-a43a-a38facecf344"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 321
{
"requestUuid" : "fe1a6267-ac9a-4453-af75-f2c205526d73",
"transactionStatus" : "REJECTED",
"status" : "E01596",
"message" : "Transaction rejected, terminal blocks transactions with card issued in given card country",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "ece517ad-6e61-4896-9bef-de1564be744a"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 369
{
"requestUuid" : "078ec5b0-bba5-4259-a272-703dd8703505",
"transactionStatus" : "REJECTED",
"status" : "E01597",
"message" : "Transaction rejected, 3DS version of terminal are not compatible with 3DS version defined in request. Please contact the sales department",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "a48a4aa6-c234-4537-b577-a184c053bef3"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 315
{
"requestUuid" : "b1d61203-82ac-40b4-9101-e02a81f91bad",
"transactionStatus" : "REJECTED",
"status" : "E01607",
"message" : "Transaction rejected, internal server error during authorization request generation",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "63f44911-5740-4e12-ad1f-bbba388a0a51"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 298
{
"requestUuid" : "c99f9d2a-4781-405d-af9a-46c999203ca1",
"transactionStatus" : "REJECTED",
"status" : "E01598",
"message" : "Transaction rejected, ECI value is not available for card provider",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "3841e430-89f9-4d96-9b8c-8d568ad0d78a"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 381
{
"requestUuid" : "db7f4c6d-7680-4f9c-baae-74a04edbd75f",
"transactionStatus" : "REJECTED",
"cardBlockadeAdditionalData" : {
"blockType" : "TEMP",
"blockedUntil" : "2022-11-01T12:51:32.000"
},
"status" : "E0200",
"message" : "Transaction rejected, card is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "12975c86-9401-4dff-9e8e-74f6a25179bf"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
|
|
Block type. Possible values: TEMP - temporary, PERMANENT - permanent. |
|
|
Date until card will be blocked in yyyy-MM-ddThh-mm-ss.SSS format. |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 326
{
"requestUuid" : "66e5353d-b968-4cbe-b13f-c92f6451f311",
"transactionStatus" : "REJECTED",
"status" : "E01584",
"message" : "Transaction rejected, 3DS 2.X flow invoked for other card number than specified in the request",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "8df2980f-e409-4636-8407-2721b82a5ee7"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 286
{
"requestUuid" : "b358cd55-3af8-45f6-b74d-09a377a45e00",
"transactionStatus" : "REJECTED",
"status" : "E01601",
"message" : "Transaction rejected, terminal is blocked for provider",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "d00b6d7a-e493-425f-92d0-5c774b0e1251"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 308
{
"requestUuid" : "14ccfe81-1ad7-4c95-a518-3bf2545fcefb",
"transactionStatus" : "REJECTED",
"status" : "E01602",
"message" : "Transaction rejected, geographic scope is not permitted for this transaction",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "987245a7-6ea8-4bb4-bd3a-43198113a342"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 183
{
"status" : "E0142",
"message" : "Commission configuration not add for terminal",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "a707a113-0187-4be5-bd77-f0f1d5226685"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 280
{
"requestUuid" : "5b6bfb10-f881-488d-a884-09a005d22610",
"transactionStatus" : "PENDING",
"status" : "E0153",
"message" : "Transaction declined, problem with MIP connection",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "4de98ee0-a009-420c-8349-4a155ba96dae"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 273
{
"requestUuid" : "5a1956e2-1e16-4e0f-b072-7f7f62eaa89c",
"transactionStatus" : "DECLINED",
"status" : "E01599",
"message" : "Transaction declined, processing timeout",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "a44fe6ea-882f-47f8-ba00-44b2f0784744"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 166
{
"status" : "E0190",
"message" : "Failed to get currency rates",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "cc55f17a-e61a-414d-a815-b2f8d2bd6884"
}
HTTP/1.1 500 Internal Server Error
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:19 GMT
Connection: close
Content-Length: 150
{
"status" : "E9000",
"message" : "Domain error",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "3c268696-8733-4d27-a65d-64f672197318"
}
Path | Type | Description |
---|---|---|
|
|
Message for response code from Fenige system |
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
UUID that helps to identify request in system |
HTTP/1.1 503 Service Unavailable
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:05 GMT
Connection: close
Content-Length: 161
{
"status" : "E9001",
"message" : "Error acquirer connection",
"httpStatus" : "SERVICE_UNAVAILABLE",
"traceId" : "da762af3-a5fc-4c96-8378-c3b5b2a0d9b1"
}
HTTP/1.1 503 Service Unavailable
Content-Type: application/json
Content-Length: 258
{
"requestUuid" : "75a01ad7-4b0b-496c-b5a6-b11cfe179321",
"transactionStatus" : "REJECTED",
"status" : "E9010",
"message" : "Error data center connection",
"httpStatus" : "SERVICE_UNAVAILABLE",
"traceId" : "8be63987-c139-4b2b-ae19-e5f8b2b902dc"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
6.7.2. CoF Subsequent transaction
The second phase is the subsequent transaction, which requires a successful initial transaction containing the consent to store card data. Merchant provides the cofInitialUuid parameter received in the initial transaction, which defines the customer's card data saved in the transaction. Subsequent transactions are intended for multiple execution.
From January 2021, there is an internal functionality to restrict access for the PSP to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The PSP will be informed about each access restriction action. |
Request
POST /client/payments/cof/subsequent HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 464
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "ac8dbfc0-967a-4867-8978-896cdbfb6bc1",
"requestUuid" : "91318658-79db-41a7-851b-590c67596b83",
"cofInitialUuid" : "837a7400-cbec-45d9-8d6e-b5d8bf9e9d4d",
"amount" : 1000,
"currency" : "USD",
"autoClear" : true,
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"province" : "NY",
"postalCode" : "24-110"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
cofInitialUuid |
String |
@Must not be null |
CoF initial transaction identifier uuid |
amount |
Number |
@Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
POST /client/payments/cof/subsequent HTTP/1.1
Authorization: Basic dXNlcjpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 523
Host: ecom-staging.fenige.pl
{
"merchantUuid" : "bf8d0c41-a3bd-40e2-a4dc-0990c9f5b6d5",
"terminalUuid" : "b1b76094-9b52-4ae1-8364-71e9e9a31a7f",
"requestUuid" : "ded95773-43f6-4fb6-9775-2f7c5e8f0bc0",
"cofInitialUuid" : "bf8d0c41-a3bd-40e2-a4dc-0990c9f5b6d5",
"amount" : 1000,
"currency" : "USD",
"autoClear" : true,
"transactionRef" : "27F3250GU3",
"receiverAmount" : 900,
"countryOfResidence" : "US",
"street" : "Karola Olszewskiego",
"houseNumber" : "10",
"city" : "Lublin",
"postalCode" : "24-110",
"province" : "NY"
}
Name | Description |
---|---|
|
Basic auth credentials for PSP |
Path | Type | Constraints | Description |
---|---|---|---|
merchantUuid |
String |
@Must not be null |
Merchant’s unique uuid in system |
requestUuid |
String |
@Must not be null |
Request’s unique uuid in system |
cofInitialUuid |
String |
@Must not be null |
CoF initial transaction identifier uuid |
amount |
Number |
@Must not be null |
The total transfer amount (in pennies) |
receiverAmount |
Number |
@Optional field, @Must be greater or equals 0 if exists |
Declared amount. Fenige Information field (in pennies) |
currency |
String |
@Must not be null |
Currency for transaction (in accordance with ISO-4217), example: USD |
autoClear |
Boolean |
Is auto clear enabled. Enabled if true, is not enabled if false. There is 7 days for execute clearing process if autoClear = false |
|
transactionRef |
String |
@Optional, @Length must be between 1 and 10, @Must not be blank, @Must match the regular expression ^[a-zA-Z0-9]*$ |
An additional transaction identifier defined by the merchant. This can be, for example, the document number of a sales receipt or the number of an offer or product |
countryOfResidence |
String |
Country of residence is only required for merchants crypto |
|
city |
String |
@Optional@Length(min = 1, max = 55) |
Optional city of sender |
street |
String |
@Optional @Length(min = 1, max = 55) @Pattern(regexp = "[\\s\](\\s[^\\s]+)*$") |
Optional street name of sender |
province |
String |
@Optional @Length(min = 2, max = 2) |
Optional USA state or CAN province code of sender |
houseNumber |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = "^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$") |
Optional house number of sender |
postalCode |
String |
@Optional @Length(min = 1, max = 10) @Pattern(regexp = (^[a-zA-Z\d][a-zA-Z\d\- ]{0,9}[a-zA-Z\d]$)|^[a-zA-Z1-9]$ |
Optional postal code of sender |
terminalUuid |
String |
Terminals’s unique uuid in system |
Response
Status | Description |
---|---|
|
Returned when transaction was successfully authorized. |
|
STATUS: E8000 - Returned when request is incorrect, required fields are missing or the values are not valid. |
|
STATUS: E8002 - Returned when you are the problem with authorized to your PSP. |
|
STATUS: E8001 - Returned when server understood the request but refuses to authorize it. |
|
STATUS: E0122 - Returned when merchant is not existing. STATUS: E0132 - Returned when terminal is not existing. STATUS: E0135 - Returned when terminal for merchant not exist or all of them are inactive. STATUS: E0137 - Returned when there is not terminal marked as default |
|
STATUS: E0150 - Returned when transaction is rejected. STATUS: E0151 - Returned when transaction is rejected, because currency is not supported. STATUS: E0152 - Returned when transaction is rejected, because issuer is not supported. STATUS: E0159 - Returned when transaction is rejected, because restricted transaction amount has occurred STATUS: E01590 - Returned when transaction is rejected, because initial CoF card not found in DC. STATUS: E01591 - Returned when transaction is rejected, because initial CoF transaction not approved. STATUS: E01601 - Returned when transaction is rejected, because terminal is blocked for provider STATUS: E01602 - Transaction rejected, geographic scope is not permitted for this transaction STATUS: E01607 - Transaction rejected, internal server error during authorization request generation STATUS: E0200 - Returned when transaction is rejected, because card is blocked in Fenige System STATUS: E0201 - Returned when transaction is rejected, because BIN is blocked in Fenige System STATUS: E0202 - Returned when transaction is rejected, because Terminal is blocked in Fenige System STATUS: E0204 - Returned when transaction is rejected, because user’s personal data was found on AML (sanctions) list STATUS: E0205 - Returned when transaction is rejected, because Bank is blocked in Fenige System STATUS: E0206 - Returned when transaction is rejected, because to many reject transactions and card is blocked STATUS: E0207 - Returned when transaction is rejected, bacause to many attempts declined and card is blocked STATUS: E0208 - Transaction rejected, second transaction with merchant advice code 03 or 21 within 30 days STATUS: E0209 - Returned when sender or receiver name contains fraudulent phrase STATUS: E0210 - Returned when sender has suspicious name STATUS: E11000 - Returned when transaction processing time set by terminal was exceeded |
|
STATUS: E0142 - Returned when commission configuration is not added for terminal. STATUS: E0153 - Returned when transaction is declined, by problem with MIP connection. STATUS: E01599 - Transaction declined, processing timeout. STATUS: E0190 - Returned when currency rate is invalid. STATUS: E9000 - Returned when reason is unknown. STATUS: E9008 - Returned when mpi received 3ds subsequentize failed. |
|
STATUS: E9001 - Returned when is error acquirer connection. STATUS: E9002 - Returned when is error mpi connection. STATUS: E9010 - Returned when is error data center connection. |
{
"requestUuid" : "6e23c9d2-28d2-4eff-acb5-a01c7f3dd6aa",
"cofInitialUuid" : "3f342f62-82f5-41ed-b67b-19972605fc87",
"transactionStatus" : "APPROVED",
"responseCode" : "CODE_00",
"status" : "S0002",
"message" : "Success transaction",
"httpStatus" : "OK"
}
Path | Type | Description |
---|---|---|
|
|
Request unique uuid in system |
|
|
CoF transaction unique uuid in system |
|
|
Transaction status |
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Response code |
HTTP/1.1 400 Bad Request
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:11:15 GMT
Connection: close
Content-Length: 345
{
"errors" : {
"amount" : [ "must not be null" ],
"merchantUuid" : [ "must not be null" ],
"requestUuid" : [ "must not be null" ],
"currency" : [ "must not be null" ],
"cofInitialUuid" : [ "must not be null" ]
},
"status" : "E8000",
"httpStatus" : "BAD_REQUEST",
"traceId" : "fcb99336-0aa8-43c1-9418-3a690b2e483e"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Basic realm="Realm"
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 141
Date: Mon, 25 Sep 2023 11:11:15 GMT
{
"status" : "E8002",
"message" : "Unauthorized",
"httpStatus" : "UNAUTHORIZED",
"traceId" : "a8fc2f04-686c-46b8-ba44-66a1acc07370"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 403 Forbidden
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 135
Date: Mon, 25 Sep 2023 11:11:16 GMT
{
"status" : "E8001",
"message" : "Forbidden",
"httpStatus" : "FORBIDDEN",
"traceId" : "8c96e331-4cab-44b7-98b1-e13b470060ca"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 146
{
"status" : "E0122",
"message" : "Merchant not exists.",
"httpStatus" : "NOT_FOUND",
"traceId" : "484bff22-e3eb-4fc4-bdb9-239cc694ee50"
}
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 146
{
"status" : "E0132",
"message" : "Terminal not exists.",
"httpStatus" : "NOT_FOUND",
"traceId" : "f4c98bc1-bf86-411b-bf90-72a5b50f07f5"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 163
{
"status" : "E0137",
"message" : "Default terminal not exist",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "4693a579-b12f-4cb0-a433-c4a30e853b76"
}
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 159
{
"status" : "E0135",
"message" : "Terminals for merchant not exists",
"httpStatus" : "NOT_FOUND",
"traceId" : "c740a7a8-d6d5-44bc-9348-2bb8edae8371"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 251
{
"requestUuid" : "3928d572-d6bf-4bc0-8400-fed490bb952a",
"transactionStatus" : "REJECTED",
"status" : "E0150",
"message" : "Transaction rejected",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "5d2c75d7-c3b0-48f5-a095-ba94f753aea0"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 275
{
"requestUuid" : "46bcc79e-d0ce-46fb-b459-9d12d9ad27c6",
"transactionStatus" : "REJECTED",
"status" : "E0151",
"message" : "Transaction rejected, currency not supported",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "0c9e2bed-e72b-4ece-a67d-805602850d5a"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 278
{
"requestUuid" : "4aefd854-6968-494b-90ea-27edcbb5475e",
"transactionStatus" : "REJECTED",
"status" : "E0152",
"message" : "Transaction rejected, issuer card not supported",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "5d136262-9db5-4204-86c2-ee26e371ddbc"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 295
{
"requestUuid" : "4fc128e7-5d17-4a9b-83d8-e2daef1d4df9",
"transactionStatus" : "REJECTED",
"status" : "E0159",
"message" : "Transaction rejected, restricted transaction amount has occurred",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "55f93964-609d-466b-91fd-ea6651ba5a88"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 278
{
"requestUuid" : "645fa829-52b9-460b-b133-798293dee645",
"transactionStatus" : "REJECTED",
"status" : "E01590",
"message" : "Transaction rejected, cof card not found in db",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "fbfb5195-2cf0-4502-9d93-0d06da76b1d0"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 278
{
"requestUuid" : "36c2706a-5431-43a4-b88a-b028bb05ee62",
"transactionStatus" : "REJECTED",
"status" : "E01590",
"message" : "Transaction rejected, cof card not found in db",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "7a24a162-63c3-4b26-bb94-5ca2ff47b66d"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 381
{
"requestUuid" : "f0789654-5085-4d43-8cd8-6b19b3ceaa34",
"transactionStatus" : "REJECTED",
"cardBlockadeAdditionalData" : {
"blockType" : "TEMP",
"blockedUntil" : "2022-11-01T12:51:32.000"
},
"status" : "E0200",
"message" : "Transaction rejected, card is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "a7ef6f8b-e7db-4ae3-865f-784f7b98cd1c"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 267
{
"requestUuid" : "f92b99e1-80bd-4c9e-bf54-7d3c368eccba",
"transactionStatus" : "REJECTED",
"status" : "E0201",
"message" : "Transaction rejected, bin is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "d2d799df-3aab-4973-985c-c32d3ec2e3fa"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 272
{
"requestUuid" : "cb6513de-70b1-4ed6-a8b3-9093b129805b",
"transactionStatus" : "REJECTED",
"status" : "E0202",
"message" : "Transaction rejected, terminal is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "4bfa0b6b-f32c-47fd-8671-c903108492a3"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 272
{
"requestUuid" : "394e30ba-157e-44b9-a569-c216cf9792ed",
"transactionStatus" : "REJECTED",
"status" : "E0204",
"message" : "Transaction rejected, user is on aml list",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "d86d9038-d335-43b1-81c9-f7d5e7c801b4"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 268
{
"requestUuid" : "42f16bac-25e1-4aa1-a4d3-9c1233394096",
"transactionStatus" : "REJECTED",
"status" : "E0205",
"message" : "Transaction rejected, bank is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "ecb06e1c-281b-4459-8425-49538a9945f0"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
|
|
Request unique uuid in system |
|
|
Transaction status |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 300
{
"requestUuid" : "89ec0012-bae4-476a-9e6b-31f04a07781b",
"transactionStatus" : "REJECTED",
"status" : "E0206",
"message" : "Transaction rejected, to many reject transactions and card is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "f4f01cbc-ab6a-4465-9972-f8a62d9de3a6"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 298
{
"requestUuid" : "334b8bba-5d2a-469f-9e8d-5d916d921d3b",
"transactionStatus" : "REJECTED",
"status" : "E0207",
"message" : "Transaction rejected, to many attempts declined and card is blocked",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "e5a80813-9137-4cd3-a059-27e9533e7cd3"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 321
{
"requestUuid" : "7913e5e1-4edd-468c-902b-124cd6d2fc86",
"transactionStatus" : "REJECTED",
"status" : "E0208",
"message" : "Transaction rejected, second transaction with merchant advice code 03 or 21 within 30 days",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "169c8549-4ae7-4251-b3d4-516d56ae3b73"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 292
{
"requestUuid" : "ed7eeeb7-b06c-47d6-9e1a-eaef68f86bbf",
"transactionStatus" : "REJECTED",
"status" : "E0209",
"message" : "Transaction rejected, sender name contains fraudulent phrase.",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "91d96a8a-470c-42bb-a0d7-358d61cdff07"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 276
{
"requestUuid" : "f964b50e-5ce7-4d3e-a596-c92be96df428",
"transactionStatus" : "REJECTED",
"status" : "E0210",
"message" : "Transaction rejected, suspicious sender name.",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "d72fb2a4-d482-425f-a43a-a38facecf344"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 286
{
"requestUuid" : "b358cd55-3af8-45f6-b74d-09a377a45e00",
"transactionStatus" : "REJECTED",
"status" : "E01601",
"message" : "Transaction rejected, terminal is blocked for provider",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "d00b6d7a-e493-425f-92d0-5c774b0e1251"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 308
{
"requestUuid" : "14ccfe81-1ad7-4c95-a518-3bf2545fcefb",
"transactionStatus" : "REJECTED",
"status" : "E01602",
"message" : "Transaction rejected, geographic scope is not permitted for this transaction",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "987245a7-6ea8-4bb4-bd3a-43198113a342"
}
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 315
{
"requestUuid" : "b1d61203-82ac-40b4-9101-e02a81f91bad",
"transactionStatus" : "REJECTED",
"status" : "E01607",
"message" : "Transaction rejected, internal server error during authorization request generation",
"httpStatus" : "UNPROCESSABLE_ENTITY",
"traceId" : "63f44911-5740-4e12-ad1f-bbba388a0a51"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 183
{
"status" : "E0142",
"message" : "Commission configuration not add for terminal",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "99a5b9ae-7c41-4619-9baf-8382b734b45e"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 280
{
"requestUuid" : "974b3933-3718-4941-910a-5ffdf9a90ba8",
"transactionStatus" : "PENDING",
"status" : "E0153",
"message" : "Transaction declined, problem with MIP connection",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "e360c51c-55e2-4ccc-b113-e27ed9f670be"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 273
{
"requestUuid" : "c54fbf24-fdc2-4a54-8112-7d413df49598",
"transactionStatus" : "DECLINED",
"status" : "E01599",
"message" : "Transaction declined, processing timeout",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "bc9d43aa-58b7-4ac0-9e3f-602b26b10ece"
}
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 166
{
"status" : "E0190",
"message" : "Failed to get currency rates",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "b8c13e2c-837f-45e0-ab18-8c5ffe428ad7"
}
HTTP/1.1 500 Internal Server Error
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:19 GMT
Connection: close
Content-Length: 150
{
"status" : "E9000",
"message" : "Domain error",
"httpStatus" : "INTERNAL_SERVER_ERROR",
"traceId" : "3c268696-8733-4d27-a65d-64f672197318"
}
Path | Type | Description |
---|---|---|
|
|
Message for response code from Fenige system |
|
|
Response code from Fenige system |
|
|
Response http status |
|
|
UUID that helps to identify request in system |
HTTP/1.1 503 Service Unavailable
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 25 Sep 2023 11:12:05 GMT
Connection: close
Content-Length: 161
{
"status" : "E9001",
"message" : "Error acquirer connection",
"httpStatus" : "SERVICE_UNAVAILABLE",
"traceId" : "da762af3-a5fc-4c96-8378-c3b5b2a0d9b1"
}
HTTP/1.1 503 Service Unavailable
Content-Type: application/json
Content-Length: 164
{
"status" : "E9010",
"message" : "Error data center connection",
"httpStatus" : "SERVICE_UNAVAILABLE",
"traceId" : "5522a1d4-991c-4e09-a39a-047cb91751b5"
}
Path | Type | Description |
---|---|---|
|
|
Response code from Fenige system |
|
|
Message for response code from Fenige system |
|
|
Response http status |
|
|
Unique id for this http request register in system |
6.8. Recurring payment
A Recurring Payment is a type of the transaction performed as a result of an agreement between a cardholder and a merchant in which the cardholder authorizes the merchant to bill the cardholder’s Mastercard account, with no specified end date. Billing may occur periodically, such as monthly, quarterly or annually. Each payment may be for a variable or a fixed amount. The method is used to charge the cardholder with no need to collect account data (PAN, exp date) from merchant at every transaction. Only initial transaction requires providing card information which are saved in secure Fenige environment according to PCI-DSS Compliance. This endpoint is idempotent so if you execute more than one requests with the same data even at the same time, only first registered transaction will be processed further. In response, we receive transaction status.
The Recurring Payment consists of two parts: initial and subsequent, which are discussed in detail below. Please see detailed Recurring Payment with 3-DS flow described on below listing.
Merchant has the ability to make a payment for goods which causes the cardholder to be debited in the currency of purchase, terminal or card currency based on the parameters provided: currency of transaction, different currency terminals held and currencies supported by the card. The optional terminalUuid field provided during any of the authorisation methods forces the card to be debited in the currency of the terminal specified if the purchase currency is different from the terminal currency a currency conversion will take place.
The Fenige Payment API methods optionally allows merchants to store card data and sensitive personal data in order to allow performing subsequent transactions. If merchant decides to use DataCenter transaction flow then is required to provide the card id of the card previously stored in the Fenige DataCenter, from which card the relevant required parameters will be downloaded and used for authorization. Card data and sensitive personal data according to the Fenige API specification are: cardNumber, expiryDate, firstName, lastName and email. All card data are stored securely on Fenige DataCenter servers in accordance with applicable security requirements.
When performing authorization, remember that there are currencies with different number of decimal places. For example: VND has no pennies and KWD has three decimal places. Please take this into account in the Amout field. For more information on other currencies, see ISO 4217. |


6.8.1. Recurring Initial transaction
The start phase is a one-time initial transaction, which is a simple e-commerce payment with forced 3-DS authentication, but contains the customer's consent to store card data for recurring subsequent purchases. Card data are stored in a secure FENIGE environment. After completing the recurring initial merchant receives the unique recurringInitialUuid identifier needed to perform subsequent Recurring Payments transactions without having to enter card data in the future.
From Jan |