1. Changelog
| Version | Date | Description |
|---|---|---|
8.8 |
2023-11-20 |
Adding information about Merchant Advice Codes. Changes in check transaction status response - new field merchantAdviceCode. Occurs only for Mastercard and for declined transactions if Mastercard returns this information |
8.7 |
2023-11-02 |
Complete end of support for 3ds version 1.0 |
8.6 |
2023-10-26 |
Added new payment method BLIK-CARD BLIK to Card |
8.5 |
2023-03-21 |
Added new optional fields for method /client/3ds/authentication regarding Cardholder Billing Information |
8.4 |
2023-02-16 |
Regexp for house number properties in each occurrences was changed |
8.3 |
2023-01-11 |
Following to the newest Mastercard Data Integrity Monitoring Program Edits for Funding Transactions all of the money transfers must contain additional informations about receiver: First name and Last name. Consequently delayed receiver type for delayed payment: Receiver Delayed was changed - required fields: firstName and lastName were added. |
8.2 |
2022-12-02 |
Added new field to receiver - country of residence. Changes in request transactions - sender country is required for merchant crypto. Added new status to check status send-money response: ERROR_TRANSACTION_BLOCKED_WITH_CARD_ISSUED_IN_GIVEN_CARD_COUNTRY |
8.1 |
2022-12-09 |
Extension of methods determine currency and currency for card by country card |
8.0 |
2022-12-01 |
Delete field 'currency' from sender models: Sender Cash and Receiver Cash. Restrict 'type' field to specific transaction types: CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER |
7.9 |
2022-11-24 |
Added new status to check status send-money response: MERCHANT_CRYPTO_OUTSIDE_EEA_UK_NOT_SUPPORTED |
7.8 |
2022-11-07 |
Documentation enhancement, minor fixes and better details for 401 UNAUTHORIZED status |
7.7 |
2022-10-26 |
Removal from use 3DS 1 for all countries (except those configured in the system) |
7.6 |
2022-10-24 |
Adding information about the withdrawal of 3DSv1. |
7.5 |
2022-10-13 |
New optional birthDay parameter added to Sender and Receiver data. This parameter may help in AML verification |
7.4 |
2022-10-12 |
Changes in Payment of Delayed Transaction - now it is enabled to include cardId without plain card number in request, look at 4. Delayed payment chapter |
7.3 |
2022-10-06 |
New statuses added for Delayed Payment: ERROR_SINGLE_TRANSACTION_LIMIT, ERROR_DAILY_TRANSACTION_LIMIT, ERROR_DAILY_COUNT_TRANSACTION_LIMIT, ERROR_MONTHLY_TRANSACTION_LIMIT, ERROR_MONTHLY_COUNT_TRANSACTION_LIMIT, ERROR_DAILY_CUMULATIVE_LIMIT, ERROR_MONTHLY_CUMULATIVE_LIMIT, ERROR_MERCHANT_MASTERCARD_DAILY_CUMULATIVE_LIMIT, ERROR_MERCHANT_MASTERCARD_MONTHLY_CUMULATIVE_LIMIT, ERROR_MERCHANT_VISA_DAILY_CUMULATIVE_LIMIT, ERROR_MERCHANT_VISA_MONTHLY_CUMULATIVE_LIMIT, ERROR_MERCHANT_DAILY_CUMULATIVE_LIMIT, ERROR_MERCHANT_MONTHLY_CUMULATIVE_LIMIT, LIMIT_ERROR. Statuses may be occurred in Delayed Send Money and in Delayed Payment methods. |
7.2 |
2022-10-03 |
Updated error responses in delayed send money / payment operations (card lock info added). New endpoints added: + Check the detailed status of a multi-currency transaction + Check the detailed status of a 3DS transaction |
7.1 |
2022-08-26 |
New status added for Delayed Payment feature: ERROR_DELAYED_PAYMENT_UNEXPECTED_EXCEPTION_OCCURRED |
7.0 |
2022-08-05 |
New request field on 3DS 2.X: challengeWindowSize |
6.9 |
2022-07-15 |
Added new fields Cardholder First Name and Last Name to Add card method. + 14.1. Add card |
6.8 |
2022-06-13 |
Delete status ERROR_TRANSACTION_USER_NAME_CONTAINS_FRAUDULENT_PART, added a new INCORRECT_NAME_DATA status that will have the same role. |
6.7 |
2022-05-09 |
Added new statuses to send-money methods: ERROR_TRANSACTION_USER_NAME_CONTAINS_FRAUDULENT_PART - Transaction rejected, sender or receiver name contains fraudulent phrase, ERROR_NAME_VERIFICATION - Transaction rejected, suspicious sender or receiver name |
6.6 |
2022-04-14 |
Added new status to check status send-money response: ERROR_VALIDATION_EXPIRY_DATE |
6.5 |
2022-04-08 |
Added new fields to check status method. Fields: merchantSettlementCurrency, fenigeCommissionInMerchantSettlementCurrency, transactionAmountInMerchantSettlementCurrency |
6.4 |
2022-03-11 |
New transaction status added (MASTERCARD_MAC_TPE_EXCELLENCE_RULE) for all transactions type to reject transaction. Transaction rejected, when second transaction with merchant advice code 03 or 21 was retried within 30 days. + 3. Send money + 4. Delayed payment |
6.3 |
2022-02-28 |
Added new field for Add Card method. It is possible to correlate Sender Card with phone number now. One phone number can hold one card per User. Additionally new status was added: ERROR_CARD_WITH_PHONE_NUMBER_EXISTS, when card with phone number exists for such User. + 14.1. Add Card |
6.2 |
2022-03-10 |
Add new PLAIN-DATACORE methods. + 3. Send money + 8. Determine currency + 9. Calculate commission |
6.1 |
2022-02-07 |
Add new response error statuses: ERROR_SINGLE_TRANSACTION_LIMIT, ERROR_DAILY_COUNT_TRANSACTION_LIMIT, ERROR_MONTHLY_TRANSACTION_LIMIT, ERROR_MONTHLY_COUNT_TRANSACTION_LIMIT. |
6.0 |
2022-01-15 |
Add new response error status: ERROR_TRANSACTION_PROCESSING_TIME_TOO_LONG + 3. Send money |
5.9 |
2021-12-06 |
New transaction status added (ERROR_TRANSACTION_GEOGRAPHIC_SCOPE_BLOCKED) for all transactions type to indicate blocked transaction in specific geographic scope + 3. Send money + 4. Delayed payment |
5.8 |
2021-12-29 |
Add new API methods for reset user password + 13. User management |
5.7 |
2021-12-10 |
Changed constraint from optional to required on country field in user management > add user. |
5.6 |
2021-12-09 |
Documentation updated. Error ERROR_CARD_ALREADY_EXISTS_FOR_ANOTHER_USER added for add card error statuses. |
5.5 |
2021-12-06 |
Updated validation for purchaseAmount in Authentication request in 3DS 2.X verification methods |
5.4 |
2021-11-16 |
Added new mandatory field when country is set to US (United States) or CA (Canada) to CASH_PLAIN and CASH_PHONE send-money methods. |
5.3 |
2021-11-08 |
Updated information about API-TOKEN refresh time in methods that require it |
5.2 |
2021-10-27 |
Add new response error statuses: ERROR_PAYMENT_CARD_COUNTRY_RESTRICTED, ERROR_FUNDING_CARD_COUNTRY_RESTRICTED, ERROR_MERCHANT_DELAYED_PAYMENT_CARD_COUNTRY_RESTRICTED, ERROR_DELAYED_PAYMENT_CARD_COUNTRY_RESTRICTED + 3. Send money + 4. Delayed payment |
5.1 |
2021-10-25 |
Removed redundant validation response statuses from methods + Card to Card + Payouts on Card + Card to Card 3D Secure + The change does not affect the API. |
5.0 |
2021-10-20 |
New status added for send-money validation error response: ERROR_MERCHANT_NOT_SUPPORT_CARD_PROVIDER 3. Send money |
4.9 |
2021-10-14 |
Added new types: DOMESTIC_PL, INTRA_EU, INTER to geographicScope field in 9. Calculate commission |
4.8 |
2021-10-05 |
Addition of an explanation of the default status ERROR_SOMETHING_WRONG for the check status send money methods + 3.1.3 Check status + 3.2.3 Check status |
4.7 |
2021-09-06 |
New merchant cumulative limits added: daily and monthly cumulative limit for all card providers. + New Statuses added: ERROR_MERCHANT_DAILY_CUMULATIVE_LIMIT, ERROR_MERCHANT_MONTHLY_CUMULATIVE_LIMIT + 3.1.3 Check status + 3.2.3 Check status |
4.6 |
2021-09-07 |
New response status ERROR_API_TOKEN_NOT_FOUND added when API-TOKEN header is not attached to DATACORE based request |
4.5 |
2021-05-05 |
An implementation of CODE_65/CODE_1A transaction rejection logic for MASTERCARD and VISA. More details can be found here: 3. Send money 4. Delayed payment |
4.4 |
2021-04-26 |
Introducing a service that validates the personal information of transaction users and Add User method data. In case of positive verification, the transaction/Add User is rejected with the status: ERROR_USER_VERIFICATION |
4.3 |
2021-04-22 |
Exclusion of deprecated currencies. Validation will reject these currencies: BYR, LTL, MRO, RUR, STD |
4.2 |
2021-03-01 |
Introduction of a new webhook functionality. Now it is possible to handle information about transaction status without polling API. + 5. Webhooks |
4.1 |
2021-02-17 |
New status: CARD_MODIFY_LIMIT_REACHED for Add/Delete Card and Add/Delete Friend Card methods. Default limits are set to 3 cards modifications e.g. Add/Delete card per user during 24h also 3 modifications for friend cards. These values could be modified for the merchant, please contact us if you need changes. |
4.0 |
2021-02-02 |
Added method Currency rate by provider which also allows you to download historical rates. |
3.9 |
2021-02-02 |
Added new fields '3DS', 'amountInUsDollar', 'provider', 'bankName' on thw response body for Check status and Transaction history methods. |
3.8 |
2021-01-18 |
New fields 'merchantUrl' and 'addressIp' in Send Money request added. Both fields are optional now, but it is recommended to include it in your request body. From 2021-05-03 the fields will be required. |
3.7 |
2021-01-13 |
New merchant cumulative limits added: daily and monthly with distinction between Mastercard and VISA. + New Statuses added: ERROR_MERCHANT_MASTERCARD_DAILY_CUMULATIVE_LIMIT, ERROR_MERCHANT_MASTERCARD_MONTHLY_CUMULATIVE_LIMIT, ERROR_MERCHANT_VISA_DAILY_CUMULATIVE_LIMIT, ERROR_MERCHANT_VISA_MONTHLY_CUMULATIVE_LIMIT + Old status to remove: ERROR_MERCHANT_MONTHLY_CUMULATIVE_LIMIT + 3.1.3 Check status + 3.2.3 Check status 3ds |
3.6 |
2021-01-05 |
Updates for 3DS 2.X |
3.5 |
2020-12-16 |
Modify personal data validation for send money methods, especially sender and receiver - firstName, lastName, email. Set minimum length 2 for firstName and lastName. FirstName and lastName cannot be the same and cannot consist of the same characters. One email address cannot be the same within sender and receiver for 2 different personal data. |
3.4 |
2020-12-03 |
Add new Delayed Payment methods. + 4. Delayed payment |
3.3 |
2020-12-02 |
New status: CARD_LIMIT_REACHED for Add Card and Add Friend Card methods. Default limits are 5 cards per user and 5 friend cards per user. These values are configured for the merchant, please contact us if you need changes |
3.2 |
2020-11-17 |
3DS 2.x method introduced in Send money + Card to Card 3D Secure |
3.1 |
2020-10-14 |
Add new VISA response code value 80 |
3.0 |
2020-10-05 |
Documentation updated. Error CURRENCY_RATES_NOT_FOUND added for send money error statuses. |
2.9 |
2020-07-09 |
Description of check card’s provided added. |
2.8 |
2020-07-03 |
Documentation updated. Error ERROR_WHILE_GETTING_COUNTRY_CODE added for Calculate commission method. |
2.7 |
2020-06-03 |
Documentation updated. Change value and description about field "md" in Initialize and Finalize methods: + 5.2. Initialize + 5.3. Finalize |
2.6 |
2020-05-21 |
User blocking for entire system operations feature added, new response for login method added. + 8.1. Login |
2.5 |
2020-03-17 |
Add information about card bin to responses of methods: Get Card List, Get Friend Card List + 10.3. Get card list + 11.4. Get friend card list |
2.4 |
2020-03-05 |
New response code from Monitoring service added: ERROR_FUNDING_BANK_IS_BLOCKED, ERROR_PAYMENT_BANK_IS_BLOCKED + 3.1.3 Check status + 3.2.3 Check status 3ds |
2.3 |
2020-01-31 |
Information about certification process added |
2.2 |
2019-10-11 |
Regular expression added to models + 13. Models |
2.1 |
2019-09-26 |
New response code from Monitoring service added + 3.1.3 Check status + 3.2.3 Check status 3ds |
2.0 |
2019-09-16 |
New response code added + 3.1.3 Check status + 3.2.3 Check status 3ds |
1.9 |
2019-09-06 |
New response code added + 3.1.3 Check status + 3.2.3 Check status 3ds |
1.8 |
2019-07-17 |
Regexp for Postal code properties in each occurrences was changed |
1.7 |
2019-07-10 |
ISO-8583 statuses updated |
1.6 |
2019-04-26 |
Datacenter migration. + Removed fields from here: 9.1 Add user + -acceptMarketing + -acceptTos + -dailyLimit |
1.5 |
2019-03-21 |
Added new method to check deposit state for CASH_CARD Merchants + 7. Check deposit state |
1.4 |
2019-01-10 |
|
1.3 |
2019-01-02 |
Added new transaction error status: ERROR_MPI_STATUS_TO_LOW: 3.2.3 Response→ 500 INTERNAL SERVER ERROR |
1.2 |
2018-11-27 |
Documentation updated. Change description about response field "prefix" in: 9.5. Get countries |
1.1 |
2018-11-22 |
Documentation updated. Added information about errors related to incompatible country codes of User and User’s card for USA or CAN transaction in: 3.1.2. Response→ 200 OK - Error validation, 3.2.2. Response → 200 OK - Error validation. |
1.0 |
2018-06-25 |
First release of documentation. |
2. Introduction
Document describes technical scope of the "Fenige Transfer HUB REST API" i.e. services, which is financial institution that processes credit or debit card payments.
Quick tutorial that may helps you in works with API you can find here: Tutorial
Documentation has been prepared for external partners that are willing to cooperate with Fenige and offer MoneySend card-to-card P2P transactions inside their mobile or web applications. The roles of Fenige and Partner in such project are the following:
Partner:
Fenige:
High Level Architecture:
Transaction process:
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 partner receives access to the production environment. Be adviced that the entire process takes place in a staging environment.
2.2. Endpoints
| Environment | Endpoint (base url) |
|---|---|
Staging |
2.3. 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.4. User authentication
Authentication in HUB API is done by basic authentication and two token mechanism.
-
API-TOKEN - we can use this authentication method when client is integrated only with HUB application.
-
X-Request-Token, X-Device-ID - this authentication method is using by mobile devices which are in communication with different server.
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 |
|
application/vnd.sendmoney.v2+json |
Optional |
Used for send-money with multi-currency purpose |
|
application/vnd.sendmoney3ds.v2+json |
Optional |
Used for send-money-3ds with multi-currency purpose |
|
application/vnd.determine-currencies.v2+json |
Optional |
Used for determine currencies with multi-currency purpose |
|
application/vnd.calculate-commission.v2+json |
Optional |
Used for calculate commission with multi-currency purpose |
|
Basic dGVzdDp0ZXN0 |
Required |
Used to resolve merchant context of user. Basic Auth from merchant data (merchant name and password). Consist of keyword Basic and string obtained from Base64 coding method for merchant name and password parameter |
|
BMT4wKduNftnN3AUkkKnm4BJEqiMKZlcdLiKRtJH9ac= |
Optional |
Some of the methods require additional authentication. The API-TOKEN is obtained by calling the logUser method. API-TOKEN is valid for 30 minutes |
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 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.8. Mastercard/VISA response code (ISO 8583):
| 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. Merchant advice codes
Merchant Advice Codes (MACs) are introduced by Mastercard to clearly communicate to merchants the reason for declining transactions, and the course of action that merchants can take. Occurs only for declined transactions if Mastercard returns this information.
| Merchant Advice Code | Merchant Advice Code Text |
|---|---|
|
New account information available |
|
Cannot approve at this time, try again later |
|
Do not try again |
|
Token not supported |
|
Stop recurring payment |
|
Retry after 1 hour |
|
Retry after 24 hours |
|
Retry after 2 days |
|
Retry after 4 days |
|
Retry after 6 days |
|
Retry after 8 days |
|
Retry after 10 days |
|
Consumer non-reloadable prepaid card |
|
Consumer single-use virtual card number |
3. Send money
See a diagrams bellow and notice that CARD-CARD and CASH-CARD flow are not the same.
|
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:
|
Is apply for: PLAIN-PLAIN, DATACORE-PLAIN, DATACORE-DATACORE, DATACORE-PHONE
Is apply for: CASH-PLAIN, CASH-PHONE
Is apply for: BLIK-PLAIN
3.1. Card to Card
Innovative technology that allows to send money between cards instantly anywhere in the world. No SWIFT or bank account number needed!
This method is used to MoneySend transaction (funding and payment). To enable users to make transfers in any currency, Fenige introduces the send-money method for multicurrency.
1 - User by selecting type = SENDER defines amount of funding in given currency. This amount is collected from sender card in selected currency. 2 - User by selecting type = RECEIVER defines amount of payment in given currency. This amount is transferred to receiver card in selected currency. In case there's need revaluation from one currency to another, system uses lowerRate for situation 1 and higherRate for situation 2. For more details about specific rates please refer to Currency Rate method.
*API-TOKEN is required for methods: DATACORE-PLAIN, PLAIN-DATACORE, DATACORE-DATACORE, DATACORE-PHONE
| The API-TOKEN is refreshed each time it is used in the header. The API-TOKEN is refreshed for 30 minutes. |
| Please notice that you can choose language of email confirmation of this transaction. It is able by attach proper header to request. |
The success of the multicurrency send-money transaction depends primarily on the correctness of the merchant's currency configuration which is done by the admin. To make transactions in a currency other than the currency of the card, contact the admin.
In order to provide users with the ability to safely retry transaction (for example to request for an undelivered response), the v2 of API supports idempotent send money multi-currency operation.
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant 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. |
3.1.1. Request
Request fields
| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
amount |
Number |
Required |
@NotNull, positive |
The total transfer amount (in pennies) |
cvc2 |
String |
Required |
@Length(min = 3, max = 3) |
Sender card cvc2/cvv2 |
merchantUrl |
String |
Required except CASH-PLAIN transactions. |
@NotNull except CASH-PLAIN |
Merchant identifier such as the business website URL or reverse domain name as presented to the consumer during checkout |
addressIp |
String |
Required except CASH-PLAIN transactions @Must conform to the IPv4 or IPv6 standard. |
@NotNull except CASH-PLAIN |
The IP address of the order of transaction. |
type |
String |
Required |
@NotNull |
Transaction in 'SENDER' or 'RECEIVER' currency, for specific transaction type. CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER. |
requestId |
String |
Required |
@NotNull |
128 bit number generated by the user, used to identify single transaction. Ensures that the transaction with the given parameter is processed only once. |
transactionId |
String |
Optional |
@Length(max = 64) |
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. |
sender |
Object |
Required |
@NotNull |
|
receiver |
Object |
Required |
@NotNull |
Receiver PLAIN Receiver CASH Receiver DATACORE Receiver PHONE |
Example HTTP Request
POST /api/v2/client/send-money HTTP/1.1
Content-Type: application/vnd.sendmoney.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 877
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"requestId" : "fe89c1a2-9a78-42e8-aae6-4499a739810f",
"transactionId" : "TRX220132AM",
"sender" : {
"type" : "PLAIN",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardNumber" : "5117964247989169",
"expirationDate" : "03/26",
"personalId" : "AGC688910",
"currency" : "PLN"
},
"receiver" : {
"type" : "PLAIN",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-12-09",
"cardNumber" : "5117964247989169",
"currency" : "PLN",
"countryOfResidence" : "PL"
}
}POST /api/v2/client/send-money HTTP/1.1
Content-Type: application/vnd.sendmoney.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 903
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"requestId" : "d2328e8c-5fc5-4ff2-88e3-337beeabc1df",
"transactionId" : "TRX220132AM",
"sender" : {
"type" : "PLAIN",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardNumber" : "5117964247989169",
"expirationDate" : "03/26",
"personalId" : "AGC688910",
"currency" : "PLN"
},
"receiver" : {
"type" : "DATACORE",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "receiverEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardId" : 1234,
"currency" : "PLN",
"countryOfResidence" : "PL"
}
}POST /api/v2/client/send-money HTTP/1.1
Content-Type: application/vnd.sendmoney.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 798
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"requestId" : "35dc2780-ab12-4c66-a54f-1c9eadb3fcf4",
"transactionId" : "TRX220132AM",
"sender" : {
"type" : "DATACORE",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardId" : 1234,
"currency" : "PLN"
},
"receiver" : {
"type" : "PLAIN",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-12-09",
"cardNumber" : "5117964247989169",
"currency" : "PLN",
"countryOfResidence" : "PL"
}
}POST /api/v2/client/send-money HTTP/1.1
Content-Type: application/vnd.sendmoney.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 824
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"requestId" : "def0607f-081a-4fbe-b14d-577a70e14b84",
"transactionId" : "TRX220132AM",
"sender" : {
"type" : "DATACORE",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardId" : 1234,
"currency" : "PLN"
},
"receiver" : {
"type" : "DATACORE",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "receiverEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardId" : 1234,
"currency" : "PLN",
"countryOfResidence" : "PL"
}
}POST /api/v2/client/send-money HTTP/1.1
Content-Type: application/vnd.sendmoney.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 794
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"requestId" : "8632d0ec-4584-4ad1-97bb-da58ccafc8c2",
"transactionId" : "TRX220132AM",
"sender" : {
"type" : "DATACORE",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardId" : 1234,
"currency" : "PLN"
},
"receiver" : {
"type" : "PHONE",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-12-09",
"phoneNumber" : "48123777619",
"currency" : "PLN",
"countryOfResidence" : "PL"
}
}
3.1.2. Response
Response status
| Status | Description |
|---|---|
|
Returned list of field name which has validation errors. |
|
- Returned when the transaction with the provided requestId has been registered in the system, but has not yet been completed. The user can retry in a few seconds to get the transaction result. Response body: Empty |
|
Returned e.g. when a different transaction with the provided requestId has already been registered in the system. |
|
Returned when API-TOKEN was broken. |
Example HTTP Response
HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 56
{
"orderId" : "1a43d209-a470-42a4-a876-1d1411b8f6a3"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Unique transaction identifier |
HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 104
{
"error" : {
"message" : "Another transaction with the same id has already been processed."
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [{
"field": "requestId",
"message": [
"may not be null"
]
},
{
"field": "cvc2",
"message": [
"may not be null",
"length must be 3"
]
},
{
"field": "type",
"message": [
"may not be null"
]
},
{
"field": "amount",
"message": [
"may not be null"
]
},
{
"field": "sender",
"message": [
"may not be null"
]
},
{
"field": "sender.cardNumber",
"message": [
"may not be null",
"may not be empty",
"card number length must be 16"
]
},
{
"field": "sender.expirationDate",
"message": [
"invalid card expiration date",
"may not be null",
"may not be empty"
]
},
{
"field": "sender.city",
"message": [
"may not be empty",
"may not be null",
"length must be between 1 and 25"
]
},
{
"field": "sender.street",
"message": [
"may not be null",
"may not be empty",
"length must be between 1 and 50"
]
},
{
"field": "sender.postalCode",
"message": [
"may not be empty",
"may not be null",
"length must be between 1 and 10"
]
},
{
"field": "sender.flatNumber",
"message": [
"must be null",
"length must be between 0 and 5"
]
},
{
"field": "sender.lastName",
"message": [
"may not be empty",
"may not be null",
"length must be between 2 and 35"
]
},
{
"field": "sender.houseNumber",
"message": [
"may not be empty",
"may not be null",
"length must be between 1 and 10",
"must match the expression: ^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$"
]
},
{
"field": "sender.firstName",
"message": [
"may not be empty",
"may not be null",
"length must be between 2 and 35"
]
},
{
"field": "sender.email",
"message": [
"may not be empty",
"may not be null",
"not a well-formed email address",
"lenght must be beetween 1 and 128"
]
},
{
"field": "receiver",
"message": [
"may not be null"
]
},
{
"field": "receiver.firstName",
"message": [
"may not be empty",
"may not be null",
"length must be between 2 and 35"
]
},
{
"field": "receiver.lastName",
"message": [
"may not be empty",
"may not be null",
"length must be between 2 and 35"
]
},
{
"field": "receiver.currency",
"message": [
"may not be null"
]
},
{
"field": "receiver.cardNumber",
"message": [
"may not be null",
"may not be empty",
"card number length must be 16"
]
},
{
"field": "sender",
"message": [
"province is mandatory only if country code is US or CA"
]
},
{
"field": "sender.province",
"message": [
"is not correct province code for country code US",
"may not be null"
]
},
{
"field": "sender.province",
"message": [
"may not be null",
"is not correct province code for country code CA"
]
},
{
"field": "sender.province",
"message": [
"must match ^[A-Z]{2}$",
"is not correct province code for country code US"
]
},
{
"field": "sender.currency",
"message": [
"Currency is not supported"
]
},
{
"field": "receiver.currency",
"message": [
"Currency is not supported"
]
}
]
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_API_TOKEN_NOT_FOUND",
"error": {
"message": "API-TOKEN header not found in request with DATACORE/PHONE model in sender or receiver."
}
}HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
"timestamp": "2021-12-22T12:39:53.168+0000",
"status": 401,
"error": "Unauthorized",
"message": "Username or password is not correct",
"path": "/api/v2/client/send-money"
}HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
"timestamp": "2021-12-22T12:39:53.168+0000",
"status": 401,
"error": "Unauthorized",
"message": "ERROR_USER_NOTFOUND",
"path": "/api/v2/client/send-money"
}| Path | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
HTTP/1.1 403 Forbidden
Content-Type: application/json
{
"timestamp": 1610464313387,
"status": 403,
"error": "Forbidden",
"message": "No message available",
"path": "/client/send-money-3ds"
}3.1.3. Check status
The method allows obtaining a status of multi-currency transaction specified by order-id. Parameter order-id was returned in the previous step (Send money multicurrency).
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant will be informed about each access restriction action. |
Request
| Parameter | Description |
|---|---|
|
Unique transaction identifier. |
GET /client/send-money/00549d98-08cb-45d2-8673-4dcafa81f498 HTTP/1.1
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181Response
Response status
| Status | Description |
|---|---|
|
Returned if the transaction completes successfully. |
|
Returned when transaction was registered for processing. Check status in a while. |
|
Returned when user provides wrong order-id or transaction was failed or was Declined. |
Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1123
{
"transactionId" : "TRX220132AM",
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"fundingRrn" : "014011103023",
"paymentRrn" : "014011103024",
"arn" : "05411640143500000019325",
"3DS" : true,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "511796******9169",
"bankName" : "Alior Bank SA"
}
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. @Length(max = 64). Optional |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Acquirer Reference Number |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender currency and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 203 Non-Authoritative Information| After you get 203 you need to check status in a while because we processing this transaction and if you don’t get a response (200 - succeeded or 500 - declined) within 60 seconds then please contact us. |
HTTP/1.1 500 Internal Server Error
Content-Type: text/plain;charset=ISO-8859-1
PAYMENT_TRANSACTION_DECLINED:CODE_05| After receiving these statuses, the transaction was rejected |
Error statuses
| Name | Description |
|---|---|
|
CODE_XX - is MasterCard response code (ISO 8583) |
|
This card is not supported |
|
Card is blocked for 1 hour in Fenige |
|
User is blocked in Fenige |
|
Bin is blocked for 1 hour in Fenige |
|
Funding bank is blocked in Fenige |
|
Payment bank is blocked in Fenige |
|
Funding transaction was declined and payment not send |
|
Payment transaction was declined and funding was reversed |
|
A connection error occurred to Acquirer service |
|
User was found on the stop list |
|
Acceptance network is unavailable |
|
No currently effective rates found in the database |
|
Currency is not supported |
|
Currency is not supported by Merchant |
|
Transaction limit for single transaction exceeded |
|
Daily transaction limit for amount per card exceeded |
|
Daily transaction limit for count per card exceeded |
|
Monthly transaction limit for amount per card exceeded |
|
Monthly transaction limit for count per card exceeded |
|
Daily cumulative limit per card was exceeded |
|
Monthly cumulative limit per card was exceeded |
|
Daily cumulative limit per merchant transactions using mastercard cards was exceeded |
|
Monthly cumulative limit per merchant transactions using mastercard cards was exceeded |
|
Daily cumulative limit per merchant transactions using visa cards was exceeded |
|
Monthly cumulative limit per merchant transactions using visa cards was exceeded |
|
Daily cumulative limit per merchant transactions using mastercard and visa cards was exceeded |
|
Monthly cumulative limit per merchant transactions using mastercard and visa cards was exceeded |
|
Sender’s card is blocked |
|
Receiver’s card is blocked |
|
User acting as sender is blocked |
|
User acting as receiver is blocked |
|
BIN of sender’s card is blocked |
|
BIN of receiver’s card is blocked |
|
Amount is higher than acceptable limit |
|
Couldn’t established connection to Monitoring service |
|
Error with service authorization occurred |
|
Some unrecognized error occurred |
|
The transaction user’s personal data verified as incorrect on the verification service. Transaction rejected. |
|
Funding transaction declined - mip response timeout |
|
Payment transaction declined - mip response timeout |
|
Funding process failed and it is need to manual verification of transaction |
|
Payment process failed and it is need to manual verification of transaction |
|
Funding transaction declined - mip_proxy response timeout |
|
Payment transaction declined - mip_proxy response timeout |
|
Amount exceeds current merchant deposit limit |
|
Error transaction not exists |
|
Card was not found |
|
Problem with DC |
|
ERROR_SOMETHING_WRONG returned when the check status method is executed means that the details for the indicated transaction could not be retrieved correctly due to an unexpected error. This does not mean that the transaction was rejected by our system. In case of receiving ERROR_SOMETHING_WRONG status, please do not hesitate to notify our support team in order to determine the correctness of the transaction execution and quickly correct the method error. |
|
This error may occur if card’s country is other than user’s country for USA or CAN transaction for PLAIN model |
|
This error may occur if card’s country is other than user’s country for USA or CAN transaction |
|
This error may occur when system could not get card country code. Most often, the error is caused by a missing card in the parameters received from the card provider. |
|
Province code is not valid for USA or CAN transactions. Please update user profile |
|
Some validation error occurred |
|
This error may occur when merchant tries to make transaction in other model than assigned primarily. For example, if merchant’s model is set as CARD-CARD and then merchant will try to make transaction in CASH-CARD model, will receive error as bellow. |
|
Card expired |
|
The amount sent is too small. Enter a larger amount. |
|
The amount sent is too high. Enter a lower amount. |
|
Restricted funding card country was used. + This error may occur when a merchant uses a sender card issued in a country that is on the list of countries High Risk or country not allowed to perform transactions in Fenige API. Please contact support. |
|
Restricted payment card country was used. + This error may occur when a merchant uses a sender card issued in a country that is on the list of countries High Risk or country not allowed to perform transactions in Fenige API. Please contact support. |
|
Merchant not support the given card provider, please contact support to check merchant configuration |
|
Merchant crypto is not supported outside EEA+UK |
|
System does not allow the execution of transaction with the receiver card country. |
|
System does not allow the execution of transaction with the sender card country. |
|
Geographic scope is not permitted for this transaction |
|
Processing time of transaction was too long, transaction is declined. |
|
Transaction rejected, second transaction with merchant advice code 03 or 21 within 30 days. |
|
Transaction rejected, sender or receiver name contains fraudulent phrase. |
|
Transaction rejected, suspicious sender or receiver name. |
|
Transaction rejected, card country is not supported for merchants crypto. |
3.1.4. Check detailed status
The method allows obtaining a detailed status of multi-currency transaction specified by order-id. Parameter order-id was returned in the previous step (Send money multicurrency).
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant will be informed about each access restriction action. |
Request
| Parameter | Description |
|---|---|
|
Unique transaction identifier. |
GET /client/send-money/details/00549d98-08cb-45d2-8673-4dcafa81f498 HTTP/1.1
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181Response
Response status
| Status | Description |
|---|---|
|
Returned if the transaction completes successfully. |
|
Returned when transaction was registered for processing. Check status in a while. |
|
Returned when a transaction related to the given orderId doesn’t exist. |
|
Returned when user provides wrong order-id or transaction was failed or was Declined. |
|
Returned when an internal error occur. |
Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1159
{
"transactionId" : "TRX220132AM",
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"fundingRrn" : "014011103023",
"paymentRrn" : "014011103024",
"arn" : "05411640143500000019325",
"3DS" : true,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "511796******9169",
"bankName" : "Alior Bank SA"
},
"transactionStatus" : "APPROVED"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. @Length(max = 64). Optional |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Acquirer Reference Number |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender currency and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
|
|
Status of the transaction (PENDING, APPROVED, DECLINED, REJECTED, REVERSED) |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 203 Non-Authoritative Information| After you get 203 you need to check status in a while because we processing this transaction and if you don’t get a response (200 - succeeded or 500 - declined) within 60 seconds then please contact us. |
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 51
{
"errorStatus" : "ERROR_TRANSACTION_NOT_FOUND"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Additional data of the error occurred during a processing of the request |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 1287
{
"transactionId" : "TRX220132AM",
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"fundingRrn" : "014011103023",
"paymentRrn" : "014011103024",
"arn" : "05411640143500000019325",
"3DS" : true,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "511796******9169",
"bankName" : "Alior Bank SA"
},
"transactionStatus" : "DECLINED",
"cardBlockType" : "TEMP",
"cardBlockedUntil" : "2023-12-11T01:03:14.925",
"errorStatus" : "ERROR_SENDER_CARD_IS_BLOCKED"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. @Length(max = 64). Optional |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Acquirer Reference Number |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender currency and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
|
|
Status of the transaction (PENDING, APPROVED, DECLINED, REJECTED, REVERSED) |
|
|
Additional data of the error occurred during a processing of the request |
|
|
Card lock type |
|
|
Card’s lock end date |
|
|
Information about the reasons for declined transactions and actions that merchants can take. Occurs only for mastercard and for rejected transactions if Mastercard returns this information |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 1358
{
"transactionId" : "TRX220132AM",
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"fundingRrn" : "014011103023",
"paymentRrn" : "014011103024",
"arn" : "05411640143500000019325",
"3DS" : false,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "CASH"
},
"transactionStatus" : "DECLINED",
"merchantSettlementCurrency" : "USD",
"fenigeCommissionInMerchantSettlementCurrency" : 0.05,
"transactionAmountInMerchantSettlementCurrency" : 2.68,
"cardBlockType" : "TEMP",
"cardBlockedUntil" : "2023-12-11T01:03:15.457",
"errorStatus" : "ERROR_SENDER_CARD_IS_BLOCKED"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. @Length(max = 64). Optional |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Acquirer Reference Number |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender currency and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
|
|
Merchant settlement currency |
|
|
Commission Fenige in merchant settlement currency |
|
|
Transaction amount in merchant settlement currency |
|
|
Status of the transaction (PENDING, APPROVED, DECLINED, REJECTED, REVERSED) |
|
|
The code of the error occurred during a processing of the request |
|
|
Card lock type |
|
|
Card’s lock end date |
|
|
Information about the reasons for declined transactions and actions that merchants can take. Occurs only for mastercard and for declined transactions if Mastercard returns this information |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 69
{
"errorStatus" : "ERROR_SOMETHING_WRONG - Something went wrong."
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Additional data of the error occurred during a processing of the request |
3.1.5. Transaction history
Method return page with list of user transactions. Transactions are filtered by clientId provided in GET parameter.
User can send additional optional parameters (page, size) to obtain given page with defined size.
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant will be informed about each access restriction action. |
Request
GET /client/0/transactions?fromDate=2018-03-06&toDate=2018-03-08&page=0&size=100 HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181Response
Response status
| Status | Description |
|---|---|
|
Returned list of transactions history. |
|
Returning the list failed. |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1118
{
"content" : [ {
"correlationId" : "a725f850-4d1e-4b2f-8dd1-6d56aedde0a8",
"createdDate" : "2018-03-15T10:24:52.149Z",
"amount" : 15000,
"amountInUsDollar" : 4024,
"textAmount" : "150.00 PLN",
"currency" : "PLN",
"cardId" : 3574,
"receiverFirstName" : "Patrick",
"receiverLastName" : "Evans",
"receiverHiddenCardNumber" : "511123******1234",
"receiverProvider" : "MASTERCARD",
"receiverBankName" : "Bank Polska Kasa Opieki Spółka Akcyjna",
"receiverEmail" : "receiver@fenige.pl",
"receiverPhone" : "600300200",
"senderFirstName" : "Rob",
"senderLastName" : "Wring",
"senderHiddenCardNumber" : "522212******4321",
"senderProvider" : "MASTERCARD",
"senderBankName" : "Alior Bank SA",
"status" : "approved",
"transactionDirection" : "OUTGOING",
"3DS" : false
} ],
"pageable" : "INSTANCE",
"last" : true,
"totalElements" : 1,
"totalPages" : 1,
"size" : 1,
"number" : 0,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"first" : true,
"numberOfElements" : 1,
"empty" : false
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Unique UUID describing single transaction in system |
|
|
Date of transaction processing |
|
|
Transaction amount in pennies |
|
|
Transaction amount in USD currency in pennies. |
|
|
Transaction amount with currency |
|
|
Transaction currency |
|
|
Datacore card id used in transaction (sender card) |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Transaction receiver first name |
|
|
Transaction receiver last name |
|
|
Transaction receiver hidden card number |
|
|
VISA or MASTERCARD or MAESTRO |
|
|
Transaction receiver card bank name. |
|
|
Transaction sender first name. |
|
|
Transaction sender last name. |
|
|
Transaction sender hidden card numbe. |
|
|
VISA or MASTERCARD or MAESTRO |
|
|
Transaction sender card bank name. |
|
|
Transaction receiver phone number |
|
|
Transaction receiver email |
|
|
Status of the transaction (approved, reversed) |
|
|
Direction of the transaction (INCOMING, OUTGOING) |
|
|
Information about the reasons for declined transactions and actions that merchants can take. Occurs only for mastercard and for rejected transactions if Mastercard returns this information |
|
|
Describes whether the page is last (true ot false) |
|
|
Total number of all pages |
|
|
Total number of all transactions |
|
|
Number of transactions on page |
|
|
Describes whether the page is first (true ot false) |
|
|
Details of sort |
|
|
Max number of transactions on page |
|
|
Page number |
|
|
Page number |
HTTP/1.1 404 Not Found3.1.6. Transaction details
Method return transaction details for single transaction given in method parameter orderId
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant will be informed about each access restriction action. |
Request
GET /client/transactions/fae3ee90-6f88-4aa6-aff5-7d9f6a5645d3 HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181Response
Response status
| Status | Description |
|---|---|
|
Returned details of transaction. |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 297
{
"fundingAmount" : "2.00 PLN",
"chargedAmount" : "2.04 PLN",
"commission" : "0.04 PLN",
"paymentAmount" : "0.54 USD",
"exchange" : "1.00 PLN = 0.27 USD",
"transactionTime" : "2018-07-26T17:01:56.364Z",
"cardIssuer" : "MASTERCARD",
"amountInUsDollar" : 1,
"status" : "approved"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Funding amount in transaction currency |
|
|
Charged amount in transaction currency |
|
|
Transaction commission with currency |
|
|
Payment amount in receiver currency |
|
|
Revaluation amount from sender to receiver currency |
|
|
Date of the transaction |
|
|
Card issuer MASTERCARD/VISA |
|
|
Transaction amount in USD currency in pennies |
|
|
Status of transaction approved/reject/decline |
3.2. Card to Card 3D Secure
Innovative technology that allows to send money between cards instantly anywhere in the world. No SWIFT or bank account number needed!
This method is used to MoneySend transaction (funding and payment). To enable users to make transfers in any currency, Fenige introduces the send-money method for multicurrency. The method allows executing transactions with additional protection i.e. verification by the 3DS (3D-Secure) in 2.X standard.
1 - User by selecting type = SENDER defines amount of funding in given currency. This amount is collected from sender card in selected currency. 2 - User by selecting type = RECEIVER defines amount of payment in given currency. This amount is transferred to receiver card in selected currency. In case there's need revaluation from one currency to another, system uses lowerRate for situation 1 and higherRate for situation 2. For more details about specific rates please refer to Currency Rate method.
*API-TOKEN is required for methods: DATACORE-PLAIN, PLAIN-DATACORE, DATACORE-DATACORE, DATACORE-CASH, DATACORE-PHONE
| The API-TOKEN is refreshed each time it is used in the header. The API-TOKEN is refreshed for 30 minutes. |
| 3DS 2.X transaction requires additional parameters, but the flow of transaction is the same as transaction without 3DS. |
| Please notice that you can choose language of email confirmation of this transaction. It is able by attach proper header to request. |
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant 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. |
3.2.1. Request
Request fields
| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
amount |
Number |
Required |
@NotNull, positive |
The total transfer amount (in pennies). |
cvc2 |
String |
Required |
@Length(min = 3, max = 4) |
Sender Card cvc2/cvv2. |
merchantUrl |
String |
Required except CASH-PLAIN transactions. |
@NotNull except CASH-PLAIN |
Merchant identifier such as the business website URL or reverse domain name as presented to the consumer during checkout |
addressIp |
String |
Required except CASH-PLAIN transactions @Must conform to the IPv4 or IPv6 standard. |
@NotNull except CASH-PLAIN |
The IP address of the order of transaction. |
type |
String |
Required |
@NotNull |
Transaction in 'SENDER' or 'RECEIVER' currency, for specific transaction type. CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER. |
requestId |
String |
Required |
@NotNull |
128 bit number generated by the user, used to identify single transaction. Ensures that the transaction with the given parameter is processed only once. |
sender |
Object |
Required |
@NotNull |
|
receiver |
Object |
Required |
@NotNull |
Receiver PLAIN Receiver CASH Receiver DATACORE Receiver PHONE |
outside3ds.cavv |
String |
Required |
@NotNull |
Server transaction Id generated by DS. Required for 3DS 2.X version |
outside3ds.eci |
String |
Required |
@NotNull |
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 |
Required |
@NotNull |
Authentication status. If AuthenticationStatus is "Y" or "A" then outside 3ds flow will be execute. |
outside3ds.transactionXId |
String |
Required |
@NotNull |
Cardholder Authentication Verification Value. 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. |
Example HTTP Request
POST /api/v2/client/send-money-3ds HTTP/1.1
Content-Type: application/vnd.sendmoney3ds.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 1025
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"authenticationStatus" : "Y",
"eci" : "01",
"transactionXId" : "c561018f-b21d-444a-a126-3dbc63a53b4a"
},
"requestId" : "fb899fa3-c5cb-4cd5-b948-378301d202c1",
"sender" : {
"type" : "PLAIN",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardNumber" : "5117964247989169",
"expirationDate" : "03/26",
"personalId" : "AGC688910",
"currency" : "PLN"
},
"receiver" : {
"type" : "PLAIN",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-12-09",
"cardNumber" : "5117964247989169",
"currency" : "PLN",
"countryOfResidence" : "PL"
}
}POST /api/v2/client/send-money-3ds HTTP/1.1
Content-Type: application/vnd.sendmoney3ds.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 1051
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"authenticationStatus" : "Y",
"eci" : "01",
"transactionXId" : "bee389ab-55a7-4239-a85e-e438afaeaaca"
},
"requestId" : "4f4916e6-4733-450c-9491-118bdb47f6e0",
"sender" : {
"type" : "PLAIN",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardNumber" : "5117964247989169",
"expirationDate" : "03/26",
"personalId" : "AGC688910",
"currency" : "PLN"
},
"receiver" : {
"type" : "DATACORE",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "receiverEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardId" : 1234,
"currency" : "PLN",
"countryOfResidence" : "PL"
}
}POST /api/v2/client/send-money-3ds HTTP/1.1
Content-Type: application/vnd.sendmoney3ds.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 946
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"authenticationStatus" : "Y",
"eci" : "01",
"transactionXId" : "b62bf3aa-3977-40f0-ad2c-a447626659ec"
},
"requestId" : "39f4d398-2737-41b3-9ff8-c7c85eb975c3",
"sender" : {
"type" : "DATACORE",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardId" : 1234,
"currency" : "PLN"
},
"receiver" : {
"type" : "PLAIN",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-12-09",
"cardNumber" : "5117964247989169",
"currency" : "PLN",
"countryOfResidence" : "PL"
}
}POST /api/v2/client/send-money-3ds HTTP/1.1
Content-Type: application/vnd.sendmoney3ds.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 972
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"authenticationStatus" : "Y",
"eci" : "01",
"transactionXId" : "ffba9563-7c9b-4ef8-9aeb-1e197d1abcff"
},
"requestId" : "cab874bd-adb7-4655-a4f1-9c1031408888",
"sender" : {
"type" : "DATACORE",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardId" : 1234,
"currency" : "PLN"
},
"receiver" : {
"type" : "DATACORE",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "receiverEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardId" : 1234,
"currency" : "PLN",
"countryOfResidence" : "PL"
}
}POST /api/v2/client/send-money-3ds HTTP/1.1
Content-Type: application/vnd.sendmoney3ds.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 942
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"authenticationStatus" : "Y",
"eci" : "01",
"transactionXId" : "0473bcc5-212c-479d-ac18-56e44c697845"
},
"requestId" : "39fea0a9-8add-4c94-b883-8f4055b64cbe",
"sender" : {
"type" : "DATACORE",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardId" : 1234,
"currency" : "PLN"
},
"receiver" : {
"type" : "PHONE",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-12-09",
"phoneNumber" : "48123777619",
"currency" : "PLN",
"countryOfResidence" : "PL"
}
}
POST /api/v2/client/send-money-3ds HTTP/1.1
Content-Type: application/vnd.sendmoney3ds.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 1092
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"authenticationStatus" : "Y",
"eci" : "01",
"transactionXId" : "6b44d04e-1159-4bab-a732-0bd5fae27263"
},
"requestId" : "88e0c5b9-65e5-429f-8423-f4c10ff75e26",
"sender" : {
"type" : "PLAIN",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardNumber" : "5117964247989169",
"expirationDate" : "03/26",
"personalId" : "AGC688910",
"currency" : "PLN"
},
"receiver" : {
"type" : "CASH",
"firstName" : "Rob",
"lastName" : "Wring",
"street" : "Lubelska",
"houseNumber" : "17A",
"city" : "Lubartów",
"postalCode" : "21-100",
"flatNumber" : "2",
"email" : "receiverEmail@fenige.pl",
"country" : "PL"
}
}POST /api/v2/client/send-money-3ds HTTP/1.1
Content-Type: application/vnd.sendmoney3ds.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 1013
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"authenticationStatus" : "Y",
"eci" : "01",
"transactionXId" : "33f22b37-c5bc-4deb-be55-ef20798447d6"
},
"requestId" : "4c5b0629-44b0-484e-80bd-67a254486357",
"sender" : {
"type" : "DATACORE",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardId" : 1234,
"currency" : "PLN"
},
"receiver" : {
"type" : "CASH",
"firstName" : "Rob",
"lastName" : "Wring",
"street" : "Lubelska",
"houseNumber" : "17A",
"city" : "Lubartów",
"postalCode" : "21-100",
"flatNumber" : "2",
"email" : "receiverEmail@fenige.pl",
"country" : "PL"
}
}3.2.2. Response
Response status
| Status | Description |
|---|---|
|
Returned if the transaction completes successfully. |
|
Returned list of field name which has validation errors. |
|
Returned when the transaction with the provided requestId has been registered in the system, but has not yet been completed. The user can retry in a few seconds to get the transaction result. |
|
Returned e.g. when a different transaction with the provided requestId has already been registered in the system. |
|
Returned when API-TOKEN was broken. |
Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 54
{
"orderId": "234abf25-c35f-a263-a402-cbaf874f137a"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
OrderId |
HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [{
"field": "requestId",
"message": [
"may not be null"
]
},
{
"field": "cvc2",
"message": [
"may not be null",
"length must be 3"
]
},
{
"field": "amount",
"message": [
"may not be null"
]
},
{
"field": "type",
"message": [
"may not be null"
]
},
{
"field": "sender",
"message": [
"may not be null"
]
},
{
"field": "sender.houseNumber",
"message": [
"may not be null",
"may not be empty",
"length must be between 1 and 10"
]
},
{
"field": "sender.street",
"message": [
"may not be null",
"may not be empty",
"length must be between 1 and 50"
]
},
{
"field": "sender.firstName",
"message": [
"may not be null",
"may not be empty",
"length must be between 2 and 35"
]
},
{
"field": "sender.lastName",
"message": [
"may not be empty",
"may not be null",
"length must be between 2 and 35"
]
},
{
"field": "sender.postalCode",
"message": [
"may not be empty",
"may not be null",
"length must be between 1 and 10"
]
},
{
"field": "sender.city",
"message": [
"may not be empty",
"may not be null",
"length must be between 1 and 25"
]
},
{
"field": "sender.flatNumber",
"message": [
"must be null",
"length must be between 0 and 5"
]
},
{
"field": "sender.cardNumber",
"message": [
"may not be null",
"may not be empty",
"card number length must be 16"
]
},
{
"field": "sender.email",
"message": [
"may not be empty",
"may not be null",
"not a well-formed email address",
"lenght must be beetween 1 and 128"
]
},
{
"field": "sender.expirationDate",
"message": [
"invalid card expiration date",
"may not be null",
"may not be empty"
]
},
{
"field": "receiver",
"message": [
"may not be null"
]
},
{
"field": "receiver.firstName",
"message": [
"may not be null",
"may not be empty",
"length must be between 2 and 35"
]
},
{
"field": "receiver.lastName",
"message": [
"may not be empty",
"may not be null",
"length must be between 2 and 35"
]
},
{
"field": "receiver.currency",
"message": [
"may not be null"
]
},
{
"field": "receiver.cardNumber",
"message": [
"may not be null",
"may not be empty",
"card number length must be 16"
]
},
{
"field": "sender",
"message": [
"province is mandatory only if country code is US or CA"
]
},
{
"field": "sender.province",
"message": [
"is not correct province code for country code US",
"may not be null"
]
},
{
"field": "sender.province",
"message": [
"may not be null",
"is not correct province code for country code CA"
]
},
{
"field": "sender.province",
"message": [
"must match ^[A-Z]{2}$",
"is not correct province code for country code US"
]
},
{
"field": "sender.currency",
"message": [
"Currency is not supported"
]
},
{
"field": "receiver.currency",
"message": [
"Currency is not supported"
]
}
]
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_API_TOKEN_NOT_FOUND",
"error": {
"message": "API-TOKEN header not found in request with DATACORE/PHONE model in sender or receiver."
}
}HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 56
{
"orderId" : "805fa18f-7121-4254-b40e-7911b12f9cda"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Transaction order-id |
HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 104
{
"error" : {
"message" : "Another transaction with the same id has already been processed."
}
}HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
"timestamp": "2021-12-22T12:39:53.168+0000",
"status": 401,
"error": "Unauthorized",
"message": "Username or password is not correct",
"path": "/api/v2/client/send-money-3ds"
}HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
"timestamp": "2021-12-22T12:39:53.168+0000",
"status": 401,
"error": "Unauthorized",
"message": "ERROR_USER_NOTFOUND",
"path": "/api/v2/client/send-money-3ds"
}| Path | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
HTTP/1.1 403 Forbidden
Content-Type: application/json
{
"timestamp": 1610464313387,
"status": 403,
"error": "Forbidden",
"message": "No message available",
"path": "/client/send-money-3ds"
}3.2.3. Check status
The method allows obtaining a status of 3ds transaction specified by order-id. Parameter order-id was returned in the previous step (Send money multicurrency 3DS).
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant will be informed about each access restriction action. |
Request
| Parameter | Description |
|---|---|
|
Unique transaction identifier. |
GET /client/send-money-3ds/00549d98-08cb-45d2-8673-4dcafa81f498 HTTP/1.1
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181Response
Response status
| Status | Description |
|---|---|
|
Returned if the transaction completes successfully. |
|
Returned when transaction was registered for processing. Check status in a while. |
|
Returned when user provides wrong order-id or transaction was failed or was Declined. |
Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 986
{
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"3DS" : false,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "511796******9169",
"bankName" : "Alior Bank SA"
}
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
Date of transaction. |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 946
{
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"3DS" : false,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "CASH",
"hiddenCardNumber" : "****************"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "511796******9169",
"bankName" : "Alior Bank SA"
}
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
Date of transaction. |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 203 Non-Authoritative Information| After you get 203 you need to check status in a while because we processing this transaction and if you don’t get a response (200 - succeeded or 500 - declined) within 60 seconds then please contact us. |
HTTP/1.1 500 Internal Server Error
Content-Type: text/plain;charset=ISO-8859-1
PAYMENT_TRANSACTION_DECLINED:CODE_05| After receiving these statuses, the transaction was rejected |
Error statuses
| Name | Description |
|---|---|
|
CODE_XX - is MasterCard response code (ISO 8583) |
|
This card is not supported |
|
Card is blocked for 1 hour in Fenige |
|
User is blocked in Fenige |
|
Bin is blocked for 1 hour in Fenige |
|
Funding bank is blocked in Fenige |
|
Payment bank is blocked in Fenige |
|
Funding transaction was declined and payment not send |
|
Payment transaction was declined and funding was reversed |
|
A connection error occurred to Acquirer service |
|
User was found on the stop list |
|
Acceptance network is unavailable |
|
No currently effective rates found in the database |
|
Currency is not supported |
|
Currency is not supported by Merchant |
|
Transaction limit for single transaction exceeded |
|
Daily transaction limit for amount per card exceeded |
|
Daily transaction limit for count per card exceeded |
|
Monthly transaction limit for amount per card exceeded |
|
Monthly transaction limit for count per card exceeded |
|
Daily cumulative limit per card was exceeded |
|
Monthly cumulative limit per card was exceeded |
|
Daily cumulative limit per merchant transactions using mastercard cards was exceeded |
|
Monthly cumulative limit per merchant transactions using mastercard cards was exceeded |
|
Daily cumulative limit per merchant transactions using visa cards was exceeded |
|
Monthly cumulative limit per merchant transactions using visa cards was exceeded |
|
Daily cumulative limit per merchant transactions using mastercard and visa cards was exceeded |
|
Monthly cumulative limit per merchant transactions using mastercard and visa cards was exceeded |
|
Sender’s card is blocked |
|
Receiver’s card is blocked |
|
User acting as sender is blocked |
|
User acting as receiver is blocked |
|
BIN of sender’s card is blocked |
|
BIN of receiver’s card is blocked |
|
Amount is higher than acceptable limit |
|
Couldn’t established connection to Monitoring service |
|
Error with service authorization occurred |
|
Some unrecognized error occurred |
|
The transaction user’s personal data verified as incorrect on the verification service. Transaction rejected. |
|
Funding transaction declined - mip response timeout |
|
Payment transaction declined - mip response timeout |
|
Funding process failed and it is need to manual verification of transaction |
|
Payment process failed and it is need to manual verification of transaction |
|
Funding transaction declined - mip_proxy response timeout |
|
Payment transaction declined - mip_proxy response timeout |
|
Error finalize 3ds not authenticated. MPI return one of statuses: N -The customer failed authentication, and the transaction is denied. |
|
Error no 3ds authorization, when User authenticates successfully but after 15 minutes or User doesn’t authenticate. |
|
Error occurs, when merchant configuration allows only for attempted or full authenticated 3DS transactions with mpi status 'A' or 'Y' but mpi service has returned other status e.g. 'N' or 'U' at any stage of the transaction. |
|
An error occurred while processing |
|
An error occurred while processing |
|
An error occurred while processing |
|
Amount exceeds current merchant deposit limit |
|
Merchant has configured a different version of 3DS than specified in the request |
|
Some unrecognized, internal error occurred in MPI2 service |
|
Required configuration data of Merchant are not complete to finish 3DS 2.X process |
|
TransactionXId is invalid for card number specified in the request, 3DS 2.X flow invoked for other card number than specified in the request |
|
TransactionXId is invalid for merchant specified in the request, 3DS 2.X flow invoked for other merchant than specified in the request |
|
Card not found by transactionXId |
|
Card authentication does not match to payment type |
|
Error 3DS 2.X processing failed |
|
Transactions without 3ds above 30 EUR (the blockade applies only to EU countries) |
|
Error transaction not exists |
|
Card was not found |
|
Problem with DC |
|
ERROR_SOMETHING_WRONG returned when the check status method is executed means that the details for the indicated transaction could not be retrieved correctly due to an unexpected error. This does not mean that the transaction was rejected by our system. In case of receiving ERROR_SOMETHING_WRONG status, please do not hesitate to notify our support team in order to determine the correctness of the transaction execution and quickly correct the method error. |
|
This error may occur if card’s country is other than user’s country for USA or CAN transaction for PLAIN model |
|
This error may occur if card’s country is other than user’s country for USA or CAN transaction |
|
This error may occur when system could not get card country code. Most often, the error is caused by a missing card in the parameters received from the card provider. |
|
Province code is not valid for USA or CAN transactions. Please update user profile |
|
Some validation error occurred |
|
This error may occur when merchant tries to make transaction in other model than assigned primarily. For example, if merchant’s model is set as CARD-CARD and then merchant will try to make transaction in CASH-CARD model, will receive error as bellow. |
|
Card expired |
|
The amount sent is too small. Enter a larger amount. |
|
The amount sent is too high. Enter a lower amount. |
|
Restricted funding card country was used. + This error may occur when a merchant uses a sender card issued in a country that is on the list of countries High Risk or country not allowed to perform transactions in Fenige API. Please contact support. |
|
Restricted payment card country was used. + This error may occur when a merchant uses a sender card issued in a country that is on the list of countries High Risk or country not allowed to perform transactions in Fenige API. Please contact support. |
|
Merchant not support the given card provider, please contact support to check merchant configuration |
|
Merchant crypto is not supported outside EEA+UK |
|
System does not allow the execution of transaction with the receiver card country. |
|
System does not allow the execution of transaction with the sender card country. |
|
Geographic scope is not permitted for this transaction |
|
Processing time of transaction was too long, transaction is declined. |
|
Transaction rejected, second transaction with merchant advice code 03 or 21 within 30 days. |
|
Transaction rejected, sender or receiver name contains fraudulent phrase. |
|
Transaction rejected, suspicious sender or receiver name. |
3.2.4. Check detailed status
The method allows obtaining a detailed status of 3ds transaction specified by order-id. Parameter order-id was returned in the previous step (Send money multicurrency 3DS).
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant will be informed about each access restriction action. |
Request
| Parameter | Description |
|---|---|
|
Unique transaction identifier. |
GET /client/send-money-3ds/details/00549d98-08cb-45d2-8673-4dcafa81f498 HTTP/1.1
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181Response
Response status
| Status | Description |
|---|---|
|
Returned if the transaction completes successfully. |
|
Returned when transaction was registered for processing. Check status in a while. |
|
Returned when a transaction related to the given orderId doesn’t exist. |
|
Returned when user provides wrong order-id or transaction was failed or was Declined. |
|
Returned when an internal error occur. |
Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1022
{
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"3DS" : false,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "511796******9169",
"bankName" : "Alior Bank SA"
},
"transactionStatus" : "APPROVED"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
Date of transaction. |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
|
|
Status of the transaction (PENDING, APPROVED, DECLINED, REJECTED, REVERSED) |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 203 Non-Authoritative Information| After you get 203 you need to check status in a while because we processing this transaction and if you don’t get a response (200 - succeeded or 500 - declined) within 60 seconds then please contact us. |
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 51
{
"errorStatus" : "ERROR_TRANSACTION_NOT_FOUND"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Additional data of the error occurred during a processing of the request |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 1150
{
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"3DS" : false,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "511796******9169",
"bankName" : "Alior Bank SA"
},
"transactionStatus" : "DECLINED",
"cardBlockType" : "TEMP",
"cardBlockedUntil" : "2023-12-11T01:03:14.162",
"errorStatus" : "ERROR_SENDER_CARD_IS_BLOCKED"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
Date of transaction. |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
|
|
Status of the transaction (PENDING, APPROVED, DECLINED, REJECTED, REVERSED) |
|
|
The code of the error occurred during a processing of the request |
|
|
Card lock type |
|
|
Card’s lock end date |
|
|
Information about the reasons for declined transactions and actions that merchants can take. Occurs only for mastercard and for rejected transactions if Mastercard returns this information |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 69
{
"errorStatus" : "ERROR_SOMETHING_WRONG - Something went wrong."
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Additional data of the error occurred during a processing of the request |
3.2.5. Transaction history
Method return page with list of user transactions. Transactions are filtered by clientId provided in GET parameter.
User can send additional optional parameters (page, size) to obtain given page with defined size.
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant will be informed about each access restriction action. |
Request
GET /client/0/transactions?fromDate=2018-03-06&toDate=2018-03-08&page=0&size=100 HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181Response
Response status
| Status | Description |
|---|---|
|
Returned list of transactions history. |
|
Returning the list failed. |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1118
{
"content" : [ {
"correlationId" : "a725f850-4d1e-4b2f-8dd1-6d56aedde0a8",
"createdDate" : "2018-03-15T10:24:52.149Z",
"amount" : 15000,
"amountInUsDollar" : 4024,
"textAmount" : "150.00 PLN",
"currency" : "PLN",
"cardId" : 3574,
"receiverFirstName" : "Patrick",
"receiverLastName" : "Evans",
"receiverHiddenCardNumber" : "511123******1234",
"receiverProvider" : "MASTERCARD",
"receiverBankName" : "Bank Polska Kasa Opieki Spółka Akcyjna",
"receiverEmail" : "receiver@fenige.pl",
"receiverPhone" : "600300200",
"senderFirstName" : "Rob",
"senderLastName" : "Wring",
"senderHiddenCardNumber" : "522212******4321",
"senderProvider" : "MASTERCARD",
"senderBankName" : "Alior Bank SA",
"status" : "approved",
"transactionDirection" : "OUTGOING",
"3DS" : false
} ],
"pageable" : "INSTANCE",
"last" : true,
"totalElements" : 1,
"totalPages" : 1,
"size" : 1,
"number" : 0,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"first" : true,
"numberOfElements" : 1,
"empty" : false
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Unique UUID describing single transaction in system |
|
|
Date of transaction processing |
|
|
Transaction amount in pennies |
|
|
Transaction amount in USD currency in pennies. |
|
|
Transaction amount with currency |
|
|
Transaction currency |
|
|
Datacore card id used in transaction (sender card) |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Transaction receiver first name |
|
|
Transaction receiver last name |
|
|
Transaction receiver hidden card number |
|
|
VISA or MASTERCARD or MAESTRO |
|
|
Transaction receiver card bank name. |
|
|
Transaction sender first name. |
|
|
Transaction sender last name. |
|
|
Transaction sender hidden card numbe. |
|
|
VISA or MASTERCARD or MAESTRO |
|
|
Transaction sender card bank name. |
|
|
Transaction receiver phone number |
|
|
Transaction receiver email |
|
|
Status of the transaction (approved, reversed) |
|
|
Direction of the transaction (INCOMING, OUTGOING) |
|
|
Information about the reasons for declined transactions and actions that merchants can take. Occurs only for mastercard and for rejected transactions if Mastercard returns this information |
|
|
Describes whether the page is last (true ot false) |
|
|
Total number of all pages |
|
|
Total number of all transactions |
|
|
Number of transactions on page |
|
|
Describes whether the page is first (true ot false) |
|
|
Details of sort |
|
|
Max number of transactions on page |
|
|
Page number |
|
|
Page number |
HTTP/1.1 404 Not Found3.2.6. Transaction details
Method return transaction details for single transaction given in method parameter orderId
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant will be informed about each access restriction action. |
Request
GET /client/transactions/fae3ee90-6f88-4aa6-aff5-7d9f6a5645d3 HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181Response
Response status
| Status | Description |
|---|---|
|
Returned details of transaction. |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 297
{
"fundingAmount" : "2.00 PLN",
"chargedAmount" : "2.04 PLN",
"commission" : "0.04 PLN",
"paymentAmount" : "0.54 USD",
"exchange" : "1.00 PLN = 0.27 USD",
"transactionTime" : "2018-07-26T17:01:56.364Z",
"cardIssuer" : "MASTERCARD",
"amountInUsDollar" : 1,
"status" : "approved"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Funding amount in transaction currency |
|
|
Charged amount in transaction currency |
|
|
Transaction commission with currency |
|
|
Payment amount in receiver currency |
|
|
Revaluation amount from sender to receiver currency |
|
|
Date of the transaction |
|
|
Card issuer MASTERCARD/VISA |
|
|
Transaction amount in USD currency in pennies |
|
|
Status of transaction approved/reject/decline |
3.3. Payouts on Card
Quick money transfers to debit or credit cards in 150 major currencies. Lower the costs, save time and increase the end-user satisfaction.
1 - User by selecting type = RECEIVER defines amount of payment in given currency. This amount is transferred to receiver card in selected currency. In case there's need revaluation from one currency to another, system uses higherRate for this situation. For more details about specific rates please refer to Currency Rate method.
*API-TOKEN CASH-PHONE
| The API-TOKEN is refreshed each time it is used in the header. The API-TOKEN is refreshed for 30 minutes. |
| Please notice that you can choose language of email confirmation of this transaction. It is able by attach proper header to request. |
The success of the multicurrency send-money transaction depends primarily on the correctness of the merchant's currency configuration which is done by the admin. To make transactions in a currency other than the currency of the card, contact the admin.
In order to provide users with the ability to safely retry transaction (for example to request for an undelivered response), the v2 of API supports idempotent send money multi-currency operation.
To use the BLIK to card transfer service, you will need to have a mobile banking app from one of the participating banks. Follow the instructions on the app to complete the transfer. Once you have confirmed the transaction, the money will be transferred to the card instantly.
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant 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. |
3.3.1. Request
Request fields
| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
amount |
Number |
Required |
@NotNull, positive |
The total transfer amount (in pennies) |
cvc2 |
String |
Required |
@Length(min = 3, max = 3) |
Sender card cvc2/cvv2 |
merchantUrl |
String |
Required except CASH-PLAIN transactions. |
@NotNull except CASH-PLAIN |
Merchant identifier such as the business website URL or reverse domain name as presented to the consumer during checkout |
addressIp |
String |
Required except CASH-PLAIN transactions @Must conform to the IPv4 or IPv6 standard. |
@NotNull except CASH-PLAIN |
The IP address of the order of transaction. |
type |
String |
Required |
@NotNull |
Transaction in 'SENDER' or 'RECEIVER' currency, for specific transaction type. CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER. |
requestId |
String |
Required |
@NotNull |
128 bit number generated by the user, used to identify single transaction. Ensures that the transaction with the given parameter is processed only once. |
transactionId |
String |
Optional |
@Length(max = 64) |
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. |
sender |
Object |
Required |
@NotNull |
|
receiver |
Object |
Required |
@NotNull |
Receiver PLAIN Receiver CASH Receiver DATACORE Receiver PHONE |
Example HTTP Request
POST /api/v2/client/send-money HTTP/1.1
Content-Type: application/vnd.sendmoney.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 676
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"type" : "RECEIVER",
"requestId" : "9740e9d6-79ce-4ff7-bd58-33d360e7b138",
"transactionId" : "TRX220132AM",
"sender" : {
"type" : "CASH",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"personalId" : "AGC688910",
"country" : "PL"
},
"receiver" : {
"type" : "PLAIN",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-12-09",
"cardNumber" : "5117964247989169",
"currency" : "PLN",
"countryOfResidence" : "PL"
}
}POST /api/v2/client/send-money HTTP/1.1
Content-Type: application/vnd.sendmoney.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 672
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"type" : "RECEIVER",
"requestId" : "ccbe931e-63cd-4b33-9b9b-293e4856e5d8",
"transactionId" : "TRX220132AM",
"sender" : {
"type" : "CASH",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"personalId" : "AGC688910",
"country" : "PL"
},
"receiver" : {
"type" : "PHONE",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-12-09",
"phoneNumber" : "48123777619",
"currency" : "PLN",
"countryOfResidence" : "PL"
}
}3.3.2. Response
Response status
| Status | Description |
|---|---|
|
Returned list of field name which has validation errors. |
|
- Returned when the transaction with the provided requestId has been registered in the system, but has not yet been completed. The user can retry in a few seconds to get the transaction result. Response body: Empty |
|
Returned e.g. when a different transaction with the provided requestId has already been registered in the system. |
|
Returned when API-TOKEN was broken. |
Example HTTP Response
HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 56
{
"orderId" : "1a43d209-a470-42a4-a876-1d1411b8f6a3"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Unique transaction identifier |
HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 104
{
"error" : {
"message" : "Another transaction with the same id has already been processed."
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [{
"field": "requestId",
"message": [
"may not be null"
]
},
{
"field": "cvc2",
"message": [
"may not be null",
"length must be 3"
]
},
{
"field": "type",
"message": [
"may not be null"
]
},
{
"field": "amount",
"message": [
"may not be null"
]
},
{
"field": "sender",
"message": [
"may not be null"
]
},
{
"field": "sender.cardNumber",
"message": [
"may not be null",
"may not be empty",
"card number length must be 16"
]
},
{
"field": "sender.expirationDate",
"message": [
"invalid card expiration date",
"may not be null",
"may not be empty"
]
},
{
"field": "sender.city",
"message": [
"may not be empty",
"may not be null",
"length must be between 1 and 25"
]
},
{
"field": "sender.street",
"message": [
"may not be null",
"may not be empty",
"length must be between 1 and 50"
]
},
{
"field": "sender.postalCode",
"message": [
"may not be empty",
"may not be null",
"length must be between 1 and 10"
]
},
{
"field": "sender.flatNumber",
"message": [
"must be null",
"length must be between 0 and 5"
]
},
{
"field": "sender.lastName",
"message": [
"may not be empty",
"may not be null",
"length must be between 2 and 35"
]
},
{
"field": "sender.houseNumber",
"message": [
"may not be empty",
"may not be null",
"length must be between 1 and 10",
"must match the expression: ^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$"
]
},
{
"field": "sender.firstName",
"message": [
"may not be empty",
"may not be null",
"length must be between 2 and 35"
]
},
{
"field": "sender.email",
"message": [
"may not be empty",
"may not be null",
"not a well-formed email address",
"lenght must be beetween 1 and 128"
]
},
{
"field": "receiver",
"message": [
"may not be null"
]
},
{
"field": "receiver.firstName",
"message": [
"may not be empty",
"may not be null",
"length must be between 2 and 35"
]
},
{
"field": "receiver.lastName",
"message": [
"may not be empty",
"may not be null",
"length must be between 2 and 35"
]
},
{
"field": "receiver.currency",
"message": [
"may not be null"
]
},
{
"field": "receiver.cardNumber",
"message": [
"may not be null",
"may not be empty",
"card number length must be 16"
]
},
{
"field": "sender",
"message": [
"province is mandatory only if country code is US or CA"
]
},
{
"field": "sender.province",
"message": [
"is not correct province code for country code US",
"may not be null"
]
},
{
"field": "sender.province",
"message": [
"may not be null",
"is not correct province code for country code CA"
]
},
{
"field": "sender.province",
"message": [
"must match ^[A-Z]{2}$",
"is not correct province code for country code US"
]
},
{
"field": "sender.currency",
"message": [
"Currency is not supported"
]
},
{
"field": "receiver.currency",
"message": [
"Currency is not supported"
]
}
]
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_API_TOKEN_NOT_FOUND",
"error": {
"message": "API-TOKEN header not found in request with DATACORE/PHONE model in sender or receiver."
}
}HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
"timestamp": "2021-12-22T12:39:53.168+0000",
"status": 401,
"error": "Unauthorized",
"message": "Username or password is not correct",
"path": "/api/v2/client/send-money"
}HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
"timestamp": "2021-12-22T12:39:53.168+0000",
"status": 401,
"error": "Unauthorized",
"message": "ERROR_USER_NOTFOUND",
"path": "/api/v2/client/send-money"
}| Path | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
HTTP/1.1 403 Forbidden
Content-Type: application/json
{
"timestamp": 1610464313387,
"status": 403,
"error": "Forbidden",
"message": "No message available",
"path": "/client/send-money-3ds"
}3.3.3. Check status
The method allows obtaining a status of multi-currency transaction specified by order-id. Parameter order-id was returned in the previous step (Send money multicurrency).
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant will be informed about each access restriction action. |
Request
| Parameter | Description |
|---|---|
|
Unique transaction identifier. |
GET /client/send-money/00549d98-08cb-45d2-8673-4dcafa81f498 HTTP/1.1
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181Response
Response status
| Status | Description |
|---|---|
|
Returned if the transaction completes successfully. |
|
Returned when transaction was registered for processing. Check status in a while. |
|
Returned when user provides wrong order-id or transaction was failed or was Declined. |
Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1260
{
"transactionId" : "TRX220132AM",
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"fundingRrn" : "014011103023",
"paymentRrn" : "014011103024",
"arn" : "05411640143500000019325",
"3DS" : false,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "CASH",
"hiddenCardNumber" : "****************",
"bankName" : ""
},
"merchantSettlementCurrency" : "USD",
"fenigeCommissionInMerchantSettlementCurrency" : 0.05,
"transactionAmountInMerchantSettlementCurrency" : 2.68
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. @Length(max = 64). Optional |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Acquirer Reference Number |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender currency and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
|
|
Merchant settlement currency |
|
|
Commission Fenige in merchant settlement currency |
|
|
Transaction amount in merchant settlement currency |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 203 Non-Authoritative Information| After you get 203 you need to check status in a while because we processing this transaction and if you don’t get a response (200 - succeeded or 500 - declined) within 60 seconds then please contact us. |
HTTP/1.1 500 Internal Server Error
Content-Type: text/plain;charset=ISO-8859-1
PAYMENT_TRANSACTION_DECLINED:CODE_05| After receiving these statuses, the transaction was rejected |
Error statuses
| Name | Description |
|---|---|
|
CODE_XX - is MasterCard response code (ISO 8583) |
|
This card is not supported |
|
Card is blocked for 1 hour in Fenige |
|
User is blocked in Fenige |
|
Bin is blocked for 1 hour in Fenige |
|
Funding bank is blocked in Fenige |
|
Payment bank is blocked in Fenige |
|
Funding transaction was declined and payment not send |
|
Payment transaction was declined and funding was reversed |
|
A connection error occurred to Acquirer service |
|
User was found on the stop list |
|
Acceptance network is unavailable |
|
No currently effective rates found in the database |
|
Currency is not supported |
|
Currency is not supported by Merchant |
|
Transaction limit for single transaction exceeded |
|
Daily transaction limit for amount per card exceeded |
|
Daily transaction limit for count per card exceeded |
|
Monthly transaction limit for amount per card exceeded |
|
Monthly transaction limit for count per card exceeded |
|
Daily cumulative limit per card was exceeded |
|
Monthly cumulative limit per card was exceeded |
|
Daily cumulative limit per merchant transactions using mastercard cards was exceeded |
|
Monthly cumulative limit per merchant transactions using mastercard cards was exceeded |
|
Daily cumulative limit per merchant transactions using visa cards was exceeded |
|
Monthly cumulative limit per merchant transactions using visa cards was exceeded |
|
Daily cumulative limit per merchant transactions using mastercard and visa cards was exceeded |
|
Monthly cumulative limit per merchant transactions using mastercard and visa cards was exceeded |
|
Sender’s card is blocked |
|
Receiver’s card is blocked |
|
User acting as sender is blocked |
|
User acting as receiver is blocked |
|
BIN of sender’s card is blocked |
|
BIN of receiver’s card is blocked |
|
Amount is higher than acceptable limit |
|
Couldn’t established connection to Monitoring service |
|
Error with service authorization occurred |
|
Some unrecognized error occurred |
|
The transaction user’s personal data verified as incorrect on the verification service. Transaction rejected. |
|
Funding transaction declined - mip response timeout |
|
Payment transaction declined - mip response timeout |
|
Funding process failed and it is need to manual verification of transaction |
|
Payment process failed and it is need to manual verification of transaction |
|
Funding transaction declined - mip_proxy response timeout |
|
Payment transaction declined - mip_proxy response timeout |
|
Amount exceeds current merchant deposit limit |
|
Error transaction not exists |
|
Card was not found |
|
Problem with DC |
|
ERROR_SOMETHING_WRONG returned when the check status method is executed means that the details for the indicated transaction could not be retrieved correctly due to an unexpected error. This does not mean that the transaction was rejected by our system. In case of receiving ERROR_SOMETHING_WRONG status, please do not hesitate to notify our support team in order to determine the correctness of the transaction execution and quickly correct the method error. |
|
This error may occur if card’s country is other than user’s country for USA or CAN transaction for PLAIN model |
|
This error may occur if card’s country is other than user’s country for USA or CAN transaction |
|
This error may occur when system could not get card country code. Most often, the error is caused by a missing card in the parameters received from the card provider. |
|
Province code is not valid for USA or CAN transactions. Please update user profile |
|
Some validation error occurred |
|
This error may occur when merchant tries to make transaction in other model than assigned primarily. For example, if merchant’s model is set as CARD-CARD and then merchant will try to make transaction in CASH-CARD model, will receive error as bellow. |
|
Card expired |
|
The amount sent is too small. Enter a larger amount. |
|
The amount sent is too high. Enter a lower amount. |
|
Restricted funding card country was used. + This error may occur when a merchant uses a sender card issued in a country that is on the list of countries High Risk or country not allowed to perform transactions in Fenige API. Please contact support. |
|
Restricted payment card country was used. + This error may occur when a merchant uses a sender card issued in a country that is on the list of countries High Risk or country not allowed to perform transactions in Fenige API. Please contact support. |
|
Merchant not support the given card provider, please contact support to check merchant configuration |
|
Merchant crypto is not supported outside EEA+UK |
|
System does not allow the execution of transaction with the receiver card country. |
|
System does not allow the execution of transaction with the sender card country. |
|
Geographic scope is not permitted for this transaction |
|
Processing time of transaction was too long, transaction is declined. |
|
Transaction rejected, second transaction with merchant advice code 03 or 21 within 30 days. |
|
Transaction rejected, sender or receiver name contains fraudulent phrase. |
|
Transaction rejected, suspicious sender or receiver name. |
|
Transaction rejected, card country is not supported for merchants crypto. |
3.3.4. Check detailed status
The method allows obtaining a detailed status of multi-currency transaction specified by order-id. Parameter order-id was returned in the previous step (Send money multicurrency).
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant will be informed about each access restriction action. |
Request
| Parameter | Description |
|---|---|
|
Unique transaction identifier. |
GET /client/send-money/details/00549d98-08cb-45d2-8673-4dcafa81f498 HTTP/1.1
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181Response
Response status
| Status | Description |
|---|---|
|
Returned if the transaction completes successfully. |
|
Returned when transaction was registered for processing. Check status in a while. |
|
Returned when a transaction related to the given orderId doesn’t exist. |
|
Returned when user provides wrong order-id or transaction was failed or was Declined. |
|
Returned when an internal error occur. |
Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1230
{
"transactionId" : "TRX220132AM",
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"fundingRrn" : "014011103023",
"paymentRrn" : "014011103024",
"arn" : "05411640143500000019325",
"3DS" : false,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "CASH"
},
"transactionStatus" : "APPROVED",
"merchantSettlementCurrency" : "USD",
"fenigeCommissionInMerchantSettlementCurrency" : 0.05,
"transactionAmountInMerchantSettlementCurrency" : 2.68
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. @Length(max = 64). Optional |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Acquirer Reference Number |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender currency and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
|
|
Merchant settlement currency |
|
|
Commission Fenige in merchant settlement currency |
|
|
Transaction amount in merchant settlement currency |
|
|
Status of the transaction (PENDING, APPROVED, DECLINED, REJECTED, REVERSED) |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 203 Non-Authoritative Information| After you get 203 you need to check status in a while because we processing this transaction and if you don’t get a response (200 - succeeded or 500 - declined) within 60 seconds then please contact us. |
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 51
{
"errorStatus" : "ERROR_TRANSACTION_NOT_FOUND"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Additional data of the error occurred during a processing of the request |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 1287
{
"transactionId" : "TRX220132AM",
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"fundingRrn" : "014011103023",
"paymentRrn" : "014011103024",
"arn" : "05411640143500000019325",
"3DS" : true,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "511796******9169",
"bankName" : "Alior Bank SA"
},
"transactionStatus" : "DECLINED",
"cardBlockType" : "TEMP",
"cardBlockedUntil" : "2023-12-11T01:03:14.925",
"errorStatus" : "ERROR_SENDER_CARD_IS_BLOCKED"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. @Length(max = 64). Optional |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Acquirer Reference Number |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender currency and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
|
|
Status of the transaction (PENDING, APPROVED, DECLINED, REJECTED, REVERSED) |
|
|
Additional data of the error occurred during a processing of the request |
|
|
Card lock type |
|
|
Card’s lock end date |
|
|
Information about the reasons for declined transactions and actions that merchants can take. Occurs only for mastercard and for rejected transactions if Mastercard returns this information |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 1358
{
"transactionId" : "TRX220132AM",
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"fundingRrn" : "014011103023",
"paymentRrn" : "014011103024",
"arn" : "05411640143500000019325",
"3DS" : false,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "CASH"
},
"transactionStatus" : "DECLINED",
"merchantSettlementCurrency" : "USD",
"fenigeCommissionInMerchantSettlementCurrency" : 0.05,
"transactionAmountInMerchantSettlementCurrency" : 2.68,
"cardBlockType" : "TEMP",
"cardBlockedUntil" : "2023-12-11T01:03:15.457",
"errorStatus" : "ERROR_SENDER_CARD_IS_BLOCKED"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. @Length(max = 64). Optional |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Acquirer Reference Number |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender currency and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
|
|
Merchant settlement currency |
|
|
Commission Fenige in merchant settlement currency |
|
|
Transaction amount in merchant settlement currency |
|
|
Status of the transaction (PENDING, APPROVED, DECLINED, REJECTED, REVERSED) |
|
|
The code of the error occurred during a processing of the request |
|
|
Card lock type |
|
|
Card’s lock end date |
|
|
Information about the reasons for declined transactions and actions that merchants can take. Occurs only for mastercard and for declined transactions if Mastercard returns this information |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 69
{
"errorStatus" : "ERROR_SOMETHING_WRONG - Something went wrong."
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Additional data of the error occurred during a processing of the request |
3.4. BLIK to Card
Innovative technology that allows to send money between BLIK and cards instantly anywhere in the world. No SWIFT or bank account number needed!
This method is used to MoneySend transaction (funding and payment). To enable users to make transfers in any currency, Fenige introduces the send-money method for multicurrency.
1 - User by selecting type = SENDER defines amount of funding in PLN. This amount is collected from sender card in PLN currency. 2 - User by selecting type = RECEIVER defines amount of payment in given currency. This amount is transferred to receiver card in selected currency. In case there's need revaluation from one currency to another, system uses lowerRate for situation 1 and higherRate for situation 2. For more details about specific rates please refer to Currency Rate method.
| TIP: Please notice that you can choose language of email confirmation of this transaction. It is able by attach proper header to request. |
The success of the multicurrency send-money transaction depends primarily on the correctness of the merchant's currency configuration which is done by the admin. To make transactions in a currency other than the currency of the card, contact the admin.
In order to provide users with the ability to safely retry transaction (for example to request for an undelivered response), the v2 of API supports idempotent send money multi-currency operation.
To use the BLIK to card transfer service, you will need to have a mobile banking app from one of the participating banks. Follow the instructions on the app to complete the transfer. Once you have confirmed the transaction, the money will be transferred to the card instantly.
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant 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. |
3.4.1. Request
Request fields
| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
amount |
Number |
Required |
@NotNull, positive |
The total transfer amount (in pennies) |
cvc2 |
String |
Required |
@Length(min = 3, max = 3) |
Sender card cvc2/cvv2 |
merchantUrl |
String |
Required except CASH-PLAIN transactions. |
@NotNull except CASH-PLAIN |
Merchant identifier such as the business website URL or reverse domain name as presented to the consumer during checkout |
addressIp |
String |
Required except CASH-PLAIN transactions @Must conform to the IPv4 or IPv6 standard. |
@NotNull except CASH-PLAIN |
The IP address of the order of transaction. |
type |
String |
Required |
@NotNull |
Transaction in 'SENDER' or 'RECEIVER' currency, for specific transaction type. CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER. |
requestId |
String |
Required |
@NotNull |
128 bit number generated by the user, used to identify single transaction. Ensures that the transaction with the given parameter is processed only once. |
transactionId |
String |
Optional |
@Length(max = 64) |
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. |
sender |
Object |
Required |
@NotNull |
|
receiver |
Object |
Required |
@NotNull |
Receiver PLAIN Receiver CASH Receiver DATACORE Receiver PHONE |
Example HTTP Request
POST /api/v2/client/send-money HTTP/1.1
Content-Type: application/vnd.sendmoney.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 1225
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"requestId" : "b1f10e4a-68b1-4e8e-a629-ce621d9bed34",
"transactionId" : "TRX220132AM",
"sender" : {
"type" : "BLIK",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-12-09",
"country" : "PL",
"personalId" : "AGC688910",
"currency" : "PLN",
"firstDescriptionLine" : "Shop description",
"secondDescriptionLine" : "Second line of description",
"thirdDescriptionLine" : "Third line of description",
"fourthDescriptionLine" : "https://ecom-staging.fenige.pl/",
"redirectUrlAuthorized" : "https://ecom-staging.fenige.pl/transaction/authorized",
"redirectUrlDenied" : "https://ecom-staging.fenige.pl/transaction/denied"
},
"receiver" : {
"type" : "PLAIN",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-12-09",
"cardNumber" : "5117964247989169",
"currency" : "PLN",
"countryOfResidence" : "PL"
}
}3.4.2. Response
Response status
| Status | Description |
|---|---|
|
Returned list of field name which has validation errors. |
|
- Returned when the transaction with the provided requestId has been registered in the system, but has not yet been completed. The user can retry in a few seconds to get the transaction result. Response body: Empty |
|
Returned e.g. when a different transaction with the provided requestId has already been registered in the system. |
|
Returned when API-TOKEN was broken. |
Example HTTP Response
HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 1261
{
"orderId" : "c32fe4ee-bb62-4e1f-9398-e6bfefd465df",
"base64Form" : "PGh0bWw+PFNDUklQVCBMQU5HVUFHRT0iSmF2YXNjcmlwdCI+ZnVuY3Rpb24gT25Mb2FkRXZlbnQoKSB7ZG9jdW1lbnQuZG93bmxvYWRGb3JtLnN1Ym1pdCgpO308L1NDUklQVD48Ym9keSBPbkxvYWQ9Ik9uTG9hZEV2ZW50KCk7Ij48Zm9ybSBuYW1lPSJkb3dubG9hZEZvcm0iIGFjY2VwdC1jaGFyc2V0PSJJU08tODg1OS0yIiBhY3Rpb249Imh0dHBzOi8vMTkzLjI3LjYuMjI1L2JsaWt3ZWIvdHJhbnNhY3Rpb24vdHJhbnNhY3Rpb25faW5pdC9zdWJtaXQiIG1ldGhvZD0iUE9TVCI+PElOUFVUIHR5cGU9ImhpZGRlbiIgbmFtZT0iVHlwZSIgdmFsdWU9IklwYXkyIj48SU5QVVQgdHlwZT0iaGlkZGVuIiBuYW1lPSJNZXJjaGFudElEIiB2YWx1ZT0iMTcxOTUiPjxJTlBVVCB0eXBlPSJoaWRkZW4iIG5hbWU9IkN1cnJlbmN5IiB2YWx1ZT0iUExOIj48SU5QVVQgdHlwZT0iaGlkZGVuIiBuYW1lPSJBbW91bnQiIHZhbHVlPSIxMDAwIj48SU5QVVQgdHlwZT0iaGlkZGVuIiBuYW1lPSJDdXN0b21QYXJhbSIgdmFsdWU9Ijg0MGY1ZjYzOGY0OTQwNGZiMGU1OGQwMDU1NTg1NzM4Ij48SU5QVVQgdHlwZT0iaGlkZGVuIiBuYW1lPSJEZXNjcmlwdGlvbiIgdmFsdWU9ImV4YW1wbGV8ZGVzY3JpcHRpb258w7PEhcWbxIfFm8SFfCI+PElOUFVUIHR5cGU9ImhpZGRlbiIgbmFtZT0iVGltZXN0YW1wIiB2YWx1ZT0iMjAyMi0wNi0yOVQxNTo0MDo1OC4zMjIrMDI6MDAiPjxJTlBVVCB0eXBlPSJoaWRkZW4iIG5hbWU9Ik1DQyIgdmFsdWU9IjA3NDIiPjxJTlBVVCB0eXBlPSJoaWRkZW4iIG5hbWU9IkNvbnRyb2xEYXRhIiB2YWx1ZT0iZDkyZjI2MTI1NmQwMWNiNjU4ZWI3MzIwZDczNDE2MjYyOGNhOTViNzRmYWRmY2UxOGFmMDliMDdkOWIwOGNjMCI+PC9mb3JtPjwvYm9keT48L2h0bWw+"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Unique transaction identifier |
|
|
HTML page encoded base64 that includes all necessary data that has to be send to BLIK. Page can be simply decoded and used for making transactions. |
HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 104
{
"error" : {
"message" : "Another transaction with the same id has already been processed."
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [{
"field": "requestId",
"message": [
"may not be null"
]
},
{
"field": "cvc2",
"message": [
"may not be null",
"length must be 3"
]
},
{
"field": "type",
"message": [
"may not be null"
]
},
{
"field": "amount",
"message": [
"may not be null"
]
},
{
"field": "sender",
"message": [
"may not be null"
]
},
{
"field": "sender.cardNumber",
"message": [
"may not be null",
"may not be empty",
"card number length must be 16"
]
},
{
"field": "sender.expirationDate",
"message": [
"invalid card expiration date",
"may not be null",
"may not be empty"
]
},
{
"field": "sender.city",
"message": [
"may not be empty",
"may not be null",
"length must be between 1 and 25"
]
},
{
"field": "sender.street",
"message": [
"may not be null",
"may not be empty",
"length must be between 1 and 50"
]
},
{
"field": "sender.postalCode",
"message": [
"may not be empty",
"may not be null",
"length must be between 1 and 10"
]
},
{
"field": "sender.flatNumber",
"message": [
"must be null",
"length must be between 0 and 5"
]
},
{
"field": "sender.lastName",
"message": [
"may not be empty",
"may not be null",
"length must be between 2 and 35"
]
},
{
"field": "sender.houseNumber",
"message": [
"may not be empty",
"may not be null",
"length must be between 1 and 10",
"must match the expression: ^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$"
]
},
{
"field": "sender.firstName",
"message": [
"may not be empty",
"may not be null",
"length must be between 2 and 35"
]
},
{
"field": "sender.email",
"message": [
"may not be empty",
"may not be null",
"not a well-formed email address",
"lenght must be beetween 1 and 128"
]
},
{
"field": "receiver",
"message": [
"may not be null"
]
},
{
"field": "receiver.firstName",
"message": [
"may not be empty",
"may not be null",
"length must be between 2 and 35"
]
},
{
"field": "receiver.lastName",
"message": [
"may not be empty",
"may not be null",
"length must be between 2 and 35"
]
},
{
"field": "receiver.currency",
"message": [
"may not be null"
]
},
{
"field": "receiver.cardNumber",
"message": [
"may not be null",
"may not be empty",
"card number length must be 16"
]
},
{
"field": "sender",
"message": [
"province is mandatory only if country code is US or CA"
]
},
{
"field": "sender.province",
"message": [
"is not correct province code for country code US",
"may not be null"
]
},
{
"field": "sender.province",
"message": [
"may not be null",
"is not correct province code for country code CA"
]
},
{
"field": "sender.province",
"message": [
"must match ^[A-Z]{2}$",
"is not correct province code for country code US"
]
},
{
"field": "sender.currency",
"message": [
"Currency is not supported"
]
},
{
"field": "receiver.currency",
"message": [
"Currency is not supported"
]
}
]
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_API_TOKEN_NOT_FOUND",
"error": {
"message": "API-TOKEN header not found in request with DATACORE/PHONE model in sender or receiver."
}
}HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
"timestamp": "2021-12-22T12:39:53.168+0000",
"status": 401,
"error": "Unauthorized",
"message": "Username or password is not correct",
"path": "/api/v2/client/send-money"
}HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
"timestamp": "2021-12-22T12:39:53.168+0000",
"status": 401,
"error": "Unauthorized",
"message": "ERROR_USER_NOTFOUND",
"path": "/api/v2/client/send-money"
}| Path | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
HTTP/1.1 403 Forbidden
Content-Type: application/json
{
"timestamp": 1610464313387,
"status": 403,
"error": "Forbidden",
"message": "No message available",
"path": "/client/send-money-3ds"
}3.4.3. BLIK
General information
BLIK is a popular mobile payment system, enabling users to carry out secure transactions using their smartphones. Integrated within banking apps, BLIK allows for online and in-store payments, ATM withdrawals, and more, through a generated six-digit code, making financial transactions swift and straightforward.
How does it work
Customer choose the BLIK payment method, in order to complete the transaction he has to provide a BLIK code from bank application. The BLIK code is a one-off, 6-digit code, it is valid for 2 minutes. After that time, new one has to be generated. When code is provide it has to be also confirmed in bank app and that ends the transaction.
Example EBLIK payment form
For development purposes, please note the following special rule for BLIK codes: Use codes that begin with "777 xxx", to process payment successfully. For codes that begin with any other number, the transaction will be rejected.
3.4.4. Check status
The method allows obtaining a status of multi-currency transaction specified by order-id. Parameter order-id was returned in the previous step (Send money multicurrency).
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant will be informed about each access restriction action. |
Request
| Parameter | Description |
|---|---|
|
Unique transaction identifier. |
GET /client/send-money/00549d98-08cb-45d2-8673-4dcafa81f498 HTTP/1.1
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181Response
Response status
| Status | Description |
|---|---|
|
Returned if the transaction completes successfully. |
|
Returned when transaction was registered for processing. Check status in a while. |
|
Returned when user provides wrong order-id or transaction was failed or was Declined. |
Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1123
{
"transactionId" : "TRX220132AM",
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"fundingRrn" : "014011103023",
"paymentRrn" : "014011103024",
"arn" : "05411640143500000019325",
"3DS" : true,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "511796******9169",
"bankName" : "Alior Bank SA"
}
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. @Length(max = 64). Optional |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Acquirer Reference Number |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender currency and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1260
{
"transactionId" : "TRX220132AM",
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"fundingRrn" : "014011103023",
"paymentRrn" : "014011103024",
"arn" : "05411640143500000019325",
"3DS" : false,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "CASH",
"hiddenCardNumber" : "****************",
"bankName" : ""
},
"merchantSettlementCurrency" : "USD",
"fenigeCommissionInMerchantSettlementCurrency" : 0.05,
"transactionAmountInMerchantSettlementCurrency" : 2.68
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. @Length(max = 64). Optional |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Acquirer Reference Number |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender currency and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
|
|
Merchant settlement currency |
|
|
Commission Fenige in merchant settlement currency |
|
|
Transaction amount in merchant settlement currency |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 203 Non-Authoritative Information| After you get 203 you need to check status in a while because we processing this transaction and if you don’t get a response (200 - succeeded or 500 - declined) within 60 seconds then please contact us. |
HTTP/1.1 500 Internal Server Error
Content-Type: text/plain;charset=ISO-8859-1
PAYMENT_TRANSACTION_DECLINED:CODE_05| After receiving these statuses, the transaction was rejected |
Error statuses
| Name | Description |
|---|---|
|
CODE_XX - is MasterCard response code (ISO 8583) |
|
This card is not supported |
|
Card is blocked for 1 hour in Fenige |
|
User is blocked in Fenige |
|
Bin is blocked for 1 hour in Fenige |
|
Funding bank is blocked in Fenige |
|
Payment bank is blocked in Fenige |
|
Funding transaction was declined and payment not send |
|
Payment transaction was declined and funding was reversed |
|
A connection error occurred to Acquirer service |
|
User was found on the stop list |
|
Acceptance network is unavailable |
|
No currently effective rates found in the database |
|
Currency is not supported |
|
Currency is not supported by Merchant |
|
Transaction limit for single transaction exceeded |
|
Daily transaction limit for amount per card exceeded |
|
Daily transaction limit for count per card exceeded |
|
Monthly transaction limit for amount per card exceeded |
|
Monthly transaction limit for count per card exceeded |
|
Daily cumulative limit per card was exceeded |
|
Monthly cumulative limit per card was exceeded |
|
Daily cumulative limit per merchant transactions using mastercard cards was exceeded |
|
Monthly cumulative limit per merchant transactions using mastercard cards was exceeded |
|
Daily cumulative limit per merchant transactions using visa cards was exceeded |
|
Monthly cumulative limit per merchant transactions using visa cards was exceeded |
|
Daily cumulative limit per merchant transactions using mastercard and visa cards was exceeded |
|
Monthly cumulative limit per merchant transactions using mastercard and visa cards was exceeded |
|
Sender’s card is blocked |
|
Receiver’s card is blocked |
|
User acting as sender is blocked |
|
User acting as receiver is blocked |
|
BIN of sender’s card is blocked |
|
BIN of receiver’s card is blocked |
|
Amount is higher than acceptable limit |
|
Couldn’t established connection to Monitoring service |
|
Error with service authorization occurred |
|
Some unrecognized error occurred |
|
The transaction user’s personal data verified as incorrect on the verification service. Transaction rejected. |
|
Funding transaction declined - mip response timeout |
|
Payment transaction declined - mip response timeout |
|
Funding process failed and it is need to manual verification of transaction |
|
Payment process failed and it is need to manual verification of transaction |
|
Funding transaction declined - mip_proxy response timeout |
|
Payment transaction declined - mip_proxy response timeout |
|
Amount exceeds current merchant deposit limit |
|
Error transaction not exists |
|
Card was not found |
|
Problem with DC |
|
ERROR_SOMETHING_WRONG returned when the check status method is executed means that the details for the indicated transaction could not be retrieved correctly due to an unexpected error. This does not mean that the transaction was rejected by our system. In case of receiving ERROR_SOMETHING_WRONG status, please do not hesitate to notify our support team in order to determine the correctness of the transaction execution and quickly correct the method error. |
|
This error may occur if card’s country is other than user’s country for USA or CAN transaction for PLAIN model |
|
This error may occur if card’s country is other than user’s country for USA or CAN transaction |
|
This error may occur when system could not get card country code. Most often, the error is caused by a missing card in the parameters received from the card provider. |
|
Province code is not valid for USA or CAN transactions. Please update user profile |
|
Some validation error occurred |
|
This error may occur when merchant tries to make transaction in other model than assigned primarily. For example, if merchant’s model is set as CARD-CARD and then merchant will try to make transaction in CASH-CARD model, will receive error as bellow. |
|
Card expired |
|
The amount sent is too small. Enter a larger amount. |
|
The amount sent is too high. Enter a lower amount. |
|
Restricted funding card country was used. + This error may occur when a merchant uses a sender card issued in a country that is on the list of countries High Risk or country not allowed to perform transactions in Fenige API. Please contact support. |
|
Restricted payment card country was used. + This error may occur when a merchant uses a sender card issued in a country that is on the list of countries High Risk or country not allowed to perform transactions in Fenige API. Please contact support. |
|
Merchant not support the given card provider, please contact support to check merchant configuration |
|
Merchant crypto is not supported outside EEA+UK |
|
System does not allow the execution of transaction with the receiver card country. |
|
System does not allow the execution of transaction with the sender card country. |
|
Geographic scope is not permitted for this transaction |
|
Processing time of transaction was too long, transaction is declined. |
|
Transaction rejected, second transaction with merchant advice code 03 or 21 within 30 days. |
|
Transaction rejected, sender or receiver name contains fraudulent phrase. |
|
Transaction rejected, suspicious sender or receiver name. |
|
Transaction rejected, card country is not supported for merchants crypto. |
3.4.5. Check detailed status
The method allows obtaining a detailed status of multi-currency transaction specified by order-id. Parameter order-id was returned in the previous step (Send money multicurrency).
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant will be informed about each access restriction action. |
Request
| Parameter | Description |
|---|---|
|
Unique transaction identifier. |
GET /client/send-money/details/00549d98-08cb-45d2-8673-4dcafa81f498 HTTP/1.1
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181Response
Response status
| Status | Description |
|---|---|
|
Returned if the transaction completes successfully. |
|
Returned when transaction was registered for processing. Check status in a while. |
|
Returned when a transaction related to the given orderId doesn’t exist. |
|
Returned when user provides wrong order-id or transaction was failed or was Declined. |
|
Returned when an internal error occur. |
Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1159
{
"transactionId" : "TRX220132AM",
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"fundingRrn" : "014011103023",
"paymentRrn" : "014011103024",
"arn" : "05411640143500000019325",
"3DS" : true,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "511796******9169",
"bankName" : "Alior Bank SA"
},
"transactionStatus" : "APPROVED"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. @Length(max = 64). Optional |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Acquirer Reference Number |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender currency and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
|
|
Status of the transaction (PENDING, APPROVED, DECLINED, REJECTED, REVERSED) |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1230
{
"transactionId" : "TRX220132AM",
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"fundingRrn" : "014011103023",
"paymentRrn" : "014011103024",
"arn" : "05411640143500000019325",
"3DS" : false,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "CASH"
},
"transactionStatus" : "APPROVED",
"merchantSettlementCurrency" : "USD",
"fenigeCommissionInMerchantSettlementCurrency" : 0.05,
"transactionAmountInMerchantSettlementCurrency" : 2.68
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. @Length(max = 64). Optional |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Acquirer Reference Number |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender currency and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
|
|
Merchant settlement currency |
|
|
Commission Fenige in merchant settlement currency |
|
|
Transaction amount in merchant settlement currency |
|
|
Status of the transaction (PENDING, APPROVED, DECLINED, REJECTED, REVERSED) |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 203 Non-Authoritative Information| After you get 203 you need to check status in a while because we processing this transaction and if you don’t get a response (200 - succeeded or 500 - declined) within 60 seconds then please contact us. |
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 51
{
"errorStatus" : "ERROR_TRANSACTION_NOT_FOUND"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Additional data of the error occurred during a processing of the request |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 1287
{
"transactionId" : "TRX220132AM",
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"fundingRrn" : "014011103023",
"paymentRrn" : "014011103024",
"arn" : "05411640143500000019325",
"3DS" : true,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "511796******9169",
"bankName" : "Alior Bank SA"
},
"transactionStatus" : "DECLINED",
"cardBlockType" : "TEMP",
"cardBlockedUntil" : "2023-12-11T01:03:14.925",
"errorStatus" : "ERROR_SENDER_CARD_IS_BLOCKED"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. @Length(max = 64). Optional |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Acquirer Reference Number |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender currency and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
|
|
Status of the transaction (PENDING, APPROVED, DECLINED, REJECTED, REVERSED) |
|
|
Additional data of the error occurred during a processing of the request |
|
|
Card lock type |
|
|
Card’s lock end date |
|
|
Information about the reasons for declined transactions and actions that merchants can take. Occurs only for mastercard and for rejected transactions if Mastercard returns this information |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 1358
{
"transactionId" : "TRX220132AM",
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"fundingRrn" : "014011103023",
"paymentRrn" : "014011103024",
"arn" : "05411640143500000019325",
"3DS" : false,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "CASH"
},
"transactionStatus" : "DECLINED",
"merchantSettlementCurrency" : "USD",
"fenigeCommissionInMerchantSettlementCurrency" : 0.05,
"transactionAmountInMerchantSettlementCurrency" : 2.68,
"cardBlockType" : "TEMP",
"cardBlockedUntil" : "2023-12-11T01:03:15.457",
"errorStatus" : "ERROR_SENDER_CARD_IS_BLOCKED"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. @Length(max = 64). Optional |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Acquirer Reference Number |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender currency and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
|
|
Merchant settlement currency |
|
|
Commission Fenige in merchant settlement currency |
|
|
Transaction amount in merchant settlement currency |
|
|
Status of the transaction (PENDING, APPROVED, DECLINED, REJECTED, REVERSED) |
|
|
The code of the error occurred during a processing of the request |
|
|
Card lock type |
|
|
Card’s lock end date |
|
|
Information about the reasons for declined transactions and actions that merchants can take. Occurs only for mastercard and for declined transactions if Mastercard returns this information |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 69
{
"errorStatus" : "ERROR_SOMETHING_WRONG - Something went wrong."
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Additional data of the error occurred during a processing of the request |
3.5. Delayed payment
|
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:
|
3.5.1. Delayed Send Money
The Delayed Send Money functionality provides the ability to perform transactions, where recipient is not known at the time of funding execution. Transaction in the Send Money system consists of Funding and Payment. In order to perform the method that request is described below, we can execute Funding (with Payment for some cases**).
Money specified in the request ('amount' field) will be charged from the Sender's card, but these money will be transferred to the Receiver's card when Receiver is known (After Delayed Payment method execution).
In order to make the full flow of the transaction, the Delayed Payment method must be executed. In Delayed Payment methods you should define Receiver of Funding - then transaction will be processed.
*API-TOKEN is required for model when sender is DATACORE type. **See table below with Delayed Send Money models. You can find there information which model executes only Funding or Funding with Payment at the same time.
| The API-TOKEN is refreshed each time it is used in the header. The API-TOKEN is refreshed for 30 minutes. |
| The maximum time for the execution of Delayed Payment after earlier calling Delayed Send Money is 12 hours. After 12 hours after Funding without Payment, it will be reversed. |
| There is 3 attempts to execute Delayed Payment after earlier call Delayed Send Money. |
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant 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. |
Quick tour of Delayed Send Money models
| Model | Sender | Receiver | Description | Transaction Type |
|---|---|---|---|---|
DATACORE_SENDER - DELAYED_RECEIVER |
DATACORE |
DELAYED |
For transactions in this model, we provide the full Sender’s data in the request without card number but with the 'cardId' (card is stored in Fenige Datacenter). The user must get API-TOKEN in the /client/login method. The Receiver’s details are unknown yet, so we are waiting for a Delayed Payment to be made. |
Funding or Funding & Payment |
PLAIN_SENDER - DELAYED_RECEIVER |
PLAIN |
DELAYED |
For transactions in this model, user must provide all the full Sender data in the request. The Receiver’s details are unknown yet, so we are waiting for a Delayed Payment to be made. |
Funding or Funding & Payment |
Delayed Send Money Examples
Requests
POST /client/delayed/send-money HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 939
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "02",
"authenticationStatus" : "Y",
"eci" : "02",
"transactionXId" : "c375915d-c2b4-4983-aff8-b8f6d735af4f"
},
"requestId" : "24834454-6d04-46d2-89c2-4ca0c22623d2",
"sender" : {
"type" : "DATACORE",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardId" : 1234,
"currency" : "PLN"
},
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-12-09",
"phoneNumber" : "48600300200",
"currency" : "USD"
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
amount |
Number |
Required |
@NotNull, positive |
The total transfer amount (in pennies). |
cvc2 |
String |
Required |
@Length(min = 3, max = 3) |
Sender card cvc2/cvv2. |
type |
String |
Required |
@NotNull |
Transaction in 'SENDER' or 'RECEIVER' currency, for specific transaction type. CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER. |
merchantUrl |
String |
Required except CASH-PLAIN transactions. |
@NotNull except CASH-PLAIN |
Merchant identifier such as the business website URL or reverse domain name as presented to the consumer during checkout |
addressIp |
String |
Required except CASH-PLAIN transactions @Must conform to the IPv4 or IPv6 standard. |
@NotNull except CASH-PLAIN |
The IP address of the order of transaction. |
requestId |
String |
Optional |
@NotNull |
128 bit number generated by the user, used to identify single transaction. Ensures that the transaction with the given parameter is processed only once. |
sender |
Object |
Required |
@NotNull |
Personal data of Sender. |
receiver |
Object |
Required |
@NotNull |
Personal data of Receiver. |
outside3ds.cavv |
String |
Required |
@NotNull |
Cardholder Authentication Verification Value. |
outside3ds.eci |
String |
Required |
@NotNull |
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 |
Required |
@NotNull |
Authentication status. If AuthenticationStatus is "Y" or "A" then outside 3ds flow will be execute. |
outside3ds.transactionXId |
String |
Optional |
@NotNull |
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 |
Optional |
@Optional |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm. |
POST /client/delayed/send-money HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 945
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "02",
"authenticationStatus" : "Y",
"eci" : "02",
"transactionXId" : "9c6b3215-361d-4654-b7c8-723dae10d5fd"
},
"requestId" : "941a34d3-813a-4244-b993-3b7c2127c96f",
"sender" : {
"type" : "DATACORE",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardId" : 1234,
"currency" : "PLN"
},
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "receiverEmail@fenige.pl",
"birthDate" : "2023-12-09",
"currency" : "USD"
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
amount |
Number |
Required |
@NotNull, positive |
The total transfer amount (in pennies). |
cvc2 |
String |
Required |
@Length(min = 3, max = 3) |
Sender card cvc2/cvv2. |
type |
String |
Required |
@NotNull |
Transaction in 'SENDER' or 'RECEIVER' currency, for specific transaction type. CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER. |
merchantUrl |
String |
Required except CASH-PLAIN transactions. |
@NotNull except CASH-PLAIN |
Merchant identifier such as the business website URL or reverse domain name as presented to the consumer during checkout |
addressIp |
String |
Required except CASH-PLAIN transactions @Must conform to the IPv4 or IPv6 standard. |
@NotNull except CASH-PLAIN |
The IP address of the order of transaction. |
requestId |
String |
Optional |
@NotNull |
128 bit number generated by the user, used to identify single transaction. Ensures that the transaction with the given parameter is processed only once. |
sender |
Object |
Required |
@NotNull |
Personal data of Sender. |
receiver |
Object |
Required |
@NotNull |
Personal data of Receiver. |
outside3ds.cavv |
String |
Required |
@NotNull |
Cardholder Authentication Verification Value. |
outside3ds.eci |
String |
Required |
@NotNull |
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 |
Required |
@NotNull |
Authentication status. If AuthenticationStatus is "Y" or "A" then outside 3ds flow will be execute. |
outside3ds.transactionXId |
String |
Optional |
@NotNull |
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 |
Optional |
@Optional |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm. |
POST /client/delayed/send-money HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 1018
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "02",
"authenticationStatus" : "Y",
"eci" : "02",
"transactionXId" : "c8f16eda-56d2-4005-97b6-028ab2e1d6d6"
},
"requestId" : "25853fae-133a-45bb-8e37-af30799675f3",
"sender" : {
"type" : "PLAIN",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardNumber" : "5117964247989169",
"expirationDate" : "03/26",
"personalId" : "AGC688910",
"currency" : "PLN"
},
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-12-09",
"phoneNumber" : "48600300200",
"currency" : "USD"
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
amount |
Number |
Required |
@NotNull, positive |
The total transfer amount (in pennies). |
cvc2 |
String |
Required |
@Length(min = 3, max = 3) |
Sender card cvc2/cvv2. |
type |
String |
Required |
@NotNull |
Transaction in 'SENDER' or 'RECEIVER' currency, for specific transaction type. CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER. |
merchantUrl |
String |
Required except CASH-PLAIN transactions. |
@NotNull except CASH-PLAIN |
Merchant identifier such as the business website URL or reverse domain name as presented to the consumer during checkout |
addressIp |
String |
Required except CASH-PLAIN transactions @Must conform to the IPv4 or IPv6 standard. |
@NotNull except CASH-PLAIN |
The IP address of the order of transaction. |
requestId |
String |
Optional |
@NotNull |
128 bit number generated by the user, used to identify single transaction. Ensures that the transaction with the given parameter is processed only once. |
sender |
Object |
Required |
@NotNull |
Personal data of Sender. |
receiver |
Object |
Required |
@NotNull |
Personal data of Receiver. |
outside3ds.cavv |
String |
Required |
@NotNull |
Cardholder Authentication Verification Value. |
outside3ds.eci |
String |
Required |
@NotNull |
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 |
Required |
@NotNull |
Authentication status. If AuthenticationStatus is "Y" or "A" then outside 3ds flow will be execute. |
outside3ds.transactionXId |
String |
Optional |
@NotNull |
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 |
Optional |
@Optional |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm. |
POST /client/delayed/send-money HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 1024
Host: java-staging.fenige.pl:8181
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "02",
"authenticationStatus" : "Y",
"eci" : "02",
"transactionXId" : "461a228f-03c3-4d78-9748-677cfefd7208"
},
"requestId" : "241b0b7f-ab25-4917-8a2d-4eaa3552f93c",
"sender" : {
"type" : "PLAIN",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-12-09",
"cardNumber" : "5117964247989169",
"expirationDate" : "03/26",
"personalId" : "AGC688910",
"currency" : "PLN"
},
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "receiverEmail@fenige.pl",
"birthDate" : "2023-12-09",
"currency" : "USD"
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
amount |
Number |
Required |
@NotNull, positive |
The total transfer amount (in pennies). |
cvc2 |
String |
Required |
@Length(min = 3, max = 3) |
Sender card cvc2/cvv2. |
type |
String |
Required |
@NotNull |
Transaction in 'SENDER' or 'RECEIVER' currency, for specific transaction type. CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER. |
merchantUrl |
String |
Required except CASH-PLAIN transactions. |
@NotNull except CASH-PLAIN |
Merchant identifier such as the business website URL or reverse domain name as presented to the consumer during checkout |
addressIp |
String |
Required except CASH-PLAIN transactions @Must conform to the IPv4 or IPv6 standard. |
@NotNull except CASH-PLAIN |
The IP address of the order of transaction. |
requestId |
String |
Optional |
@NotNull |
128 bit number generated by the user, used to identify single transaction. Ensures that the transaction with the given parameter is processed only once. |
sender |
Object |
Required |
@NotNull |
Personal data of Sender. |
receiver |
Object |
Required |
@NotNull |
Personal data of Receiver. |
outside3ds.cavv |
String |
Required |
@NotNull |
Cardholder Authentication Verification Value. |
outside3ds.eci |
String |
Required |
@NotNull |
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 |
Required |
@NotNull |
Authentication status. If AuthenticationStatus is "Y" or "A" then outside 3ds flow will be execute. |
outside3ds.transactionXId |
String |
Optional |
@NotNull |
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 |
Optional |
@Optional |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm. |
Response
Response status
| Status | Description |
|---|---|
|
Delayed Send Money approved for processing and transaction details returned. |
|
Returned list of field name which has validation errors. |
|
- Returned when the transaction with the provided requestId has been registered in the system, but has not yet been completed. The user can retry in a few seconds to get the transaction result. Response body: Empty |
|
Returned when request is incorrect, required fields are missing or the values are not valid. |
|
Returned when API-TOKEN was broken. |
|
Returned when user provides wrong order-id or transaction was failed or was Declined. |
Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1080
{
"amount" : 2000,
"bigDecimalAmount" : 20.0,
"commission" : 0,
"bigDecimalCommission" : 0,
"orderId" : "83b2e142-026e-41d9-b556-d02e1e59bfd1",
"createdDate" : "09-11-2020, 21:12",
"fundingRrn" : "031420000725",
"paymentRrn" : "031420000725",
"transactionStatus" : "APPROVED",
"responseCode" : "CODE_00",
"revaluationResult" : {
"revaluationFundingAmount" : 2000,
"bigDecimalRevaluationFundingAmount" : 20.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 2000,
"bigDecimalRevaluationPaymentAmount" : 20.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "Rob",
"lastName" : "Wring",
"hiddenCardNumber" : "511796******9169",
"provider" : "MASTERCARD",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Mark",
"lastName" : "Smith",
"hiddenCardNumber" : "511796******9169",
"provider" : "MASTERCARD",
"bankName" : "Alior Bank SA"
},
"3DS" : true
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Unique transaction identifier. |
|
|
Transaction status. |
|
|
Response code. |
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100]. |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100]. |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Amount (in pennies) of funding transaction in fundingCurrency. |
|
|
Amount of funding transaction in fundingCurrency. |
|
|
Currency code the same as sender’s card currency. |
|
|
Amount (in pennies) of payment transaction in paymentCurrency. |
|
|
Amount of payment transaction in paymentCurrency. |
|
|
Currency code the same as receiver’s card currency. |
|
|
Currency which was conversion from. |
|
|
Resulted currency. |
|
|
Currency rate. |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 943
{
"amount" : 2000,
"bigDecimalAmount" : 20.0,
"commission" : 0,
"bigDecimalCommission" : 0,
"orderId" : "1aaa1a06-3fc5-4f9f-a50b-aa58441bea8a",
"createdDate" : "09-11-2020, 21:12",
"fundingRrn" : "031420000725",
"transactionStatus" : "APPROVED_WAITING_FOR_RECEIVER",
"responseCode" : "CODE_00",
"revaluationResult" : {
"revaluationFundingAmount" : 2000,
"bigDecimalRevaluationFundingAmount" : 20.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 2000,
"bigDecimalRevaluationPaymentAmount" : 20.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"email" : "receiver@fenige.pl"
},
"sender" : {
"firstName" : "Mark",
"lastName" : "Smith",
"hiddenCardNumber" : "511796******9169",
"provider" : "MASTERCARD",
"bankName" : "Alior Bank SA"
},
"3DS" : true
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Unique transaction identifier. |
|
|
Transaction status. |
|
|
Response code. |
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100]. |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100]. |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Amount (in pennies) of funding transaction in fundingCurrency. |
|
|
Amount of funding transaction in fundingCurrency. |
|
|
Currency code the same as sender’s card currency. |
|
|
Amount (in pennies) of payment transaction in paymentCurrency. |
|
|
Amount of payment transaction in paymentCurrency. |
|
|
Currency code the same as receiver’s card currency. |
|
|
Currency which was conversion from. |
|
|
Resulted currency. |
|
|
Currency rate. |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 104
{
"error" : {
"status" : "ERROR_INVALID_JSON",
"message" : "Some properties are invalid"
}
}HTTP/1.1 500 Internal Server Error
Content-Type: text/plain;charset=ISO-8859-1
{
“status”: “ERROR_FUNDING_FAILED”,
“error”: {
“message”: “FUNDING_TRANSACTION_DECLINED:CODE_05”
}
}| After receiving these statuses, the transaction was rejected |
Error statuses
| Name | Description |
|---|---|
|
CODE_XX - is MasterCard response code (ISO 8583) |
|
This card is not supported |
|
Card is blocked for 1 hour in Fenige |
|
User is blocked in Fenige |
|
API-TOKEN header not found in request with DATACORE/PHONE model in sender or receiver |
|
Bin is blocked for 1 hour in Fenige |
|
Funding bank is blocked in Fenige |
|
Payment bank is blocked in Fenige |
|
Funding transaction was declined and payment not send |
|
Payment transaction was declined and funding was reversed |
|
A connection error occurred to Acquirer service |
|
User was found on the stop list |
|
Acceptance network is unavailable |
|
No currently effective rates found in the database |
|
Currency is not supported |
|
Currency is not supported by Merchant |
|
Sender’s card is blocked |
|
Receiver’s card is blocked |
|
User acting as sender is blocked |
|
User acting as receiver is blocked |
|
BIN of sender’s card is blocked |
|
BIN of receiver’s card is blocked |
|
Amount is higher than acceptable limit |
|
Couldn’t established connection to Monitoring service |
|
Error with service authorization occurred |
|
Some unrecognized error occurred |
|
Couldn’t established connection to MPI service |
|
Funding transaction declined - mip response timeout |
|
Payment transaction declined - mip response timeout |
|
Funding process failed and it is need to manual verification of transaction |
|
Payment process failed and it is need to manual verification of transaction |
|
Funding transaction declined - mip_proxy response timeout |
|
Payment transaction declined - mip_proxy response timeout |
|
TransactionXId is invalid for card number specified in the request, 3DS 2.X flow invoked for other card number than specified in the request |
|
TransactionXId is invalid for merchant specified in the request, 3DS 2.X flow invoked for other merchant than specified in the request |
|
Card not found by transactionXId |
|
Card authentication does not match to payment type |
|
Error 3DS 2.X processing failed |
|
Required configuration data of Merchant are not complete to finish 3DS 2.X process |
|
Some unrecognized, internal error occurred in MPI2 service |
|
Merchant has configured a different version of 3DS than specified in the request |
|
Error no 3ds authorization, when User authenticates successfully but after 15 minutes or User doesn’t authenticate. |
|
Error occurs, when merchant configuration allows only for attempted or full authenticated 3DS transactions with mpi status 'A' or 'Y' but mpi service has returned other status e.g. 'N' or 'U' at any stage of the transaction. |
|
Error transaction not exists |
|
Card was not found |
|
Some validation error occurred |
|
Transaction limit for single transaction exceeded |
|
Daily transaction limit for amount per card exceeded |
|
Daily transaction limit for count per card exceeded |
|
Monthly transaction limit for amount per card exceeded |
|
Monthly transaction limit for count per card exceeded |
|
Daily cumulative limit per card was exceeded |
|
Monthly cumulative limit per card was exceeded |
|
Daily cumulative limit per merchant transactions using mastercard cards was exceeded |
|
Monthly cumulative limit per merchant transactions using mastercard cards was exceeded |
|
Daily cumulative limit per merchant transactions using visa cards was exceeded |
|
Monthly cumulative limit per merchant transactions using visa cards was exceeded |
|
Daily cumulative limit per merchant transactions using mastercard and visa cards was exceeded |
|
Monthly cumulative limit per merchant transactions using mastercard and visa cards was exceeded |
|
Error during limit checking |
|
Transaction rejected, second transaction with merchant advice code 03 or 21 within 30 days. |
|
An unrecognized error occurred |
|
The amount sent is too small. Enter a larger amount |
|
The amount sent is too high. Enter a lower amount |
HTTP/1.1 500 Internal Server Error
Content-Type: text/plain;charset=ISO-8859-1
{
"status" : "ERROR_RECEIVER_CARD_IS_BLOCKED"
"cardBlockData": {
"blockType": "TEMP",
"blockedUntil": "2022-09-24T14:03:56.000"
}
}| After receiving these statuses, the transaction was rejected |
Error statuses
| Name | Description | Allow to try again |
|---|---|---|
|
|
No |
|
|
No |
|
|
No |
|
There is no Delayed Payment with given orderId |
No |
|
Critical internal exception occurred in system while trying to make Delayed Payment |
Yes |
|
|
Yes |
|
CODE_XX - is MasterCard response code (ISO 8583) |
Yes |
|
This card is not supported |
Yes |
|
Card is blocked for 1 hour in Fenige |
Yes |
|
User is blocked in Fenige |
Yes |
|
Bin is blocked for 1 hour in Fenige |
Yes |
|
Payment bank is blocked in Fenige |
Yes |
|
Payment transaction was declined and funding was reversed |
Yes |
|
A connection error occurred to Acquirer service |
Yes |
|
User was found on the stop list |
Yes |
|
Acceptance network is unavailable |
Yes |
|
No currently effective rates found in the database |
Yes |
|
Currency is not supported |
Yes |
|
Currency is not supported by Merchant |
Yes |
|
Receiver’s card is blocked |
Yes |
|
User acting as receiver is blocked |
Yes |
|
BIN of receiver’s card is blocked |
Yes |
|
Amount is higher than acceptable limit |
Yes |
|
Couldn’t established connection to Monitoring service |
Yes |
|
Error with service authorization occurred |
Yes |
|
Some unrecognized error occurred |
Yes |
|
Some problem with authorized the user. |
Yes |
|
The transaction user’s personal data verified as incorrect on the verification service. Transaction rejected. |
No |
|
Couldn’t established connection to MPI service |
Yes |
|
Payment transaction declined - mip response timeout |
Yes |
|
Payment process failed and it is need to manual verification of transaction |
Yes |
|
Payment transaction declined - mip_proxy response timeout |
Yes |
|
Error transaction not exists |
Yes |
|
Card was not found |
No |
|
Problem with DC |
Yes |
|
Some validation error occurred |
Yes |
|
An unrecognized error occurred |
Yes |
|
Merchant is marked as high risk and does not allow the execution of transaction with the given card country |
Yes |
|
System does not allow the execution of transaction with the given card country |
Yes |
|
Geographic scope is not permitted for this transaction |
Yes |
HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1
{
"status" : "ERROR_VALIDATION",
"error" : {
"message": "Some information is missing or incorrect.",
"errors": [{
"field": "requestId",
"message": [
"may not be null"
]
},
{
"field": "cvc2",
"message": [
"may not be null",
"length must be 3"
]
},
{
"field": "type",
"message": [
"may not be null"
]
},
{
"field": "amount",
"message": [
"may not be null"
]
},
{
"field": "sender",
"message": [
"may not be null"
]
},
{
"field": "sender.cardNumber",
"message": [
"may not be null",
"may not be empty",
"card number length must be 16"
]
},
{
"field": "sender.expirationDate",
"message": [
"invalid card expiration date",
"may not be null",
"may not be empty"
]
},
{
"field": "sender.city",
"message": [
"may not be empty",
"may not be null",
"length must be between 1 and 25"
]
},
{
"field": "sender.street",
"message": [
"may not be null",
"may not be empty",
"length must be between 1 and 50"
]
},
{
"field": "sender.postalCode",
"message": [
"may not be empty",
"may not be null",
"length must be between 1 and 10"
]
},
{
"field": "sender.flatNumber",
"message": [
"must be null",
"length must be between 0 and 5"
]
},
{
"field": "sender.lastName",
"message": [
"may not be empty",
"may not be null",
"length must be between 2 and 35"
]
},
{
"field": "sender.houseNumber",
"message": [
"may not be empty",
"may not be null",
"length must be between 1 and 10",
"must match the expression: ^[1-9]{1}[0-9]{0,4}[A-z]?(?:[-/ ][1-9]{0,1}[0-9]{0,4}[A-z]?)?$"
]
},
{
"field": "sender.firstName",
"message": [
"may not be empty",
"may not be null",
"length must be between 2 and 35"
]
},
{
"field": "sender.email",
"message": [
"may not be empty",
"may not be null",
"not a well-formed email address",
"lenght must be beetween 1 and 128"
]
},
{
"field": "receiver",
"message": [
"may not be null"
]
},
{
"field": "receiver.currency",
"message": [
"may not be null"
]
},
{
"field": "receiver.phoneNumber",
"message": [
"may not be null",
"may not be empty"
]
},
{
"field": "receiver.email",
"message": [
"may not be null",
"may not be empty"
]
},
{
"field": "receiver",
"message": [
"Phone number or email must be present"
]
},
{
"field": "sender",
"message": [
"province is mandatory only if country code is US or CA"
]
},
{
"field": "sender.province",
"message": [
"is not correct province code for country code US",
"may not be null"
]
},
{
"field": "sender.province",
"message": [
"may not be null",
"is not correct province code for country code CA"
]
},
{
"field": "sender.province",
"message": [
"must match ^[A-Z]{2}$",
"is not correct province code for country code US"
]
},
{
"field": "sender.currency",
"message": [
"Currency is not supported"
]
},
{
"field": "receiver.currency",
"message": [
"Currency is not supported"
]
}
]
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_API_TOKEN_NOT_FOUND",
"error": {
"message": "API-TOKEN header not found in request with DATACORE/PHONE model in sender or receiver."
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1
{
"status": "ERROR_MERCHANT_NOT_SUPPORT_CARD_PROVIDER",
"error": {
"message": "Merchant not support the given card provider, please check merchant configuration"
}
}| Errors mentioned below may occur if card’s country is other than user’s country for USA or CAN transaction |
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_WHILE_VALIDATING_CARD_COUNTRY_CODE_AND_USER_COUNTRY_CODE_FOR_PLAIN",
"error": {
"message": "Card country code not compatible with user country code. Please update country in request."
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_WHILE_VALIDATING_CARD_COUNTRY_CODE_AND_USER_COUNTRY_CODE",
"error": {
"message": "Card country code not compatible with user country code. Please update user profile."
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_WHILE_GETTING_COUNTRY_CODE",
"error": {
"message": "Could not get card country code"
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_WHILE_VALIDATING_PROVINCE_NOT_CORRECT_PROVINCE_CODE",
"error": {
"message": "Province code is not valid province code. Please update user profile"
}
}| Error described bellow may occur when merchant tries to make transaction in other model than assigned primarily. For example, if merchant’s model is set as Card-Card and then merchant will try to make transaction in Cash-Card model, will receive error as bellow. |
HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [
{
"field": "sender.type",
"message": [
"Sender type violates merchant model"
]
}
]
}
}| Errors below may occur when a merchant uses a sender card or a receiver card issued in a country that is on the list of countries High Risk excluded from the Fenige API transactions. The transaction is treated as high risk and rejected. Please contact support. |
HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1
{
"status": "ERROR_MERCHANT_FUNDING_CARD_COUNTRY_RESTRICTED",
"error": {
"message": "Restricted funding card country was used."
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1
{
"status": "ERROR_MERCHANT_PAYMENT_CARD_COUNTRY_RESTRICTED",
"error": {
"message": "Restricted payment card country was used."
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1
{
"status": "ERROR_TRANSACTION_GEOGRAPHIC_SCOPE_BLOCKED",
"error": {
"message": "Geographic scope is not permitted for this transaction"
}
}| Errors below may occur when a merchant uses a sender card or a receiver card issued in a country that is on the list of countries excluded from the Fenige API transactions. Please contact support. |
HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1
{
"status": "ERROR_FUNDING_CARD_COUNTRY_RESTRICTED",
"error": {
"message": "Restricted funding card country was used."
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1
{
"status": "ERROR_PAYMENT_CARD_COUNTRY_RESTRICTED",
"error": {
"message": "Restricted payment card country was used."
}
}| Errors mentioned below may occur if sender firstName and lastName are the same |
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [
{
"field": "sender.firstName",
"message": [
"invalid sender firstName and lastName the same"
]
}
]
}
}| Errors mentioned below may occur if sender firstName or lastName contains all the same characters |
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [
{
"field": "sender.firstName",
"message": [
"invalid sender firstName contains all the same characters"
]
}
]
}
}
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [
{
"field": "sender.lastName",
"message": [
"invalid sender lastName contains all the same characters"
]
}
]
}
}HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
"timestamp": "2021-12-22T12:39:53.168+0000",
"status": 401,
"error": "Unauthorized",
"message": "Username or password is not correct",
"path": "/client/delayed/send-money"
}HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
"timestamp": "2021-12-22T12:39:53.168+0000",
"status": 401,
"error": "Unauthorized",
"message": "ERROR_USER_NOTFOUND",
"path": "/client/delayed/send-money"
}| Path | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
HTTP/1.1 403 Forbidden
Content-Type: application/json
{
"timestamp": 1610464313387,
"status": 403,
"error": "Forbidden",
"message": "No message available",
"path": "/client/delayed/send-money"
}3.5.2. Delayed Payment
The Delayed Payment method is used to send the Receiver's data and finalize the transaction flow. In order to make this Payment, user must do Funding firstly. In response to Funding, we get an 'orderId' field, which we must use in the Delayed Payment request's body. If the Funding has not been completed or if the Funding has already been completed (with success or with failure), Payment will not be processed. Since october '22 it is possible to make delayed payment with cardId so we don't need to know plain card number now and we can user data stored before. Look at MASTERCARD (cardId) and VISA(cardId) tabs.
| The maximum time for the execution of Delayed Payment after earlier calling Delayed Send Money is 12 hours. After 12 hours after Funding without Payment, it will be reversed and sender will get their funds back. Your server will receive Webhook Event after Reversal Funding if webhook is enabled in your merchant configuration. |
| There is 3 attempts to execute Delayed Payment after earlier call Delayed Send Money. |
Delayed Payment Examples
Example HTTP Request
POST /client/delayed/payment HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 338
Host: java-staging.fenige.pl:8181
{
"orderId" : "3c131d39-6bb1-445a-bf78-4257bbc9f64a",
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"cardNumber" : "4485909148265810",
"rememberReceiver" : false,
"phoneNumber" : "48560740349",
"currency" : "PLN"
},
"requestId" : "3c131d39-6bb1-445a-bf78-4257bbc9f64a"
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
orderId |
String |
Required |
@NotNull |
Unique transaction identifier. |
requestId |
String |
Optional |
@Uuid |
128 bit number generated by the user, used to identify single transaction. Ensures that the transaction with the given parameter is processed only once. |
receiver.type |
String |
Required |
@NotNull |
For this configuration the value of this field must be "DELAYED". |
receiver.firstName |
String |
Required |
@NotNull |
Receiver first name. |
receiver.lastName |
String |
Required |
@NotNull |
Receiver last name. |
receiver.cardNumber |
String |
Required |
@NotNull |
Receiver card number. |
receiver.currency |
String |
Required |
@NotNull |
Currency for transaction. Example: PLN. |
receiver.phoneNumber |
String |
Required |
@NotNull |
Receiver phone number. |
receiver.rememberReceiver |
Boolean |
Required |
@NotNull |
By sending this field as 'true' value you can save receiver. |
POST /client/delayed/payment HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 338
Host: java-staging.fenige.pl:8181
{
"orderId" : "930dff03-8495-44ff-84c0-693b5f0b093c",
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"cardNumber" : "5117964247989169",
"rememberReceiver" : false,
"phoneNumber" : "48560740349",
"currency" : "PLN"
},
"requestId" : "930dff03-8495-44ff-84c0-693b5f0b093c"
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
orderId |
String |
Required |
@NotNull |
Unique transaction identifier. |
requestId |
String |
Optional |
@Uuid |
128 bit number generated by the user, used to identify single transaction. Ensures that the transaction with the given parameter is processed only once. |
receiver.type |
String |
Required |
@NotNull |
For this configuration the value of this field must be "DELAYED". |
receiver.firstName |
String |
Required |
@NotNull |
Receiver first name. |
receiver.lastName |
String |
Required |
@NotNull |
Receiver last name. |
receiver.cardNumber |
String |
Required |
@NotNull |
Receiver card number. |
receiver.currency |
String |
Required |
@NotNull |
Currency for transaction. Example: PLN. |
receiver.phoneNumber |
String |
Required |
@NotNull |
Receiver phone number. |
receiver.rememberReceiver |
Boolean |
Required |
@NotNull |
By sending this field as 'true' value you can save receiver. |
POST /client/delayed/payment HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 340
Host: java-staging.fenige.pl:8181
{
"orderId" : "1618c7f7-43f1-4bb3-b88d-2ec4f45a5926",
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "rob.wring@fenige.pl",
"cardNumber" : "4485909148265810",
"rememberReceiver" : false,
"currency" : "PLN"
},
"requestId" : "1618c7f7-43f1-4bb3-b88d-2ec4f45a5926"
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
orderId |
String |
Required |
@NotNull |
Unique transaction identifier. |
requestId |
String |
Optional |
@Uuid |
128 bit number generated by the user, used to identify single transaction. Ensures that the transaction with the given parameter is processed only once. |
receiver.type |
String |
Required |
@NotNull |
For this configuration the value of this field must be "DELAYED". |
receiver.firstName |
String |
Required |
@NotNull |
Receiver first name. |
receiver.lastName |
String |
Required |
@NotNull |
Receiver last name. |
receiver.email |
String |
Required |
@NotNull |
Receiver email. |
receiver.cardNumber |
String |
Required |
@NotNull |
Receiver card number. |
receiver.currency |
String |
Required |
@NotNull |
Currency for transaction. Example: PLN. |
receiver.rememberReceiver |
Boolean |
Required |
@NotNull |
By sending this field as 'true' value you can save receiver. |
POST /client/delayed/payment HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 340
Host: java-staging.fenige.pl:8181
{
"orderId" : "4cea5663-651d-43a5-b68d-398d0dbc3df6",
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "rob.wring@fenige.pl",
"cardNumber" : "5117964247989169",
"rememberReceiver" : false,
"currency" : "PLN"
},
"requestId" : "4cea5663-651d-43a5-b68d-398d0dbc3df6"
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
orderId |
String |
Required |
@NotNull |
Unique transaction identifier. |
requestId |
String |
Optional |
@Uuid |
128 bit number generated by the user, used to identify single transaction. Ensures that the transaction with the given parameter is processed only once. |
receiver.type |
String |
Required |
@NotNull |
For this configuration the value of this field must be "DELAYED". |
receiver.firstName |
String |
Required |
@NotNull |
Receiver first name. |
receiver.lastName |
String |
Required |
@NotNull |
Receiver last name. |
receiver.email |
String |
Required |
@NotNull |
Receiver email. |
receiver.cardNumber |
String |
Required |
@NotNull |
Receiver card number. |
receiver.currency |
String |
Required |
@NotNull |
Currency for transaction. Example: PLN. |
receiver.rememberReceiver |
Boolean |
Required |
@NotNull |
By sending this field as 'true' value you can save receiver. |
POST /client/delayed/payment HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 322
Host: java-staging.fenige.pl:8181
{
"orderId" : "f924a801-9691-4f2f-bce6-57ddb99e3057",
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "rob.wring@fenige.pl",
"cardId" : 1234,
"rememberReceiver" : false,
"currency" : "PLN"
},
"requestId" : "f924a801-9691-4f2f-bce6-57ddb99e3057"
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
orderId |
String |
Required |
@NotNull |
Unique transaction identifier. |
requestId |
String |
Optional |
@Uuid |
128 bit number generated by the user, used to identify single transaction. Ensures that the transaction with the given parameter is processed only once. |
receiver.type |
String |
Required |
@NotNull |
For this configuration the value of this field must be DELAYED. |
receiver.email |
String |
Required |
@NotNull |
Receiver email. |
receiver.cardId |
Number |
Required |
@NotNull |
Receiver card id. |
receiver.currency |
String |
Required |
@NotNull |
Currency for transaction. Example: PLN. |
receiver.firstName |
String |
Optional |
@NotNull |
Receiver first name. |
receiver.lastName |
String |
Optional |
@NotNull |
Receiver last name. |
POST /client/delayed/payment HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 322
Host: java-staging.fenige.pl:8181
{
"orderId" : "f2b1f1b3-d7d0-4592-afa6-906bbe3bb12c",
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "rob.wring@fenige.pl",
"cardId" : 1234,
"rememberReceiver" : false,
"currency" : "PLN"
},
"requestId" : "f2b1f1b3-d7d0-4592-afa6-906bbe3bb12c"
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
orderId |
String |
Required |
@NotNull |
Unique transaction identifier. |
requestId |
String |
Optional |
@Uuid |
128 bit number generated by the user, used to identify single transaction. Ensures that the transaction with the given parameter is processed only once. |
receiver.type |
String |
Required |
@NotNull |
For this configuration the value of this field must be DELAYED. |
receiver.email |
String |
Required |
@NotNull |
Receiver email. |
receiver.cardId |
Number |
Required |
@NotNull |
Receiver card id. |
receiver.currency |
String |
Required |
@NotNull |
Currency for transaction. Example: PLN. |
receiver.firstName |
String |
Optional |
@NotNull |
Receiver first name. |
receiver.lastName |
String |
Optional |
@NotNull |
Receiver last name. |
Response
Response status
Status |
Description |
|
Delayed Send Money approved for processing and transaction details returned. |
|
Returned when request is incorrect, required fields are missing or the values are not valid. |
|
Returned when user provides wrong order-id or transaction was failed or was Declined. |
Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1069
{
"amount" : 2000,
"amountInUsDollar" : 537,
"bigDecimalAmount" : 20.0,
"commission" : 0,
"bigDecimalCommission" : 0,
"orderId" : "c90693bc-3a52-4f71-a01c-183fb4a811b7",
"fundingRrn" : "031420000725",
"paymentRrn" : "031420000726",
"3DS" : true,
"revaluationResult" : {
"revaluationFundingAmount" : 2000,
"bigDecimalRevaluationFundingAmount" : 20.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 2000,
"bigDecimalRevaluationPaymentAmount" : 20.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "Rob",
"lastName" : "Wring",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "511796******9169",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Mark",
"lastName" : "Smith",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "511796******9169",
"bankName" : "Alior Bank SA"
},
"transactionStatus" : "APPROVED",
"responseCode" : "CODE_00"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Unique transaction identifier. |
|
|
Transaction status. |
|
|
Response code. |
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Amount (in pennies) of funding transaction in fundingCurrency. |
|
|
Amount of funding transaction in fundingCurrency. |
|
|
Currency code the same as sender’s card currency |
|
|
Amount (in pennies) of payment transaction in paymentCurrency. |
|
|
Amount of payment transaction in paymentCurrency. |
|
|
Currency code the same as receiver’s card currency. |
|
|
Currency which was conversion from. |
|
|
Resulted currency. |
|
|
Currency rate. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
HTTP/1.1 400 BAD REQUEST
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 104
{
"error" : {
"status" : "ERROR_INVALID_JSON",
"message" : "Some properties are invalid"
}
}| Errors mentioned below may occur if receiver firstName and lastName are the same |
HTTP/1.1 400 BAD REQUEST
Content-Type: application/json
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [
{
"field": "receiver.firstName",
"message": [
"invalid receiver firstName and lastName the same"
]
}
]
}
}| Errors mentioned below may occur if receiver firstName or lastName contains all the same characters |
HTTP/1.1 400 BAD REQUEST
Content-Type: application/json
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [
{
"field": "receiver.firstName",
"message": [
"invalid receiver firstName contains all the same characters"
]
}
]
}
}HTTP/1.1 400 BAD REQUEST
Content-Type: application/json
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [
{
"field": "receiver.lastName",
"message": [
"invalid receiver lastName contains all the same characters"
]
}
]
}
}| Errors mentioned below may occur if sender email is equal to receiver email, but firstName and lastName data are different |
HTTP/1.1 400 BAD REQUEST
Content-Type: application/json
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [
{
"field": "sender.email",
"message": [
"invalid sender and receiver email the same for different person"
]
}
]
}
}HTTP/1.1 500 Internal Server Error
Content-Type: text/plain;charset=ISO-8859-1
{
"status" : "PAYMENT_TRANSACTION_DECLINED:CODE_05"
}| After receiving these statuses, the transaction was rejected |
Error statuses
| Name | Description | Allow to try again |
|---|---|---|
|
|
No |
|
|
No |
|
|
No |
|
There is no Delayed Payment with given orderId |
No |
|
Critical internal exception occurred in system while trying to make Delayed Payment |
Yes |
|
|
Yes |
|
CODE_XX - is MasterCard response code (ISO 8583) |
Yes |
|
This card is not supported |
Yes |
|
Card is blocked for 1 hour in Fenige |
Yes |
|
User is blocked in Fenige |
Yes |
|
Bin is blocked for 1 hour in Fenige |
Yes |
|
Payment bank is blocked in Fenige |
Yes |
|
Payment transaction was declined and funding was reversed |
Yes |
|
A connection error occurred to Acquirer service |
Yes |
|
User was found on the stop list |
Yes |
|
Acceptance network is unavailable |
Yes |
|
No currently effective rates found in the database |
Yes |
|
Currency is not supported |
Yes |
|
Currency is not supported by Merchant |
Yes |
|
Receiver’s card is blocked |
Yes |
|
User acting as receiver is blocked |
Yes |
|
BIN of receiver’s card is blocked |
Yes |
|
Amount is higher than acceptable limit |
Yes |
|
Couldn’t established connection to Monitoring service |
Yes |
|
Error with service authorization occurred |
Yes |
|
Some unrecognized error occurred |
Yes |
|
Some problem with user authorization in Datacenter |
Yes |
|
The transaction user’s personal data verified as incorrect on the verification service. Transaction rejected. |
No |
|
Couldn’t established connection to MPI service |
Yes |
|
Payment transaction declined - mip response timeout |
Yes |
|
Payment process failed and it is need to manual verification of transaction |
Yes |
|
Payment transaction declined - mip_proxy response timeout |
Yes |
|
Error transaction not exists |
Yes |
|
Card was not found |
No |
|
Problem with DC |
Yes |
|
Some validation error occurred |
Yes |
|
Merchant is marked as high risk and does not allow the execution of transaction with the given card country |
Yes |
|
System does not allow the execution of transaction with the given card country |
Yes |
|
Geographic scope is not permitted for this transaction |
Yes |
|
Transaction limit for single transaction exceeded |
Yes |
|
Daily transaction limit for amount per card exceeded |
Yes |
|
Daily transaction limit for count per card exceeded |
Yes |
|
Monthly transaction limit for amount per card exceeded |
Yes |
|
Monthly transaction limit for count per card exceeded |
Yes |
|
Daily cumulative limit per card was exceeded |
Yes |
|
Monthly cumulative limit per card was exceeded |
Yes |
|
Daily cumulative limit per merchant transactions using mastercard cards was exceeded |
Yes |
|
Monthly cumulative limit per merchant transactions using mastercard cards was exceeded |
Yes |
|
Daily cumulative limit per merchant transactions using visa cards was exceeded |
Yes |
|
Monthly cumulative limit per merchant transactions using visa cards was exceeded |
Yes |
|
Daily cumulative limit per merchant transactions using mastercard and visa cards was exceeded |
Yes |
|
Monthly cumulative limit per merchant transactions using mastercard and visa cards was exceeded |
Yes |
|
Error during limit checking |
Yes |
|
An unrecognized error occurred |
Yes |
HTTP/1.1 500 Internal Server Error
Content-Type: text/plain;charset=ISO-8859-1
{
"status" : "ERROR_RECEIVER_CARD_IS_BLOCKED"
"cardBlockData": {
"blockType": "TEMP",
"blockedUntil": "2022-09-24T14:03:56.000"
}
}| After receiving these statuses, the transaction was rejected |
Error statuses
| Name | Description | Allow to try again |
|---|---|---|
|
|
No |
|
|
No |
|
|
No |
|
There is no Delayed Payment with given orderId |
No |
|
Critical internal exception occurred in system while trying to make Delayed Payment |
Yes |
|
|
Yes |
|
CODE_XX - is MasterCard response code (ISO 8583) |
Yes |
|
This card is not supported |
Yes |
|
Card is blocked for 1 hour in Fenige |
Yes |
|
User is blocked in Fenige |
Yes |
|
Bin is blocked for 1 hour in Fenige |
Yes |
|
Payment bank is blocked in Fenige |
Yes |
|
Payment transaction was declined and funding was reversed |
Yes |
|
A connection error occurred to Acquirer service |
Yes |
|
User was found on the stop list |
Yes |
|
Acceptance network is unavailable |
Yes |
|
No currently effective rates found in the database |
Yes |
|
Currency is not supported |
Yes |
|
Currency is not supported by Merchant |
Yes |
|
Receiver’s card is blocked |
Yes |
|
User acting as receiver is blocked |
Yes |
|
BIN of receiver’s card is blocked |
Yes |
|
Amount is higher than acceptable limit |
Yes |
|
Couldn’t established connection to Monitoring service |
Yes |
|
Error with service authorization occurred |
Yes |
|
Some unrecognized error occurred |
Yes |
|
Some problem with authorized the user. |
Yes |
|
The transaction user’s personal data verified as incorrect on the verification service. Transaction rejected. |
No |
|
Couldn’t established connection to MPI service |
Yes |
|
Payment transaction declined - mip response timeout |
Yes |
|
Payment process failed and it is need to manual verification of transaction |
Yes |
|
Payment transaction declined - mip_proxy response timeout |
Yes |
|
Error transaction not exists |
Yes |
|
Card was not found |
No |
|
Problem with DC |
Yes |
|
Some validation error occurred |
Yes |
|
An unrecognized error occurred |
Yes |
|
Merchant is marked as high risk and does not allow the execution of transaction with the given card country |
Yes |
|
System does not allow the execution of transaction with the given card country |
Yes |
|
Geographic scope is not permitted for this transaction |
Yes |
3.5.3. Transaction history
Method return page with list of user transactions. Transactions are filtered by clientId provided in GET parameter.
User can send additional optional parameters (page, size) to obtain given page with defined size.
Request
GET /client/0/transactions?fromDate=2018-03-06&toDate=2018-03-08&page=0&size=100 HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181Response
Response status
| Status | Description |
|---|---|
|
Returned list of transactions history. |
|
Returning the list failed. |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1073
{
"content" : [ {
"correlationId" : "ed6c982b-ad4e-4e3d-a5b3-0e3201934447",
"createdDate" : "2018-03-15T10:24:52.149Z",
"amount" : 15000,
"amountInUsDollar" : 4024,
"textAmount" : "150.00 PLN",
"currency" : "PLN",
"cardId" : 3574,
"receiverFirstName" : "Patrick",
"receiverLastName" : "Evans",
"receiverHiddenCardNumber" : "511123******1234",
"receiverProvider" : "MASTERCARD",
"receiverBankName" : "Bank Polska Kasa Opieki Spółka Akcyjna",
"receiverPhone" : "600300200",
"senderFirstName" : "Rob",
"senderLastName" : "Wring",
"senderHiddenCardNumber" : "522212******4321",
"senderProvider" : "MASTERCARD",
"senderBankName" : "Alior Bank SA",
"status" : "approved",
"transactionDirection" : "OUTGOING",
"3DS" : true
} ],
"pageable" : "INSTANCE",
"last" : true,
"totalElements" : 1,
"totalPages" : 1,
"size" : 1,
"number" : 0,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"first" : true,
"numberOfElements" : 1,
"empty" : false
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Unique UUID describing single transaction in system. |
|
|
Date of transaction processing. |
|
|
Transaction amount in pennies. |
|
|
Transaction amount in USD currency in pennies. |
|
|
Transaction amount with currency. |
|
|
Transaction currency. |
|
|
Datacore card id used in transaction (sender card). |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Transaction receiver first name. |
|
|
Transaction receiver last name. |
|
|
Transaction receiver hidden card number. |
|
|
VISA or MASTERCARD or MAESTRO |
|
|
Transaction receiver card bank name. |
|
|
Transaction sender first name. |
|
|
Transaction sender last name. |
|
|
Transaction sender hidden card numbe. |
|
|
VISA or MASTERCARD or MAESTRO |
|
|
Transaction sender card bank name. |
|
|
Transaction receiver phone number. |
|
|
Status of the transaction (approved, reversed, rejected). |
|
|
Direction of the transaction (INCOMING, OUTGOING) |
|
|
Information about the reasons for declined transactions and actions that merchants can take. Occurs only for mastercard and for rejected transactions if Mastercard returns this information |
|
|
Describes whether the page is last (true ot false). |
|
|
Total number of all pages. |
|
|
Total number of all transactions. |
|
|
Number of transactions on page. |
|
|
Describes whether the page is first (true ot false). |
|
|
Details of sort. |
|
|
Max number of transactions on page. |
|
|
Page number. |
|
|
Requested page information. |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1082
{
"content" : [ {
"correlationId" : "556db453-e1e7-44e8-9ea7-975bc6393a9a",
"createdDate" : "2018-03-15T10:24:52.149Z",
"amount" : 15000,
"amountInUsDollar" : 4024,
"textAmount" : "150.00 PLN",
"currency" : "PLN",
"cardId" : 3574,
"receiverFirstName" : "Patrick",
"receiverLastName" : "Evans",
"receiverHiddenCardNumber" : "511123******1234",
"receiverProvider" : "MASTERCARD",
"receiverBankName" : "Bank Polska Kasa Opieki Spółka Akcyjna",
"receiverEmail" : "receiver@fenige.pl",
"senderFirstName" : "Rob",
"senderLastName" : "Wring",
"senderHiddenCardNumber" : "522212******4321",
"senderProvider" : "MASTERCARD",
"senderBankName" : "Alior Bank SA",
"status" : "approved",
"transactionDirection" : "INCOMING",
"3DS" : true
} ],
"pageable" : "INSTANCE",
"last" : true,
"totalElements" : 1,
"totalPages" : 1,
"size" : 1,
"number" : 0,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"first" : true,
"numberOfElements" : 1,
"empty" : false
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Unique UUID describing single transaction in system. |
|
|
Date of transaction processing. |
|
|
Transaction amount in pennies. |
|
|
Transaction amount in USD currency in pennies. |
|
|
Transaction amount with currency. |
|
|
Transaction currency. |
|
|
Datacore card id used in transaction (sender card). |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Transaction receiver first name. |
|
|
Transaction receiver last name. |
|
|
Transaction receiver hidden card number. |
|
|
VISA or MASTERCARD or MAESTRO |
|
|
Transaction receiver card bank name. |
|
|
Transaction sender first name. |
|
|
Transaction sender last name. |
|
|
Transaction sender hidden card number. |
|
|
VISA or MASTERCARD or MAESTRO |
|
|
Transaction sender card bank name. |
|
|
Transaction receiver email. |
|
|
Status of the transaction (approved, reversed, rejected). |
|
|
Direction of the transaction (INCOMING, OUTGOING) |
|
|
Information about the reasons for declined transactions and actions that merchants can take. Occurs only for mastercard and for rejected transactions if Mastercard returns this information |
|
|
Describes whether the page is last (true ot false). |
|
|
Total number of all pages. |
|
|
Total number of all transactions. |
|
|
Number of transactions on page. |
|
|
Describes whether the page is first (true ot false). |
|
|
Details of sort. |
|
|
Max number of transactions on page. |
|
|
Page number. |
|
|
Requested page information. |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 841
{
"content" : [ {
"correlationId" : "194f4cfe-8be7-497a-9a15-68ca0511f4cb",
"createdDate" : "2018-03-15T10:24:52.149Z",
"amount" : 15000,
"amountInUsDollar" : 4024,
"textAmount" : "150.00 PLN",
"currency" : "PLN",
"cardId" : 3574,
"receiverPhone" : "600300200",
"senderFirstName" : "Rob",
"senderLastName" : "Wring",
"senderHiddenCardNumber" : "522212******4321",
"senderProvider" : "MASTERCARD",
"senderBankName" : "Alior Bank SA",
"status" : "approved",
"transactionDirection" : "OUTGOING",
"3DS" : true
} ],
"pageable" : "INSTANCE",
"last" : true,
"totalElements" : 1,
"totalPages" : 1,
"size" : 1,
"number" : 0,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"first" : true,
"numberOfElements" : 1,
"empty" : false
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Unique UUID describing single transaction in system. |
|
|
Date of transaction processing. |
|
|
Transaction amount in pennies. |
|
|
Transaction amount in USD currency in pennies. |
|
|
Transaction amount with currency. |
|
|
Transaction currency. |
|
|
Datacore card id used in transaction (sender card). |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Transaction sender first name. |
|
|
Transaction sender last name. |
|
|
Transaction sender hidden card number. |
|
|
VISA or MASTERCARD or MAESTRO |
|
|
Transaction sender card bank name. |
|
|
Transaction receiver phone number. |
|
|
Status of the transaction (approved, reversed, rejected). |
|
|
Direction of the transaction (INCOMING, OUTGOING) |
|
|
Information about the reasons for declined transactions and actions that merchants can take. Occurs only for mastercard and for rejected transactions if Mastercard returns this information |
|
|
Describes whether the page is last (true ot false). |
|
|
Total number of all pages. |
|
|
Total number of all transactions. |
|
|
Number of transactions on page. |
|
|
Describes whether the page is first (true ot false). |
|
|
Details of sort. |
|
|
Max number of transactions on page. |
|
|
Page number. |
|
|
Requested page information. |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 850
{
"content" : [ {
"correlationId" : "660612d3-a931-4059-b9d9-2945483031c0",
"createdDate" : "2018-03-15T10:24:52.149Z",
"amount" : 15000,
"amountInUsDollar" : 4024,
"textAmount" : "150.00 PLN",
"currency" : "PLN",
"cardId" : 3574,
"receiverEmail" : "receiver@fenige.pl",
"senderFirstName" : "Rob",
"senderLastName" : "Wring",
"senderHiddenCardNumber" : "522212******4321",
"senderProvider" : "MASTERCARD",
"senderBankName" : "Alior Bank SA",
"status" : "approved",
"transactionDirection" : "OUTGOING",
"3DS" : true
} ],
"pageable" : "INSTANCE",
"last" : true,
"totalElements" : 1,
"totalPages" : 1,
"size" : 1,
"number" : 0,
"sort" : {
"empty" : true,
"sorted" : false,
"unsorted" : true
},
"first" : true,
"numberOfElements" : 1,
"empty" : false
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Unique UUID describing single transaction in system. |
|
|
Date of transaction processing. |
|
|
Transaction amount in pennies. |
|
|
Transaction amount in USD currency in pennies. |
|
|
Transaction amount with currency. |
|
|
Transaction currency. |
|
|
Datacore card id used in transaction (sender card). |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Transaction sender first name. |
|
|
Transaction sender last name. |
|
|
Transaction sender hidden card number. |
|
|
VISA or MASTERCARD or MAESTRO |
|
|
Transaction sender card bank name. |
|
|
Transaction receiver email. |
|
|
Status of the transaction (approved, reversed, rejected). |
|
|
Direction of the transaction (INCOMING, OUTGOING) |
|
|
Information about the reasons for declined transactions and actions that merchants can take. Occurs only for mastercard and for rejected transactions if Mastercard returns this information |
|
|
Describes whether the page is last (true ot false). |
|
|
Total number of all pages. |
|
|
Total number of all transactions. |
|
|
Number of transactions on page. |
|
|
Describes whether the page is first (true ot false). |
|
|
Details of sort. |
|
|
Max number of transactions on page. |
|
|
Page number. |
|
|
Requested page information. |
HTTP/1.1 404 Not Found3.5.4. Check detailed status
The method allows obtaining a detailed status of multi-currency transaction specified by order-id. Parameter order-id was returned in the previous step (Send money multicurrency).
|
From January 2021, there is an internal functionality to restrict access for the Merchant to specific method. The Fenige employee can disable access to a given endpoint, then the HTTP status 403 FORBIDDEN will be returned. The Merchant will be informed about each access restriction action. |
Request
| Parameter | Description |
|---|---|
|
Unique transaction identifier. |
GET /client/send-money/details/00549d98-08cb-45d2-8673-4dcafa81f498 HTTP/1.1
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181Response
Response status
| Status | Description |
|---|---|
|
Returned if the transaction completes successfully. |
|
Returned when transaction was registered for processing. Check status in a while. |
|
Returned when a transaction related to the given orderId doesn’t exist. |
|
Returned when user provides wrong order-id or transaction was failed or was Declined. |
|
Returned when an internal error occur. |
Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1159
{
"transactionId" : "TRX220132AM",
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"fundingRrn" : "014011103023",
"paymentRrn" : "014011103024",
"arn" : "05411640143500000019325",
"3DS" : true,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "511796******9169",
"bankName" : "Alior Bank SA"
},
"transactionStatus" : "APPROVED"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. @Length(max = 64). Optional |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Acquirer Reference Number |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender currency and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
|
|
Status of the transaction (PENDING, APPROVED, DECLINED, REJECTED, REVERSED) |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 203 Non-Authoritative Information| After you get 203 you need to check status in a while because we processing this transaction and if you don’t get a response (200 - succeeded or 500 - declined) within 60 seconds then please contact us. |
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 51
{
"errorStatus" : "ERROR_TRANSACTION_NOT_FOUND"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Additional data of the error occurred during a processing of the request |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 1287
{
"transactionId" : "TRX220132AM",
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"fundingRrn" : "014011103023",
"paymentRrn" : "014011103024",
"arn" : "05411640143500000019325",
"3DS" : true,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "511796******9169",
"bankName" : "Alior Bank SA"
},
"transactionStatus" : "DECLINED",
"cardBlockType" : "TEMP",
"cardBlockedUntil" : "2023-12-11T01:03:14.925",
"errorStatus" : "ERROR_SENDER_CARD_IS_BLOCKED"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. @Length(max = 64). Optional |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Acquirer Reference Number |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender currency and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
|
|
Status of the transaction (PENDING, APPROVED, DECLINED, REJECTED, REVERSED) |
|
|
Additional data of the error occurred during a processing of the request |
|
|
Card lock type |
|
|
Card’s lock end date |
|
|
Information about the reasons for declined transactions and actions that merchants can take. Occurs only for mastercard and for rejected transactions if Mastercard returns this information |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 1358
{
"transactionId" : "TRX220132AM",
"amount" : 1000,
"amountInUsDollar" : 268,
"bigDecimalAmount" : 10.0,
"commission" : 200,
"bigDecimalCommission" : 2.0,
"orderId" : "00549d98-08cb-45d2-8673-4dcafa81f498",
"createdDate" : "03-04-2018, 14:01",
"fundingRrn" : "014011103023",
"paymentRrn" : "014011103024",
"arn" : "05411640143500000019325",
"3DS" : false,
"revaluationResult" : {
"revaluationFundingAmount" : 1000,
"bigDecimalRevaluationFundingAmount" : 10.0,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 1000,
"bigDecimalRevaluationPaymentAmount" : 10.0,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
},
"receiver" : {
"firstName" : "John",
"lastName" : "Novak",
"provider" : "MASTERCARD",
"hiddenCardNumber" : "557455******1623",
"bankName" : "Alior Bank SA"
},
"sender" : {
"firstName" : "Caroline",
"lastName" : "Novak",
"provider" : "CASH"
},
"transactionStatus" : "DECLINED",
"merchantSettlementCurrency" : "USD",
"fenigeCommissionInMerchantSettlementCurrency" : 0.05,
"transactionAmountInMerchantSettlementCurrency" : 2.68,
"cardBlockType" : "TEMP",
"cardBlockedUntil" : "2023-12-11T01:03:15.457",
"errorStatus" : "ERROR_SENDER_CARD_IS_BLOCKED"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Field informing about the amount of cash transferred in one hundredth of the currency. [1PLN = 100] |
|
|
Field informing about the amount of cash transferred in one hundredth of the USD currency. [1USD = 100] |
|
|
Field informing about the amount of cash transferred with decimal precision. |
|
|
This is the amount of commission that has been added to the transaction in hundredths. [1 PLN = 100] |
|
|
This is the amount of commission that was added to the transaction at 0.01 currency. |
|
|
Unique transaction identifier. |
|
|
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. @Length(max = 64). Optional |
|
|
Date of transaction. |
|
|
Funding Retrieval Reference Number. |
|
|
Payment Retrieval Reference Number. |
|
|
Acquirer Reference Number |
|
|
Value: true/false determines if transaction was processed with 3ds |
|
|
Detailed information about revaluation between sender currency and receiver currency. |
|
|
Personal data of the person to whom the transfer is addressed. |
|
|
Personal data of the person who performs the transfer of cash. |
|
|
Merchant settlement currency |
|
|
Commission Fenige in merchant settlement currency |
|
|
Transaction amount in merchant settlement currency |
|
|
Status of the transaction (PENDING, APPROVED, DECLINED, REJECTED, REVERSED) |
|
|
The code of the error occurred during a processing of the request |
|
|
Card lock type |
|
|
Card’s lock end date |
|
|
Information about the reasons for declined transactions and actions that merchants can take. Occurs only for mastercard and for declined transactions if Mastercard returns this information |
RevaluationResult
| Path | Type | Description |
|---|---|---|
revaluationFundingAmount |
Long |
Amount (in pennies) of funding transaction in fundingCurrency |
bigDecimalRevaluationFundingAmount |
BigDecimal |
Amount of funding transaction in fundingCurrency |
fundingCurrency |
String |
Currency code the same as sender’s card currency |
revaluationPaymentAmount |
Long |
Amount (in pennies) of payment transaction in paymentCurrency |
bigDecimalRevaluationPaymentAmount |
BigDecimal |
Amount of payment transaction in paymentCurrency |
paymentCurrency |
String |
Currency code the same as receiver’s card currency |
determineCurrencyRate |
Object (DetermineCurrencyRate) |
Details about conversion |
DetermineCurrencyRate
| Path | Type | Description |
|---|---|---|
from |
Long |
Currency which was conversion from |
to |
Long |
Resulted currency |
currencyRate |
BigDecimal |
Currency rate |
HTTP/1.1 500 Internal Server Error
Content-Type: application/json
Content-Length: 69
{
"errorStatus" : "ERROR_SOMETHING_WRONG - Something went wrong."
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Additional data of the error occurred during a processing of the request |
4. Webhooks
General information
To use the webhooks functionality, you must notify Fenige Sales Department by email.
Then an URL address and a secret token will be configured, thanks to which communication between the Fenige side and the client side will be more secure.
After configuring the above-mentioned properties, you will receive Secret Token and then you can handle webhooks from the Fenige system.
The URL must be specified by the client, requests from the Fenige system will be directed to this address.
The Secret Token will be set by the Fenige employee and sent to the client.
4.1. Transaction status
Method: HTTP POST
The client user can be notified immediately as soon as the transaction changes its state.
After handling the request from the Fenige system, the client side will be notified of the current status of the transaction.
Then you can be sure that the transaction processing was finished and you can get the transaction details if you want to.
| Your server after receiving Webhook Event must return HTTP status 200 OK. Otherwise, the Fenige server will retry the request. There is 3 attempts for requesting your API. Repeated requests will be executing in 5 seconds intervals excluding timeout from client server. |
| In order to protect client API by polling or other undesirable actions, the Fenige system uses headers. If you want to use Transaction status webhook, you need to do the header handling on your side. |
|
To build 'X-MERCHANT-SECRET' header:
1. Concatenate secret token established by you and Fenige’s employee with orderId of transaction 2. Hash with SHA256 function result of above operation |
import hashlib
# secret token established by client with fenige employee
secret = 'mNaU9TaK4m9myYYFBJgKu8slNH2fCKutJyzXwI'
# orderId received from webhook's request
order_id = 'c168a885-acfa-4a91-a1ad-ed7a042b7238'
# concatenate strings in correct order
concatenated = secret + order_id
# use SHA256 hashing function
hashed = hashlib.sha256(concatenated.encode('utf-8')).hexdigest()
# then compare 'hashed' variable with content of 'X-MERCHANT-SECRET' header4.1.1. Transaction status webhook request body
Content-Type: application/json
X-MERCHANT-SECRET: 3cbd17f561150a1394cabbe2b6031fd83f3f3081abe28c32b7fed16f32aebc4a
X-MERCHANT-TIMESTAMP: 1614800720
{
"orderId": "c168a885-acfa-4a91-a1ad-ed7a042b7238",
"transactionId": "TRX220132AM",
"status": "APPROVED",
"responseCode": "CODE_00",
"amount": 900,
"amountCurrency": "PLN",
"amountInUsDollar": 248,
"revaluationResult": {
"revaluationFundingAmount": 900,
"bigDecimalRevaluationFundingAmount": 9,
"fundingCurrency": "PLN",
"revaluationPaymentAmount": 900,
"bigDecimalRevaluationPaymentAmount": 9,
"paymentCurrency": "PLN",
"determineCurrencyRate": {
"from": "PLN",
"to": "PLN",
"currencyRate": "1"
}
},
"commissionAmount": 46,
"commissionCurrency": "PLN"
}Content-Type: application/json
X-MERCHANT-SECRET: 3cbd17f561150a1394cabbe2b6031fd83f3f3081abe28c32b7fed16f32aebc4a
X-MERCHANT-TIMESTAMP: 1614800720
{
"orderId": "42e8a03a-eb2e-4208-b99b-ac2ad6308498",
"transactionId": "TRX220132AM",
"status": "DECLINED",
"responseCode": "CODE_05",
"errorMessage": "FUNDING_TRANSACTION_DECLINED:CODE_05",
"amount": 900,
"amountCurrency": "PLN",
"amountInUsDollar": 248,
"revaluationResult": {
"revaluationFundingAmount": 900,
"bigDecimalRevaluationFundingAmount": 9,
"fundingCurrency": "PLN",
"revaluationPaymentAmount": 900,
"bigDecimalRevaluationPaymentAmount": 9,
"paymentCurrency": "PLN",
"determineCurrencyRate": {
"from": "PLN",
"to": "PLN",
"currencyRate": "1"
}
},
"commissionAmount": 46,
"commissionCurrency": "PLN",
"merchantAdviceCode": "03 - Do not try again"
}Content-Type: application/json
X-MERCHANT-SECRET: 3cbd17f561150a1394cabbe2b6031fd83f3f3081abe28c32b7fed16f32aebc4a
X-MERCHANT-TIMESTAMP: 1614800720
{
"orderId": "1b498361-f8db-406e-943b-ca2b12b7aa38",
"transactionId": "TRX220132AM",
"status": "REVERSED",
"responseCode": "CODE_00",
"amount": 1000,
"amountCurrency": "PLN",
"amountInUsDollar": 273,
"revaluationResult": {
"revaluationFundingAmount": 1000,
"bigDecimalRevaluationFundingAmount": 10,
"fundingCurrency": "PLN",
"revaluationPaymentAmount": 262,
"bigDecimalRevaluationPaymentAmount": 2.62,
"paymentCurrency": "USD",
"determineCurrencyRate": {
"from": "PLN",
"to": "USD",
"currencyRate": "0.2616157"
}
},
"commissionAmount": 1,
"commissionCurrency": "PLN"
}| Path | Type | Rule | Description |
|---|---|---|---|
X-MERCHANT-SECRET |
String |
Always present |
SHA256 Hash string composed from secret token and orderId placed in request body of this webhook |
X-MERCHANT-TIMESTAMP |
Numeric string |
Always present |
Timestamp of server response in UNIX format for instance: 1614023731 |
| Path | Type | Rule | Description |
|---|---|---|---|
orderId |
String/UUID |
Always present |
Unique identifier of transaction. You can fetch details of transaction by this parameter. |
transactionId |
String |
Optional |
The transactionId field is used for the Merchant to send its own internal transaction identifier. This field is returned in the response from the Check status method and sent by the Webhooks method. |
status |
String |
Always present |
Internal transaction status in Fenige system. |
responseCode |
String |
Optional |
Mastercard/Visa ISO response code. |
errorMessage |
String |
Optional |
Optional error message content. |
amount |
Number |
Always present |
Amount sent on Fenige api. |
amountCurrency |
String |
Always present |
Currency code sent on Fenige api. |
amountInUsDollar |
Long |
Always present |
Transaction amount in USD currency in pennies. |
revaluationResult.revaluationFundingAmount |
Number |
Optional |
Revaluation funding amount expressed as an Integer / Long. |
revaluationResult.bigDecimalRevaluationFundingAmount |
Number |
Optional |
Revaluation funding amount expressed as floating point number. |
revaluationResult.fundingCurrency |
String |
Optional |
Funding currency code. |
revaluationResult.revaluationPaymentAmount |
Number |
Optional |
Revaluation payment amount expressed as an Integer / Long. |
revaluationResult.bigDecimalRevaluationPaymentAmount |
Number |
Optional |
Revaluation payment amount expressed as floating point number. |
revaluationResult.paymentCurrency |
String |
Optional |
Payment currency code. |
revaluationResult.determineCurrencyRate.from |
String |
Optional |
The source currency of the conversion. |
revaluationResult.determineCurrencyRate.to |
String |
Optional |
The destination currency of the conversion. |
revaluationResult.determineCurrencyRate.currencyRate |
String |
Optional |
Conversion currency rate. |
commissionAmount |
Number |
Optional |
Commission amount expressed as an Integer / Long. |
commissionCurrency |
String |
Optional |
Commission currency code. |
merchantAdviceCode |
String |
Optional |
Information about the reasons for declined transactions and actions that merchants can take. Occurs only for mastercard and for declined transactions if Mastercard returns this information |
5. 3DS 2.X verification methods
The methods described in this section provide the ability to execute 3DS 2.X process. You can use the data received from authentication method to perform transactions with 3DS 2.X.
|
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:
|
5.1. Pre Authentication
Method to initiate 3ds authentication.
If the card is in 3ds 2.X, you can proceed to the first stage of authentication. If 'threeDSMethodURL' is returned, make a hidden iframe and post form with field name 'threeDSMethodData' on address from 'threeDSMethodURL'. Insert 'threeDSMethodData' from response to form. You should receive a response on your endpoint 'methodNotificationUrl' with 'threeDSMethodData' too. Measure the response time, the time and response are required at the 'Authentication' method, based on the response time, set the field 'methodCompletionIndicator'. 'threeDSMethodData ' is Base64 encoded string json with fields 'threeDSMethodNotificationURL' and 'threeDSServerTransID'. The range of card BINs that support 3DS 2.X for Mastercard is: 500000-549999. Use the following BINs below to generate cards for testing: - 5375912476960515 - 5117962099480048 - 5117963095204135 - 5218572540397762 - 5375913862726080 The range of card BINs that support 3DS 2.X for Visa is: 400000-449999. Use the following BINs below to generate cards for testing: - 4005520000000129 - 4164978855760477 - 4341500505113562 - 4280596505234682
*API-TOKEN is required for method: DATACORE when the cardId field is sent.
5.1.1. Request
POST /client/3ds/preAuthentication HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 96
Host: java-staging.fenige.pl:8181
{
"cardNumber" : "5117964247989169",
"methodNotificationUrl" : "methodNotificationUrl.com"
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
cardNumber |
String |
Required |
@NotNull |
Card number to 3DS 2.X pre authentication |
methodNotificationUrl |
String |
Required |
@NotNull |
This field specifies the URL to which the ACS will post threeDSMethodData when the hidden iframe post form from browse |
POST /client/3ds/preAuthentication HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 78
Host: java-staging.fenige.pl:8181
{
"cardId" : 1732,
"methodNotificationUrl" : "methodNotificationUrl.com"
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
cardId |
Number |
Required |
@Must not be null, @Numeric |
DataCenter card id. Required to obtain card information data from DataCenter such as (cardNumber, expiryDate) |
methodNotificationUrl |
String |
Required |
@NotNull |
This field specifies the URL to which the ACS will post threeDSMethodData when the hidden iframe post form from browse |
5.1.2. Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 462
{
"cardAuthenticationId" : "9fceebdf-99e2-4edd-9e92-f1bcb097d846",
"threeDSMethodData" : "eyJ0aHJlZURTTWV0aG9kTm90aWZpY2F0aW9uVVJMIjoiaHR0cHM6Ly93ZWJob29rLnNpdGUvZDMyZTlkZTgtMGFiOC00ODZjLWJjNzEtMGU2Mzg2MmY4MDNhM2I1YTkzZTUtMjI1Ni00NGQ0LTg2YjItNWFkM2FhMDEyYTJhIiwidGhyZWVEU1NlcnZlclRyYW5zSUQiOiIxNjNiZWMzOC1kOTM1LTQ0MGItYWYwYy01OWM3NDI3OTk2MGMifQ",
"threeDSMethodURL" : "https:/acs.com",
"protocolVersionStart" : "2.1.0",
"protocolVersionEnd" : "2.2.0"
}| Path | Type | Description |
|---|---|---|
|
|
Unique identifier for 3ds verification |
|
|
Encoded data used for request to ACS |
|
|
ACS endpoint for hidden request. If endpoint is not present then request is not required |
|
|
Protocol version start range |
|
|
Protocol version end range |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 421
{
"cardAuthenticationId" : "9b3f35c4-d95e-4289-be82-78d08a34f1e6",
"threeDSMethodData" : "eyJ0aHJlZURTTWV0aG9kTm90aWZpY2F0aW9uVVJMIjoiaHR0cHM6Ly93ZWJob29rLnNpdGUvZDMyZTlkZTgtMGFiOC00ODZjLWJjNzEtMGU2Mzg2MmY4MDNhM2I1YTkzZTUtMjI1Ni00NGQ0LTg2YjItNWFkM2FhMDEyYTJhIiwidGhyZWVEU1NlcnZlclRyYW5zSUQiOiIxNjNiZWMzOC1kOTM1LTQ0MGItYWYwYy01OWM3NDI3OTk2MGMifQ",
"protocolVersionStart" : "2.1.0",
"protocolVersionEnd" : "2.2.0"
}| Path | Type | Description |
|---|---|---|
|
|
Unique identifier for 3ds verification |
|
|
Encoded data used for request to ACS |
|
|
Protocol version start range |
|
|
Protocol version end range |
HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
"timestamp": "2021-12-22T12:39:53.168+0000",
"status": 401,
"error": "Unauthorized",
"message": "Username or password is not correct",
"path": "/client/3ds/preAuthentication"
}| Path | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: 130
{
"status" : "ERROR_3DS_2_X_CARD_NUMBER_NOT_ENROLLED",
"error" : {
"message" : "Card number not Enrolled in 3DS v2."
}
}| Path | Type | Description |
|---|---|---|
|
|
Api status |
|
|
Api status description |
5.2. Authentication
Method initialize authentication process by sending required transaction data. Method can return final data like cavv, transactionXId, eci or challenge flow (shown in the diagram).
After challenge end your app get notification on 'notificationUrl'. This is a POST request with "cres" and "threeDSSessionData". "threeDSSessionData" is a encoded in base64 "cardAuthenticationId". You must use it in 'Authentication Details' method to get authentication value cavv, transactionXId and eci. 'cres' is Base64 encoded string json with fields: 'threeDSServerTransID', 'acsTransID', 'challengeCompletionInd', 'messageVersion', 'transStatus'. 'threeDSServerTransID' - is same like in 'threeDSMethodData'. 'transStatus' - is same like 'transactionStatus' in response from 'Authentication' method.
In the test environment, you have the option of calling different transactionStatus, depending on the purchaseAmount field. Eg.
(1, 1000) - Y,
(1001, 2000) - A,
(2001, 3000) - C,
(3001, 4000) - N,
(4001, 5000) - U,
(5001, 6000) - I,
(6001, 7000) - status: MPI_2_INTERNAL_ERROR
(7001, 8000) - status: MPI_2_X_PROTOCOL_VERSION_IS_NOT_SUPPORTED
*API-TOKEN is required for method: DATACORE when the cardId field is sent.
5.2.1. Request
POST /client/3ds/authentication HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 1586
Host: java-staging.fenige.pl:8181
{
"cardAuthenticationId" : "2f786a02-e118-426f-964b-7aade42fb5d9",
"threeDSMethodData" : "eyJ0aHJlZURTTWV0aG9kTm90aWZpY2F0aW9uVVJMIjoiSFRUUDQwYjgyNDQ3LTE0ODUtNDUwZi04ZGYxLTdhNGQwYmRiMWMzYiIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiNDE1MDQzY2UtYTNhMC00ODBjLTk0YTYtNzk2NGEzYTcxNWI2In0",
"methodCompletionIndicator" : "Y",
"cardNumber" : "5117964247989169",
"cardExpirationDate" : "12/22",
"cardholderName" : "John Doe",
"purchaseAmount" : "123",
"purchaseCurrency" : "PLN",
"challengeWindowSize" : "FULL_SCREEN",
"browserAcceptHeader" : "Accept: application/json",
"browserLanguage" : "PL",
"browserScreenHeight" : "1500",
"browserScreenWidth" : "1500",
"browserTimeZone" : "60",
"browserUserAgent" : "Mozilla/5.0",
"browserScreenColorDepth" : "24",
"cardholderEmail" : "john.doe@example.com",
"cardholderHomePhone" : "1-1234567899",
"cardholderMobilePhone" : "1-1234567899",
"cardholderWorkPhone" : "1-1234567899",
"browserIPAddress" : "77.55.135.220",
"browserJavaEnabledVal" : "ENABLED",
"browserJavaScriptEnabled" : "ENABLED",
"notificationUrl" : "notification-url.com",
"requestorChallengeInd" : "CHALLENGE_REQUESTED_MANDATE",
"authenticationType" : "PAYMENT",
"protocolVersion" : "2.2.0",
"cardholderBillingAddressCountry" : "US",
"cardholderBillingAddressState" : "CA",
"cardholderBillingAddressCity" : "Los Angeles",
"cardholderBillingAddressLine1" : "4101 Supreme ct",
"cardholderBillingAddressLine2" : "Chestnut Ave",
"cardholderBillingAddressLine3" : "W 225TH ST",
"cardholderBillingAddressPostalCode" : "90032-2537"
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
cardAuthenticationId |
String |
Required |
@Must not be empty |
Unique identifier for 3ds verification from preAuthentication request. |
cardNumber |
String |
Required |
Card number length must be between 12 and 19, @Luhn, @Must not be blank, @Must not be null or card id must be present |
Card number. |
cardExpirationDate |
String |
Required |
@Length must be 5, @Must not be null or card id must be present |
Expiration date of card mm/yy. |
cardholderName |
String |
Required |
@Length must be between 2 and 45 inclusive, @Must not be empty |
This property contains the name of the cardholder. Name of the Cardholder. Must be ASCII characters. This is required to be set unless market or regional mandates restricts sending this information. |
purchaseAmount |
String |
Required |
@Must match the regular expression |
This field contains the purchase amount to be authorized. The transaction amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated PurchaseExponent. This field may not contain a negative number. |
purchaseCurrency |
String |
Required |
@Must not be null |
Currency for transaction (in accordance with 3-digit ISO-4217), example: USD. |
threeDSMethodData |
String |
Required |
@Must not be empty |
Response data from a hidden form from the Pre Authentication. If threeDSMethodURL is empty set encodedData. |
methodCompletionIndicator |
String |
Required |
@Must not be null |
Y if response from hidden form from Pre Authentication is under 10s, N if response from hidden form from Pre Authentication is over 10s, U if threeDSMethodURL is empty. |
protocolVersion |
String |
Required |
@Must not be null |
This field indicates the protocol version. Now there are two versions: 2.1.0 and 2.2.0. It is recommended to use 2.2.0 if the card supports it. You will get it from the Pre Authentication method. Some configurations are only available for 2.2.0. |
notificationUrl |
String |
Required |
@Must not be null |
This property specifies the URL to which the final challenge response is POSTed. |
authenticationType |
String |
Optional |
If null then value equals PAYMENT |
Authentication Type configuration prepared for specific type. Possible values are: Non payment authentication - Identity verification and account confirmation: ADD_CARD VERIFY_CARDHOLDER Payment authentication - Cardholder authentication during an transaction: PAYMENT |
requestorChallengeInd |
String |
Required |
@Must not be null |
Indicates whether a challenge is requested for this transaction. Possible values are: NO_PREFERENCE, NO_CHALLENGE_REQUESTED, CHALLENGE_REQUESTED_3DS_REQUESTOR_PREFERENCE, CHALLENGE_REQUESTED_MANDATE. |
challengeWindowSize |
String |
Optional |
Optional |
This field indicates the dimensions of the challenge window that has been displayed to the cardholder. The ACS shall reply with content that is formatted to appropriately render in this window to provide the best possible user experience. Preconfigured sizes are width x height in pixels of the window displayed in the cardholder browser. Possible values are:S_250X400 S_390X400 S_500X600 S_600X400 FULL_SCREEN This value is included in the Challenge Request Message (CReq) |
browserAcceptHeader |
String |
Required |
@Must not be null, Max length: 2048 |
This field contains the exact content of the HTTP accept header as sent to the merchant from the cardholder’s user agent. This field is required only if the cardholder’s user agent supplied a value. e.g Accept: application/json. |
browserLanguage |
String |
Required |
@Must not be null, Min length: 1, Max length: 8 |
This field contains the cardholder’s browser language as defined in IETF BCP 47. |
browserScreenHeight |
String |
Required |
@Must not be null, Regexp: ^[0-9]{1,6}$ |
This field contains the total height of the cardholder’s screen in pixels. |
browserScreenWidth |
String |
Required |
@Must not be null, Regexp: ^[0-9]{1,6}$ |
This field contains the total width of the cardholder’s screen in pixels. |
browserTimeZone |
String |
Required |
@Must not be null, Regexp: ^[+-]?[0-9]{1,4}$ |
This field contains the difference between UTC time and the cardholder’s browser local time in minutes. |
browserUserAgent |
String |
Required |
@Must not be null, Max length: 2048 |
This field contains the exact content of the HTTP User-Agent header. |
browserJavaEnabledVal |
String |
Required |
@Must not be null, |
This field contains a value representing the ability of the cardholder’s browser to execute Java. Enumerated values: NOT_PRESENT, ENABLED, DISABLED. Required if browserJavascriptEnabled is true |
cardholderEmail |
String |
Optional |
@Length must be between 0 and 254 inclusive |
This field contains the cardholder email address. |
cardholderHomePhone |
String |
Optional |
Must match regex \d{1,3}-[1-9]\d{1,14}$ |
This field contains the home phone number provided by the cardholder. Phone numbers must be specified in the following format: CountryCode-Subscriber (e.g. 1-1234567899) |
cardholderMobilePhone |
String |
Optional |
Must match regex \d{1,3}-[1-9]\d{1,14}$ |
This field contains the mobile phone number provided by the cardholder. Phone numbers must be specified in the following format: CountryCode-Subscriber (e.g. 1-1234567899) |
cardholderWorkPhone |
String |
Optional |
Must match regex \d{1,3}-[1-9]\d{1,14}$ |
This field contains the work phone number provided by the cardholder. Phone numbers must be specified in the following format: CountryCode-Subscriber (e.g. 1-1234567899) |
browserIPAddress |
String |
Required |
@Must not be null |
This field contains the IP address of the cardholder’s browser as returned by the HTTP headers. |
browserJavaScriptEnabled |
String |
Required |
@Must not be null |
This field contains a value representing the ability of the cardholder’s browser to execute JavaScript. Enumerated values: ENABLED, DISABLED. |
browserScreenColorDepth |
String |
Required |
@Must not be null |
This field contains a value representing the bit depth of the color palette, in bits per pixel, for displaying images. Obtained from Cardholder browser using the screen.colorDepth property. Values accepted: 1 = 1 bit, 4 = 4 bits, 8 = 8 bits, 15 = 15 bits, 16 = 16 bits, 24 = 24 bits, 32 = 32 bits, 48 = 48 bits |
cardholderBillingAddressCountry |
String |
Optional |
@Max length: 3 Required if Cardholder Billing Address State is present. |
The country of the Cardholder billing address associated with the card used for this purchase. Shall be the ISO 3166-1 numeric three-digit country code, other than exceptions listed in Table A.5. |
cardholderBillingAddressState |
String |
Optional |
@Max length: 3 |
Country subdivision code defined in ISO 3166-2. For example, using the ISO entry US-CA (California, United States), the correct value for this field = CA. Note that the country and hyphen are not included in this value. |
cardholderBillingAddressCity |
String |
Optional |
@Max length: 50 |
The city of the Cardholder billing address associated with the card used for this purchase. |
cardholderBillingAddressLine1 |
String |
Optional |
@Max length: 50 |
First line of the street address or equivalent local portion of the Cardholder billing address associated with the card used for this purchase. |
cardholderBillingAddressLine2 |
String |
Optional |
@Max length: 50 |
Second line of the street address or equivalent local portion of the Cardholder billing address associated with the card used for this purchase. |
cardholderBillingAddressLine3 |
String |
Optional |
@Max length: 50 |
Third line of the street address or equivalent local portion of the Cardholder billing address associated with the card used for this purchase. |
cardholderBillingAddressPostalCode |
String |
Optional |
@Max length: 16 |
ZIP or other postal code of the Cardholder billing address associated with the card used for this purchase. |
POST /client/3ds/authentication HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 1498
Host: java-staging.fenige.pl:8181
{
"cardAuthenticationId" : "b135499a-e536-4db8-b07b-ad6fe7ea02a3",
"threeDSMethodData" : "eyJ0aHJlZURTTWV0aG9kTm90aWZpY2F0aW9uVVJMIjoiSFRUUDQwYjgyNDQ3LTE0ODUtNDUwZi04ZGYxLTdhNGQwYmRiMWMzYiIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiNDE1MDQzY2UtYTNhMC00ODBjLTk0YTYtNzk2NGEzYTcxNWI2In0",
"methodCompletionIndicator" : "Y",
"cardId" : 1732,
"cardholderName" : "John Doe",
"purchaseAmount" : "123",
"purchaseCurrency" : "PLN",
"challengeWindowSize" : "FULL_SCREEN",
"browserAcceptHeader" : "Accept: application/json",
"browserLanguage" : "PL",
"browserScreenHeight" : "1500",
"browserScreenWidth" : "1500",
"browserTimeZone" : "60",
"browserUserAgent" : "Mozilla/5.0",
"browserScreenColorDepth" : "24",
"cardholderEmail" : "john.doe@example.com",
"cardholderHomePhone" : "1-1234567899",
"cardholderMobilePhone" : "1-1234567899",
"cardholderWorkPhone" : "1-1234567899",
"browserIPAddress" : "77.55.135.220",
"browserJavaEnabledVal" : "ENABLED",
"browserJavaScriptEnabled" : "ENABLED",
"notificationUrl" : "notification-url.com",
"requestorChallengeInd" : "CHALLENGE_REQUESTED_MANDATE",
"protocolVersion" : "2.2.0",
"cardholderBillingAddressCountry" : "US",
"cardholderBillingAddressState" : "CA",
"cardholderBillingAddressCity" : "Los Angeles",
"cardholderBillingAddressLine1" : "4101 Supreme ct",
"cardholderBillingAddressLine2" : "Chestnut Ave",
"cardholderBillingAddressLine3" : "W 225TH ST",
"cardholderBillingAddressPostalCode" : "90032-2537"
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
cardAuthenticationId |
String |
Required |
@Must not be empty |
Unique identifier for 3ds verification from preAuthentication request. |
cardId |
Number |
Required |
@Must not be null, @Numeric |
DataCenter card id. Required to obtain card information data from DataCenter such as (cardNumber, expiryDate) |
cardholderName |
String |
Required |
@Length must be between 2 and 45 inclusive, @Must not be empty |
This property contains the name of the cardholder. Name of the Cardholder. Must be ASCII characters. This is required to be set unless market or regional mandates restricts sending this information. |
purchaseAmount |
String |
Required |
@Must match the regular expression |
This field contains the purchase amount to be authorized. The transaction amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated PurchaseExponent. This field may not contain a negative number. |
purchaseCurrency |
String |
Required |
@Must not be null |
Currency for transaction (in accordance with 3-digit ISO-4217), example: USD. |
threeDSMethodData |
String |
Required |
@Must not be empty |
Response data from a hidden form from the Pre Authentication. If threeDSMethodURL is empty set encodedData. |
methodCompletionIndicator |
String |
Required |
@Must not be null |
Y if response from hidden form from Pre Authentication is under 10s, N if response from hidden form from Pre Authentication is over 10s, U if threeDSMethodURL is empty. |
protocolVersion |
String |
Required |
@Must not be null |
This field indicates the protocol version. Now there are two versions: 2.1.0 and 2.2.0. It is recommended to use 2.2.0 if the card supports it. You will get it from the Pre Authentication method. Some configurations are only available for 2.2.0. |
notificationUrl |
String |
Required |
@Must not be null |
This property specifies the URL to which the final challenge response is POSTed. |
requestorChallengeInd |
String |
Required |
@Must not be null |
Indicates whether a challenge is requested for this transaction. Possible values are: NO_PREFERENCE, NO_CHALLENGE_REQUESTED, CHALLENGE_REQUESTED_3DS_REQUESTOR_PREFERENCE, CHALLENGE_REQUESTED_MANDATE. |
challengeWindowSize |
String |
Optional |
Optional |
This field indicates the dimensions of the challenge window that has been displayed to the cardholder. The ACS shall reply with content that is formatted to appropriately render in this window to provide the best possible user experience. Preconfigured sizes are width x height in pixels of the window displayed in the cardholder browser. Possible values are:S_250X400 S_390X400 S_500X600 S_600X400 FULL_SCREEN This value is included in the Challenge Request Message (CReq) |
browserAcceptHeader |
String |
Required |
@Must not be null, Max length: 2048 |
This field contains the exact content of the HTTP accept header as sent to the merchant from the cardholder’s user agent. This field is required only if the cardholder’s user agent supplied a value. e.g Accept: application/json. |
browserLanguage |
String |
Required |
@Must not be null, Min length: 1, Max length: 8 |
This field contains the cardholder’s browser language as defined in IETF BCP 47. |
browserScreenHeight |
String |
Required |
@Must not be null, Regexp: ^[0-9]{1,6}$, Min length: 1, Max length: 6 |
This field contains the total height of the cardholder’s screen in pixels. |
browserScreenWidth |
String |
Required |
@Must not be null, Regexp: ^[0-9]{1,6}$, Min length: 1, Max length: 6 |
This field contains the total width of the cardholder’s screen in pixels. |
browserTimeZone |
String |
Required |
@Must not be null, Regexp: ^[+-]?[0-9]{1,4}$, Min length: 1, Max length: 5 |
This field contains the difference between UTC time and the cardholder’s browser local time in minutes. |
browserUserAgent |
String |
Required |
@Must not be null, Max length: 2048 |
This field contains the exact content of the HTTP User-Agent header. |
browserJavaEnabledVal |
String |
Required |
@Must not be null |
This field contains a value representing the ability of the cardholder’s browser to execute Java. Enumerated values: NOT_PRESENT, ENABLED, DISABLED. Required if browserJavascriptEnabled is true |
cardholderEmail |
String |
Optional, Max length: 256 |
@Length must be between 0 and 254 inclusive |
This field contains the cardholder email address. |
cardholderHomePhone |
String |
Optional |
Must match regex \d{1,3}-[1-9]\d{1,14}$ |
This field contains the home phone number provided by the cardholder. Phone numbers must be specified in the following format: CountryCode-Subscriber (e.g. 1-1234567899) |
cardholderMobilePhone |
String |
Optional |
Must match regex \d{1,3}-[1-9]\d{1,14}$ |
This field contains the mobile phone number provided by the cardholder. Phone numbers must be specified in the following format: CountryCode-Subscriber (e.g. 1-1234567899) |
cardholderWorkPhone |
String |
Optional |
Must match regex \d{1,3}-[1-9]\d{1,14}$ |
This field contains the work phone number provided by the cardholder. Phone numbers must be specified in the following format: CountryCode-Subscriber (e.g. 1-1234567899) |
browserIPAddress |
String |
Required |
@Must not be null, Max length: 45 |
This field contains the IP address of the cardholder’s browser as returned by the HTTP headers. |
browserJavaScriptEnabled |
String |
Required |
@Must not be null |
This field contains a value representing the ability of the cardholder’s browser to execute JavaScript. Enumerated values: ENABLED, DISABLED. |
browserScreenColorDepth |
String |
Required |
@Must not be null |
This field contains a value representing the bit depth of the color palette, in bits per pixel, for displaying images. Obtained from Cardholder browser using the screen.colorDepth property. Values accepted: 1 = 1 bit, 4 = 4 bits, 8 = 8 bits, 15 = 15 bits, 16 = 16 bits, 24 = 24 bits, 32 = 32 bits, 48 = 48 bits |
cardholderBillingAddressCountry |
String |
Optional |
@Max length: 3 Required if Cardholder Billing Address State is present. |
The country of the Cardholder billing address associated with the card used for this purchase. Shall be the ISO 3166-1 numeric three-digit country code, other than exceptions listed in Table A.5. |
cardholderBillingAddressState |
String |
Optional |
@Max length: 3 |
Country subdivision code defined in ISO 3166-2. For example, using the ISO entry US-CA (California, United States), the correct value for this field = CA. Note that the country and hyphen are not included in this value. |
cardholderBillingAddressCity |
String |
Optional |
@Max length: 50 |
The city of the Cardholder billing address associated with the card used for this purchase. |
cardholderBillingAddressLine1 |
String |
Optional |
@Max length: 50 |
First line of the street address or equivalent local portion of the Cardholder billing address associated with the card used for this purchase. |
cardholderBillingAddressLine2 |
String |
Optional |
@Max length: 50 |
Second line of the street address or equivalent local portion of the Cardholder billing address associated with the card used for this purchase. |
cardholderBillingAddressLine3 |
String |
Optional |
@Max length: 50 |
Third line of the street address or equivalent local portion of the Cardholder billing address associated with the card used for this purchase. |
cardholderBillingAddressPostalCode |
String |
Optional |
@Max length: 16 |
ZIP or other postal code of the Cardholder billing address associated with the card used for this purchase. |
5.2.2. Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 151
{
"transactionStatus" : "A",
"transactionXId" : "e5474f48-cda7-48d9-aa14-7e1740376d17",
"cavv" : "B5gQCElHgQAAAAAKmFNEdQAAAAA=",
"eci" : "06"
}| Path | Type | Description |
|---|---|---|
|
|
Indicates whether a transaction qualifies as an authenticated transaction or account verification. Possible values are: Y Authentication/account verification successful. N Not authenticated/account not verified; transaction denied. U Authentication/account verification could not be performed; technical or other problem as indicated in ARes or RReq. A Attempts processing performed; not authenticated/verified, but a proof of attempted authentication/verification is provided. C Challenge required; additional authentication is required using the CReq/CRes. R Authentication/account verification rejected; issuer is rejecting authentication/verification and request that authorization not be attempted. D Challenge required; decoupled authentication confirmed. I Informational only; 3DS Requestor challenge preference acknowledged. Note: The CRes message can contain only a value of Y or N. Values of D and I are only applicable for 3DS version 2.2.0. |
|
|
Server transaction Id generated by DS |
|
|
This property is determined by the Access Control Server (ACS), and is filled after the call to SendAuthRequest (for a frictionless flow), or when the Results Request Message (RReq) is parsed using CheckResponse (for a challenge flow). This property will be valid if the TransactionStatus is "Y" or "A". The value may be used to provide proof of authentication. |
|
|
This property is determined by the Access Control Server (ACS), and is filled after the call to SendAuthRequest (for a frictionless flow), or when the Results Request Message (RReq) is parsed using CheckResponse (for a challenge flow). This property contains the two digit Electronic Commerce Indicator (ECI) value, which is to be submitted in a credit card authorization message. This value indicates to the processor that the customer data in the authorization message has been authenticated. The data contained within this property is only valid if the TransactionStatus is "Y" or "A". |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 648
{
"transactionStatus" : "C",
"acsurl" : "acsurl.com",
"creq" : "c29tZSBjcmVx",
"challengeHtmlFormBase64" : "PGh0bWw+PFNDUklQVCBMQU5HVUFHRT0iSmF2YXNjcmlwdCI+ZnVuY3Rpb24gT25Mb2FkRXZlbnQoKXsgZG9jdW1lbnQuZG93bmxvYWRGb3JtLnN1Ym1pdCgpOyB9PC9TQ1JJUFQ+PGJvZHkgT25Mb2FkPSJPbkxvYWRFdmVudCgpOyI+PGZvcm0gbmFtZT0iZG93bmxvYWRGb3JtIiBhY3Rpb249Imh0dHBzOi8vYWNzdGVzdC5jb20iIG1ldGhvZD0iUE9TVCI+PElOUFVUIHR5cGU9ImhpZGRlbiIgbmFtZT0iY3JlcSIgdmFsdWU9ImNyZXEiPjxJTlBVVCB0eXBlPSJoaWRkZW4iIG5hbWU9InRocmVlRFNTZXNzaW9uRGF0YSIgdmFsdWU9InNvbWVFbmNvZGVkRGF0ZSI+PC9mb3JtPjwvYm9keT48L2h0bWw+",
"threeDSSessionData" : "ZGY0NDJhODQtOGJkZS00MmQ3LWExMTUtMzUyNjNlZGY1MGFk"
}| Path | Type | Description |
|---|---|---|
|
|
Indicates whether a transaction qualifies as an authenticated transaction or account verification. Possible values are: Y Authentication/account verification successful. N Not authenticated/account not verified; transaction denied. U Authentication/account verification could not be performed; technical or other problem as indicated in ARes or RReq. A Attempts processing performed; not authenticated/verified, but a proof of attempted authentication/verification is provided. C Challenge required; additional authentication is required using the CReq/CRes. R Authentication/account verification rejected; issuer is rejecting authentication/verification and request that authorization not be attempted. D Challenge required; decoupled authentication confirmed. I Informational only; 3DS Requestor challenge preference acknowledged. Note: The CRes message can contain only a value of Y or N. Values of D and I are only applicable for 3DS version 2.2.0. |
|
|
ACS Url - if challenge is required, data for building a form such as challengeHtmlFormBase64 |
|
|
creq - if challenge is required, data for building a form such as challengeHtmlFormBase64 |
|
|
creq - if challenge is required, data for building a form such as challengeHtmlFormBase64 |
|
|
This field is a BASE64 encrypted html source file containing the challenge 3-D Secure frame |
HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
"timestamp": "2021-12-22T12:39:53.168+0000",
"status": 401,
"error": "Unauthorized",
"message": "Username or password is not correct",
"path": "/client/3ds/authentication"
}| Path | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
5.3. Authentication Details
Method return details for authentication.
Success 3-D Secure Authentication. MPI return status: Y (Full Authentication) - The customer was successfully authenticated. Attempt 3-D Secure Authentication. MPI return status: A (Successful Attempted Authentication) - Authentication was not available, but functionality was available to generate a proof of authentication attempt. Challenge required C Cardholder challenge required. D Challenge required; decoupled authentication confirmed. Information only I Informational only; 3DS Requestor challenge preference acknowledged. Error 3-D Secure Authentication results. MPI return one of statuses: N (Authentication Failed) - The customer failed authentication, and the transaction is denied. The cardholder’s password (or other authentication information) failed validation, thus, the issuer is not able to authenticate the cardholder. U (Unable to Complete Authentication) - Authentication could not be performed due to technical or other problems. R Not authenticated because the issuer is rejecting authentication.
5.3.1. Request
GET /client/3ds/details/ad24533b-56fc-4be5-8d2f-604954a328e0 HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181| Parameter | Description |
|---|---|
|
Unique identifier for 3ds verification |
5.3.2. Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 340
{
"cardAuthenticationId" : "a0bb6777-33f0-4dec-a767-b281928a0b9c",
"provider" : "MASTERCARD",
"transactionStatus" : "Y",
"cardAuthenticationStatus" : "AUTHENTICATION_FINISHED",
"transactionXId" : "16dc968d-abee-4dac-a6ed-8568b6ae25ba",
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag",
"eci" : "01",
"transactionStatusReason" : "04"
}| Path | Type | Description |
|---|---|---|
|
|
Unique identifier for 3ds verification |
|
|
Card’s provider |