1. Changelog
| Version | Date | Description |
|---|---|---|
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 + 3.1. Send money + 3.2. Send money 3DS 2.X + 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 + 3.2 Send money 3DS 2.X |
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 with 3ds has been registered for processing. Check status in a while |
|
The request was malformed. The response body will include an error providing further information |
|
The requested resource did not exist |
|
Message occur when an unexpected condition was encountered |
2.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) |
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, PLAIN-PLAIN USA/CAN, DATACORE-PLAIN, DATACORE-DATACORE, DATACORE-PHONE
Is apply for: CASH-PLAIN, CASH-PHONE
3.1. Send money
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, 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.
|
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=
Host: java-staging.fenige.pl:8181
Content-Length: 877
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"requestId" : "10c351d5-f49e-4b46-8a58-6df53c854b1f",
"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-08-20",
"cardNumber" : "5117964247989169",
"expirationDate" : "03/23",
"personalId" : "AGC688910",
"currency" : "PLN"
},
"receiver" : {
"type" : "PLAIN",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-08-20",
"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=
Host: java-staging.fenige.pl:8181
Content-Length: 920
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"requestId" : "3834c41a-5f6c-460b-9029-12881486f860",
"transactionId" : "TRX220132AM",
"sender" : {
"type" : "PLAIN",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Gates Court",
"houseNumber" : "82",
"city" : "Brooklyn",
"postalCode" : "11211",
"flatNumber" : "2",
"email" : "senderdocs@fenige.pl",
"birthDate" : "2023-08-20",
"cardNumber" : "5448424719416233",
"expirationDate" : "03/23",
"personalId" : "AGC688910",
"country" : "US",
"province" : "NY",
"currency" : "USD"
},
"receiver" : {
"type" : "PLAIN",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-08-20",
"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=
Host: java-staging.fenige.pl:8181
Content-Length: 903
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"requestId" : "124672dc-563b-4e2a-9da9-f59de6037a3c",
"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-08-20",
"cardNumber" : "5117964247989169",
"expirationDate" : "03/23",
"personalId" : "AGC688910",
"currency" : "PLN"
},
"receiver" : {
"type" : "DATACORE",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "receiverEmail@fenige.pl",
"birthDate" : "2023-08-20",
"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=
Host: java-staging.fenige.pl:8181
Content-Length: 798
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"requestId" : "d8be35f8-662b-40b6-a0e6-7dbe90e61d7d",
"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-08-20",
"cardId" : 1234,
"currency" : "PLN"
},
"receiver" : {
"type" : "PLAIN",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-08-20",
"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=
Host: java-staging.fenige.pl:8181
Content-Length: 824
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"requestId" : "fabaed74-4cb0-4903-ae1e-cec1d2a10c1b",
"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-08-20",
"cardId" : 1234,
"currency" : "PLN"
},
"receiver" : {
"type" : "DATACORE",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "receiverEmail@fenige.pl",
"birthDate" : "2023-08-20",
"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=
Host: java-staging.fenige.pl:8181
Content-Length: 794
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"requestId" : "f3c51e8b-b806-4f56-aa20-7a1cd8e16042",
"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-08-20",
"cardId" : 1234,
"currency" : "PLN"
},
"receiver" : {
"type" : "PHONE",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-08-20",
"phoneNumber" : "48123777619",
"currency" : "PLN",
"countryOfResidence" : "PL"
}
}
POST /api/v2/client/send-money HTTP/1.1
Content-Type: application/vnd.sendmoney.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181
Content-Length: 676
{
"amount" : 1000,
"type" : "RECEIVER",
"requestId" : "81fe4ab8-e2cb-4817-9c10-dbd78c2c1d4c",
"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-08-20",
"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=
Host: java-staging.fenige.pl:8181
Content-Length: 699
{
"amount" : 1000,
"type" : "RECEIVER",
"requestId" : "592b6560-6076-453a-92c9-9ce05eba39aa",
"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" : "US",
"province" : "NY"
},
"receiver" : {
"type" : "PLAIN",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-08-20",
"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=
Host: java-staging.fenige.pl:8181
Content-Length: 672
{
"amount" : 1000,
"type" : "RECEIVER",
"requestId" : "5c8ffcc4-a2a3-4fd9-9995-6fa051efc9b8",
"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-08-20",
"phoneNumber" : "48123777619",
"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=
Host: java-staging.fenige.pl:8181
Content-Length: 695
{
"amount" : 1000,
"type" : "RECEIVER",
"requestId" : "d9be3654-8d27-4b0c-9215-ceab12fcbceb",
"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" : "US",
"province" : "NY"
},
"receiver" : {
"type" : "PHONE",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-08-20",
"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;charset=ISO-8859-1
Content-Length: 56
{
"orderId" : "bed72ef2-21e2-4bf0-ae62-6dab14edb8a5"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Unique transaction identifier |
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=ISO-8859-1
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 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.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 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-09-26T01:05:09.611",
"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 |
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-09-26T01:05:10.179",
"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 |
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. Send money 3DS 2.X
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.cavvAlgorithm |
String |
Optional |
@NotNull |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm. |
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=
Host: java-staging.fenige.pl:8181
Content-Length: 1053
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"authenticationStatus" : "Y",
"eci" : "01",
"transactionXId" : "e287c06b-3547-40cb-afbf-36ed6917777e"
},
"requestId" : "8a769255-55c6-46dc-ac91-46c762415b09",
"sender" : {
"type" : "PLAIN",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-08-20",
"cardNumber" : "5117964247989169",
"expirationDate" : "03/23",
"personalId" : "AGC688910",
"currency" : "PLN"
},
"receiver" : {
"type" : "PLAIN",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-08-20",
"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=
Host: java-staging.fenige.pl:8181
Content-Length: 1096
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"authenticationStatus" : "Y",
"eci" : "01",
"transactionXId" : "01e6f7f3-982e-43b2-9566-79eea3bd9819"
},
"requestId" : "7ffca38d-d7be-4b00-888e-0a22bfb2ecf3",
"sender" : {
"type" : "PLAIN",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Gates Court",
"houseNumber" : "82",
"city" : "Brooklyn",
"postalCode" : "11211",
"flatNumber" : "2",
"email" : "senderdocs@fenige.pl",
"birthDate" : "2023-08-20",
"cardNumber" : "5448424719416233",
"expirationDate" : "03/23",
"personalId" : "AGC688910",
"country" : "US",
"province" : "NY",
"currency" : "USD"
},
"receiver" : {
"type" : "PLAIN",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-08-20",
"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=
Host: java-staging.fenige.pl:8181
Content-Length: 1079
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"authenticationStatus" : "Y",
"eci" : "01",
"transactionXId" : "6a3ddb57-3ed3-4436-b6a1-fdca35319ccc"
},
"requestId" : "468981df-3a52-491d-bcca-98557e056cd5",
"sender" : {
"type" : "PLAIN",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-08-20",
"cardNumber" : "5117964247989169",
"expirationDate" : "03/23",
"personalId" : "AGC688910",
"currency" : "PLN"
},
"receiver" : {
"type" : "DATACORE",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "receiverEmail@fenige.pl",
"birthDate" : "2023-08-20",
"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=
Host: java-staging.fenige.pl:8181
Content-Length: 974
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"authenticationStatus" : "Y",
"eci" : "01",
"transactionXId" : "923c4a44-c696-4358-9e32-db6f2dfe8861"
},
"requestId" : "64249a40-54c5-4e74-a850-9da870b090bb",
"sender" : {
"type" : "DATACORE",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-08-20",
"cardId" : 1234,
"currency" : "PLN"
},
"receiver" : {
"type" : "PLAIN",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-08-20",
"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=
Host: java-staging.fenige.pl:8181
Content-Length: 1000
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"authenticationStatus" : "Y",
"eci" : "01",
"transactionXId" : "954d46db-7f7e-41f1-843a-4f254fe068b9"
},
"requestId" : "c013f40c-6783-46ca-9017-66d8ff159c90",
"sender" : {
"type" : "DATACORE",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-08-20",
"cardId" : 1234,
"currency" : "PLN"
},
"receiver" : {
"type" : "DATACORE",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "receiverEmail@fenige.pl",
"birthDate" : "2023-08-20",
"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=
Host: java-staging.fenige.pl:8181
Content-Length: 970
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"authenticationStatus" : "Y",
"eci" : "01",
"transactionXId" : "f48c0f23-dd52-4638-bcc3-07563153e4fc"
},
"requestId" : "8a6f4882-5f22-40aa-8969-571e0950de9c",
"sender" : {
"type" : "DATACORE",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-08-20",
"cardId" : 1234,
"currency" : "PLN"
},
"receiver" : {
"type" : "PHONE",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-08-20",
"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=
Host: java-staging.fenige.pl:8181
Content-Length: 1120
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"authenticationStatus" : "Y",
"eci" : "01",
"transactionXId" : "f38fa35e-0152-480b-9600-bb6942cb11e3"
},
"requestId" : "c268fba6-23f5-477e-bc5b-25ce295ae806",
"sender" : {
"type" : "PLAIN",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-08-20",
"cardNumber" : "5117964247989169",
"expirationDate" : "03/23",
"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=
Host: java-staging.fenige.pl:8181
Content-Length: 1163
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"authenticationStatus" : "Y",
"eci" : "01",
"transactionXId" : "69027901-eaab-4b3e-9a92-7ca46b5f565b"
},
"requestId" : "2989e83a-66f3-4432-b480-d65c74394b8d",
"sender" : {
"type" : "PLAIN",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Gates Court",
"houseNumber" : "82",
"city" : "Brooklyn",
"postalCode" : "11211",
"flatNumber" : "2",
"email" : "senderdocs@fenige.pl",
"birthDate" : "2023-08-20",
"cardNumber" : "5448424719416233",
"expirationDate" : "03/23",
"personalId" : "AGC688910",
"country" : "US",
"province" : "NY",
"currency" : "USD"
},
"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=
Host: java-staging.fenige.pl:8181
Content-Length: 1041
{
"amount" : 1000,
"cvc2" : "123",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "01",
"authenticationStatus" : "Y",
"eci" : "01",
"transactionXId" : "9d47f260-e9b4-4109-9f99-6c317538c617"
},
"requestId" : "28e2e923-9387-4857-8102-a4258bb418ec",
"sender" : {
"type" : "DATACORE",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-08-20",
"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;charset=ISO-8859-1
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": "termUrl",
"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;charset=ISO-8859-1
Content-Length: 56
{
"orderId" : "d2181f59-63a2-4f8e-8a9c-1f0005988aba"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Transaction order-id |
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=ISO-8859-1
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-09-26T01:05:09.136",
"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 |
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.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.
|
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. |
3.3.1. 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:81813.3.2. Response
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" : "6066efc4-21c0-4b4f-943e-8a1ac320dd87",
"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) |
|
|
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.4. 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. |
3.4.1. Request
GET /client/transactions/fae3ee90-6f88-4aa6-aff5-7d9f6a5645d3 HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:81813.4.2. Response
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 |
4. 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:
|
4.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. |
4.1.1. 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 |
4.1.2. Delayed Send Money Examples
4.1.3. Requests
POST /client/delayed/send-money HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Host: java-staging.fenige.pl:8181
Content-Length: 975
{
"amount" : 1000,
"cvc2" : "123",
"termUrl" : "https://termurl.pl",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "02",
"authenticationStatus" : "Y",
"eci" : "02",
"transactionXId" : "7cdfc72c-fbfa-4eb3-acc6-c3d48a99b03a"
},
"requestId" : "444f8236-23f6-4b6d-81d7-abec8eef5839",
"sender" : {
"type" : "DATACORE",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-08-20",
"cardId" : 1234,
"currency" : "PLN"
},
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-08-20",
"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. |
termUrl |
String |
Optional |
@NotEmpty |
Merchant URL to be redirected from Fenige after user login in the bank. This URL must accept order-id parameter, that tells which transaction is begin processed. The presence of this field in the HTTP request specifies that the transaction will be processed with 3DS 1.0. |
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.cavvAlgorithm |
String |
Optional |
@NotNull |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm. |
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. |
POST /client/delayed/send-money HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Host: java-staging.fenige.pl:8181
Content-Length: 981
{
"amount" : 1000,
"cvc2" : "123",
"termUrl" : "https://termurl.pl",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "02",
"authenticationStatus" : "Y",
"eci" : "02",
"transactionXId" : "6f147ff8-a3a0-42a1-9e99-24647c4142fa"
},
"requestId" : "b61579da-fb92-43f9-b5d9-6122d117c517",
"sender" : {
"type" : "DATACORE",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-08-20",
"cardId" : 1234,
"currency" : "PLN"
},
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "receiverEmail@fenige.pl",
"birthDate" : "2023-08-20",
"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. |
termUrl |
String |
Optional |
@NotEmpty |
Merchant URL to be redirected from Fenige after user login in the bank. This URL must accept order-id parameter, that tells which transaction is begin processed. The presence of this field in the HTTP request specifies that the transaction will be processed with 3DS 1.0. |
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.cavvAlgorithm |
String |
Optional |
@NotNull |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm. |
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. |
POST /client/delayed/send-money HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181
Content-Length: 1054
{
"amount" : 1000,
"cvc2" : "123",
"termUrl" : "https://termurl.pl",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "02",
"authenticationStatus" : "Y",
"eci" : "02",
"transactionXId" : "baebfb73-95f8-40ae-858e-e2e3ed5853dc"
},
"requestId" : "db2b888d-0e2d-44be-8130-aa5084164654",
"sender" : {
"type" : "PLAIN",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-08-20",
"cardNumber" : "5117964247989169",
"expirationDate" : "03/23",
"personalId" : "AGC688910",
"currency" : "PLN"
},
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"birthDate" : "2023-08-20",
"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. |
termUrl |
String |
Optional |
@NotEmpty |
Merchant URL to be redirected from Fenige after user login in the bank. This URL must accept order-id parameter, that tells which transaction is begin processed. The presence of this field in the HTTP request specifies that the transaction will be processed with 3DS 1.0. |
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.cavvAlgorithm |
String |
Optional |
@NotNull |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm. |
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. |
POST /client/delayed/send-money HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181
Content-Length: 1060
{
"amount" : 1000,
"cvc2" : "123",
"termUrl" : "https://termurl.pl",
"merchantUrl" : "https://fenige.pl/payments",
"addressIp" : "192.168.0.1",
"type" : "SENDER",
"outside3ds" : {
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag=",
"cavvAlgorithm" : "02",
"authenticationStatus" : "Y",
"eci" : "02",
"transactionXId" : "d49b11e4-9d6f-4ed6-af81-24cbfda98318"
},
"requestId" : "48322e23-dcb9-4f4b-90e1-389b3aa7b20b",
"sender" : {
"type" : "PLAIN",
"firstName" : "Mark",
"lastName" : "Smith",
"street" : "Olszewskiego",
"houseNumber" : "17A",
"city" : "Lublin",
"postalCode" : "20-400",
"flatNumber" : "2",
"email" : "senderEmail@fenige.pl",
"birthDate" : "2023-08-20",
"cardNumber" : "5117964247989169",
"expirationDate" : "03/23",
"personalId" : "AGC688910",
"currency" : "PLN"
},
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "receiverEmail@fenige.pl",
"birthDate" : "2023-08-20",
"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. |
termUrl |
String |
Optional |
@NotEmpty |
Merchant URL to be redirected from Fenige after user login in the bank. This URL must accept order-id parameter, that tells which transaction is begin processed. The presence of this field in the HTTP request specifies that the transaction will be processed with 3DS 1.0. |
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.cavvAlgorithm |
String |
Optional |
@NotNull |
Indicates the algorithm used to generate the AuthenticationCAVV value 0 - HMAC 1 - CVV 2 - CVV with ATN 3 - MasterCard SPA algorithm. |
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. |
4.1.4. 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;charset=ISO-8859-1
Content-Length: 1080
{
"amount" : 2000,
"bigDecimalAmount" : 20.0,
"commission" : 0,
"bigDecimalCommission" : 0,
"orderId" : "5b8f9795-e4d4-4de8-b554-2b9f843cfc0c",
"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;charset=ISO-8859-1
Content-Length: 943
{
"amount" : 2000,
"bigDecimalAmount" : 20.0,
"commission" : 0,
"bigDecimalCommission" : 0,
"orderId" : "4e25f77d-9753-4bd6-8ca9-40d4df8f0182",
"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;charset=ISO-8859-1
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"
}4.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. |
4.2.1. 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" : "9cfd426c-aa47-443b-86b1-5a1beda800d9",
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"cardNumber" : "4485909148265810",
"rememberReceiver" : false,
"phoneNumber" : "48560740349",
"currency" : "PLN"
},
"requestId" : "9cfd426c-aa47-443b-86b1-5a1beda800d9"
}| 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" : "8829b57d-ab1f-4ac3-bbaf-283880ec94f2",
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"cardNumber" : "5117964247989169",
"rememberReceiver" : false,
"phoneNumber" : "48560740349",
"currency" : "PLN"
},
"requestId" : "8829b57d-ab1f-4ac3-bbaf-283880ec94f2"
}| 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" : "4aa30f13-d72a-4b24-9b40-203d8f4dfed9",
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "rob.wring@fenige.pl",
"cardNumber" : "4485909148265810",
"rememberReceiver" : false,
"currency" : "PLN"
},
"requestId" : "4aa30f13-d72a-4b24-9b40-203d8f4dfed9"
}| 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" : "a0b88131-c5fb-4597-855f-7d96a4f3e055",
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "rob.wring@fenige.pl",
"cardNumber" : "5117964247989169",
"rememberReceiver" : false,
"currency" : "PLN"
},
"requestId" : "a0b88131-c5fb-4597-855f-7d96a4f3e055"
}| 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" : "d1290367-ef87-4ba5-b730-448d67945082",
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "rob.wring@fenige.pl",
"cardId" : 1234,
"rememberReceiver" : false,
"currency" : "PLN"
},
"requestId" : "d1290367-ef87-4ba5-b730-448d67945082"
}| 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" : "379c654e-68e7-4ded-bb2e-d1e8f9973ee0",
"receiver" : {
"type" : "DELAYED",
"firstName" : "Rob",
"lastName" : "Wring",
"email" : "rob.wring@fenige.pl",
"cardId" : 1234,
"rememberReceiver" : false,
"currency" : "PLN"
},
"requestId" : "379c654e-68e7-4ded-bb2e-d1e8f9973ee0"
}| 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. |
4.2.2. 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" : "0bfb197a-4c4c-4f79-99b4-d013f96e9839",
"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 |
4.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.
4.3.1. 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:81814.3.2. Response
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" : "5dd149d8-8727-49e9-9206-0c2578d79c11",
"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) |
|
|
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" : "586f8322-c32c-498d-aa10-c646f590c9bc",
"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) |
|
|
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" : "a2871394-17e4-48a0-ae4e-6b1e0777c38f",
"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) |
|
|
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" : "19e19f05-a336-4d6d-a857-d31b829b5cfe",
"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) |
|
|
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 Found5. 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.
5.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' header5.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"
}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. |
6. 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:
|
6.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.
6.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 |
6.1.2. Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 462
{
"cardAuthenticationId" : "1fd1c110-ae9f-41a4-8dd7-11b816ac7552",
"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" : "051a8f1e-c3e8-4573-9a0f-b62ff1ed35af",
"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 |
6.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.
6.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" : "a84f1059-e3c8-4a82-ab51-90854e2243e6",
"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" : "423de3fb-7ec3-4de9-8171-331057237578",
"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. |
6.2.2. Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 151
{
"transactionStatus" : "A",
"transactionXId" : "ca58543f-2e4a-4192-81f5-2f96c0bb47fb",
"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 |
|---|---|
|
|
|
|
|
|
|
|
|
|
6.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.
6.3.1. Request
GET /client/3ds/details/4abd63a5-3f0d-40ef-897b-adaa86f61f59 HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:8181| Parameter | Description |
|---|---|
|
Unique identifier for 3ds verification |
6.3.2. Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 340
{
"cardAuthenticationId" : "dff0e100-653d-4ff8-87f8-e661c693c95f",
"provider" : "MASTERCARD",
"transactionStatus" : "Y",
"cardAuthenticationStatus" : "AUTHENTICATION_FINISHED",
"transactionXId" : "540689fb-2f95-4310-b63c-c8bc4f9e3f39",
"cavv" : "jEu04WZns7pbARAApU4qgNdJTag",
"eci" : "01",
"transactionStatusReason" : "04"
}| Path | Type | Description |
|---|---|---|
|
|
Unique identifier for 3ds verification |
|
|
Card’s provider |
|
|
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. |
|
|
Card authentication status, possible values are: INITIALIZED, PREAUTHENTICATION_INITIATED, PREAUTHENTICATION_CONFIRMED, AUTHENTICATION_REJECTED, AUTHENTICATION, AUTHENTICATION_FINISHED |
|
|
Server transaction Id generated by DS |
|
|
This property is determined by the Access Control Server. 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. 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".Please notice that ECI must be compatible with card provider. |
|
|
Provides information on why the Transaction Status field has the specified value. For MessageCategory 01 (PA), always included when TransactionStatus = N, U, or R. For MessageCategory 02 (NPA), as defined by the DS. Possible values are: 01 - Card authentication failed, 02 - Unknown device, 03 - Unsupported device, 04 - Exceeds authentication frequency limit, 05 - Expired card, 06 - Invalid card number, 07 - Invalid transaction, 08 - No Card record, 09 - Security failure, 10 - Stolen card, 11 - Suspected fraud, 12 - Transaction not permitted to cardholder, 13 - Cardholder not enrolled in service, 14 - Transaction timed out at the ACS, 15 - Low confidence, 16 - Medium confidence, 17 - High confidence, 18 - Very high confidence, 19 - Exceeds ACS maximum challenges, 20 - Non-Payment transaction non supported, 21 - 3RI transaction not supported, 22 - ACS technical issue, 23 - Decoupled Authentication required by ACS but not requested by 3DS Requestor, 24 - 3DS Requestor Decoupled Max Expiry Time exceeded, 25 - Decoupled Authentication was provided insufficient time to authenticate cardholder. ACS will not make attempt, 26 - Authentication attempted but not performed by the cardholder, 27-79 - Reserved for future EMVCo use (values invalid until defined by EMVCo), 80-99 - Reserved for DS use |
6.4. Status codes for 3DS 2.X verification methods
| Code | Messages | HTTP Code | HTTP STATUS |
|---|---|---|---|
ERROR_3DS_2_X_FAILED |
3DS 2.X method failed |
500 |
INTERNAL_SERVER_ERROR |
ERROR_MPI2_INTERNAL_ERROR |
Some internal error occurred while trying to process 3DS 2.X request in MPI2 |
500 |
INTERNAL_SERVER_ERROR |
ERROR_3DS_2_X_REQUIRED_DATA_NOT_COMPLETE |
Required data for processing 3DS 2.X methods are not complete |
422 |
UNPROCESSABLE_ENTITY |
ERROR_3DS_2_X_DATA_MISMATCH |
Three DS Method Data mismatch |
422 |
UNPROCESSABLE_ENTITY |
ERROR_3DS_2_X_DATA_PARSING |
Error on parsing Three DS Method Data |
422 |
UNPROCESSABLE_ENTITY |
ERROR_3DS_2_X_CARD_NUMBER_NOT_ENROLLED |
Card number not Enrolled in 3DS v2 |
422 |
UNPROCESSABLE_ENTITY |
ERROR_3DS_2_X_INVALID_CARD_AUTH_ID |
Invalid card authentication id |
422 |
UNPROCESSABLE_ENTITY |
ERROR_3DS_2_X_ISSUER_CARD_NOT_SUPPORTED |
Issuer card is not supported |
422 |
UNPROCESSABLE_ENTITY |
ERROR_3DS_2_X_INVALID_CARD_NUMBER |
Invalid card number |
422 |
UNPROCESSABLE_ENTITY |
ERROR_3DS_2_X_CARD_AUTH_NOT_EXISTS |
Card Authentication not exists |
404 |
NOT_FOUND |
ERROR_3DS_2_X_PROTOCOL_VERSION_IS_NOT_SUPPORTED |
Protocol version is not supported for card |
422 |
UNPROCESSABLE_ENTITY |
7. Determine currencies methods
7.1. Determine currency
Method is used to determine currencies applied for given cards which are supported based on provided currencyType value.
*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. |
7.1.1. Request
POST /client/determine-currencies HTTP/1.1
Content-Type: application/vnd.determine-currencies.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 195
Host: java-staging.fenige.pl:8181
{
"currencyType" : "STANDARD",
"sender" : {
"type" : "PLAIN",
"cardNumber" : "5575168861324712"
},
"receiver" : {
"type" : "PLAIN",
"cardNumber" : "5319838121111668"
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
currencyType |
String |
Required |
@NotNull |
Consist values: STANDARD, DEFAULT, CUSTOM, ALL |
sender |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN SENDER or DATACORE SENDER) |
receiver |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN RECEIVER, PHONE RECEIVER, DATACORE RECEIVER) |
POST /client/determine-currencies HTTP/1.1
Content-Type: application/vnd.determine-currencies.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 181
Host: java-staging.fenige.pl:8181
{
"currencyType" : "STANDARD",
"sender" : {
"type" : "PLAIN",
"cardNumber" : "5575168861324712"
},
"receiver" : {
"type" : "DATACORE",
"cardId" : 88888
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
currencyType |
String |
Required |
@NotNull |
Consist values: STANDARD, DEFAULT, CUSTOM, ALL |
sender |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN SENDER or DATACORE SENDER) |
receiver |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN RECEIVER, PHONE RECEIVER, DATACORE RECEIVER) |
POST /client/determine-currencies HTTP/1.1
Content-Type: application/vnd.determine-currencies.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 181
Host: java-staging.fenige.pl:8181
{
"currencyType" : "STANDARD",
"sender" : {
"type" : "DATACORE",
"cardId" : 99999
},
"receiver" : {
"type" : "PLAIN",
"cardNumber" : "5319838121111668"
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
currencyType |
String |
Required |
@NotNull |
Consist values: STANDARD, DEFAULT, CUSTOM, ALL |
sender |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN SENDER or DATACORE SENDER) |
receiver |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN RECEIVER, PHONE RECEIVER, DATACORE RECEIVER) |
POST /client/determine-currencies HTTP/1.1
Content-Type: application/vnd.determine-currencies.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 177
Host: java-staging.fenige.pl:8181
{
"currencyType" : "STANDARD",
"sender" : {
"type" : "DATACORE",
"cardId" : 99999
},
"receiver" : {
"type" : "PHONE",
"phoneNumber" : "48123321123"
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
currencyType |
String |
Required |
@NotNull |
Consist values: STANDARD, DEFAULT, CUSTOM, ALL |
sender |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN SENDER or DATACORE SENDER) |
receiver |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN RECEIVER, PHONE RECEIVER, DATACORE RECEIVER) |
POST /client/determine-currencies HTTP/1.1
Content-Type: application/vnd.determine-currencies.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 167
Host: java-staging.fenige.pl:8181
{
"currencyType" : "STANDARD",
"sender" : {
"type" : "DATACORE",
"cardId" : 99999
},
"receiver" : {
"type" : "DATACORE",
"cardId" : 88888
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
currencyType |
String |
Required |
@NotNull |
Consist values: STANDARD, DEFAULT, CUSTOM, ALL |
sender |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN SENDER or DATACORE SENDER) |
receiver |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN RECEIVER, PHONE RECEIVER, DATACORE RECEIVER) |
7.1.2. Response
Response status
| Status | Description |
|---|---|
|
Returned list of currency for sender and reciver. |
|
Returned list of field name which has validation error. |
|
Returned when API-TOKEN was broken. |
Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 273
{
"status" : "SUCCESS",
"success" : {
"senderDefaultCurrencies" : "PLN",
"receiverDefaultCurrencies" : "GBP",
"senderCurrencies" : [ "PLN", "EUR" ],
"receiverCurrencies" : [ "GBP" ],
"senderCountryCode" : "PL",
"receiverCountryCode" : "GB"
}
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Status |
|
|
Default currency code for sender card |
|
|
Default currency code for receiver card |
|
|
Currencies supported by sender’s card |
|
|
Currencies supported by receiver’s card |
|
|
Sender card country |
|
|
Receiver card country |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 186
{
"status" : "SUCCESS",
"success" : {
"senderCurrencies" : [ "PLN" ],
"receiverCurrencies" : [ "GBP" ],
"senderCountryCode" : "PL",
"receiverCountryCode" : "GB"
}
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Status |
|
|
Currencies supported by sender’s card |
|
|
Currencies supported by receiver’s card |
|
|
Sender card country |
|
|
Receiver card country |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 242
{
"status" : "SUCCESS",
"success" : {
"senderCurrencies" : [ "EUR", "PLN", "CZK", "RUB", "UAH" ],
"receiverCurrencies" : [ "EUR", "PLN", "CZK", "RUB", "UAH" ],
"senderCountryCode" : "PL",
"receiverCountryCode" : "GB"
}
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Status |
|
|
Currencies supported by sender’s card |
|
|
Currencies supported by receiver’s card |
|
|
Sender card country |
|
|
Receiver card country |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2524
{
"status" : "SUCCESS",
"success" : {
"senderCurrencies" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "YER", "ZAR", "ZMW", "ZWL" ],
"receiverCurrencies" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "YER", "ZAR", "ZMW", "ZWL" ],
"senderCountryCode" : "PL",
"receiverCountryCode" : "GB"
}
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Status |
|
|
Currencies supported by sender’s card |
|
|
Currencies supported by receiver’s card |
|
|
Sender card country |
|
|
Receiver card country |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [
{
"field": "sender.cardNumber",
"message": [
"may not be null"
]
},
{
"field": "sender.cardNumber",
"message": [
"invalid card number"
]
},
{
"field": "receiver.cardNumber",
"message": [
"may not be null"
]
},
{
"field": "sender.cardNumber",
"message": [
"invalid card number"
]
}
]
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"status": "ERROR_INVALID_JSON",
"error": {
"message": "Some properties are invalid."
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"status": "SUCCESS",
"success": {
"senderCurrencies": [
"UNDEFINED"
],
"receiverCurrencies": [
"UNDEFINED"
]
}
}| Returned UNDEFINED when Merchant configuration doesn’t allow sent type or card number isn’t support. |
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/determine-currencies"
}| Path | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
7.2. Currency rate by provider
Method is used for determine currency rate for revaluation from funding to payment (lowerRate) and payment to funding (higherRate). Notice that `lowerRate` is used to transaction processing.
Api Send-money allows users to select the direction of revaluation by providing specify type value in send-money request. 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.
7.2.1. Request
POST /client/currency-rate HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 108
Host: java-staging.fenige.pl:8181
{
"provider" : "MASTERCARD",
"from" : "USD",
"to" : "PLN",
"effectiveDate" : "2017-06-05 12:00:00"
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
provider |
String |
Required |
@NotNull |
VISA or MASTERCARD or MAESTRO |
from |
String |
Required |
@NotNull |
Source revaluation currency |
to |
String |
Required |
@NotNull |
Destination revaluation currency |
effectiveDate |
String |
Optional |
Format: yyyy-MM-ddHH:mm:ss |
Date from which the currency rate is needed. This is optional field. When there is no effectiveDate field, then currency rate is getting from request date. (Format "yyyy-MM-ddHH:mm:ss") |
7.2.2. Response
Response status
| Status | Description |
|---|---|
|
Returned currency rate VISA or MASTERCARD or MAESTRO. |
|
200 Currency Invalid - Returned when currency is invalid. 200 Currency Rates Invalid - Returned when can’t calculate the rates to the given currencies. 200 Error something wrong - Returned currency rate error. |
Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 104
{
"status" : "SUCCESS",
"success" : {
"lowerRate" : 3.735908,
"higherRate" : 3.8522295
}
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Status of the revaluation |
|
|
Rate for revaluation |
Object (Success)
| Name | Type | Description |
|---|---|---|
|
Decimal |
Rate for revaluation from funding to payment |
|
Decimal |
Rate for revaluation from payment to funding |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"status": "CURRENCY_INVALID",
"error": {
"message": "Invalid currency."
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [
{
"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;charset=UTF-8
{
"status": "CURRENCY_RATES_INVALID",
"error": {
"message": "Invalid currency rates."
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"status": "ERROR_SOMETHING_WRONG",
"error": {
"message": "Something went wrong."
}
}7.3. Currency for card
Method is used to determine currencies applied for given card which are supported based on provided type value.
7.3.1. Request
| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
type |
String |
Required |
@NotNull |
Consist values: STANDARD, DEFAULT, CUSTOM, ALL |
cardNumber |
String |
Required |
@NotNull |
Card number |
POST /client/currency-for-card HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 62
Host: java-staging.fenige.pl:8181
{
"type" : "STANDARD",
"cardNumber" : "5575168861324712"
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
type |
String |
Required |
@NotNull |
Consist values: STANDARD, DEFAULT, CUSTOM, ALL |
cardNumber |
String |
Required |
@NotNull |
Card number |
POST /client/currency-for-card HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 61
Host: java-staging.fenige.pl:8181
{
"type" : "DEFAULT",
"cardNumber" : "5575168861324712"
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
type |
String |
Required |
@NotNull |
Consist values: STANDARD, DEFAULT, CUSTOM, ALL |
cardNumber |
String |
Required |
@NotNull |
Card number |
POST /client/currency-for-card HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 60
Host: java-staging.fenige.pl:8181
{
"type" : "CUSTOM",
"cardNumber" : "5575168861324712"
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
type |
String |
Required |
@NotNull |
Consist values: STANDARD, DEFAULT, CUSTOM, ALL |
cardNumber |
String |
Required |
@NotNull |
Card number |
POST /client/currency-for-card HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 57
Host: java-staging.fenige.pl:8181
{
"type" : "ALL",
"cardNumber" : "5575168861324712"
}7.3.2. Response
Response status
| Status | Description |
|---|---|
|
Returned list of currency for the given card. |
|
Returned list of field name which has validation error. |
Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 134
{
"defaultCurrency" : "EUR",
"currencyCodes" : [ "EUR", "PLN", "CHF", "CZK" ],
"bankName" : "PEKAO SA",
"countryCode" : "PL"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Currencies supported by card |
|
|
Default currency code for card |
|
|
Card bank name |
|
|
Card country code |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 84
{
"currencyCodes" : [ "EUR" ],
"bankName" : "PEKAO SA",
"countryCode" : "PL"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Currencies supported by card |
|
|
Card bank name |
|
|
Card country code |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 133
{
"currencyCodes" : [ "EUR", "PLN", "JOD", "CZK", "RUB", "UAH", "CHF", "JMD" ],
"bankName" : "PEKAO SA",
"countryCode" : "PL"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Currencies supported by card |
|
|
Card bank name |
|
|
Card country code |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1253
{
"currencyCodes" : [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RUR", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VES", "VND", "VUV", "WST", "YER", "ZAR", "ZMW", "ZWL" ],
"bankName" : "PEKAO SA",
"countryCode" : "PL"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Currencies supported by card |
|
|
Card bank name |
|
|
Card country code |
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [{
"field": "type",
"message": [
"may not be null"
]
}
]
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"status": "ERROR_INVALID_JSON",
"error": {
"message": "Some properties are invalid."
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"status": "INVALID_CARD_NO",
"error": {
"message": "Card number is required."
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"currencyCodes": [
"UNDEFINED"
]
}| Returned UNDEFINED when Merchant configuration doesn’t allow sent type or card number isn’t support. |
7.4. Merchant currency configuration
Merchant can have 4 types of configuration:
-
STANDARD - user can only perform transactions in the currencies assigned to the card and that is currency default and currency primary from 1 to 4. Some cards have more than one currency assigned.
-
DEFAULT - user can only perform transactions in the one single currency assigned to the card and that is default card currency.
-
CUSTOM - user may perform transactions in custom currencies selected by your administrator.
-
ALL - all currencies are allowed for transactions.
8. Calculate commission
This method is used to receive information about the commission that will be charged for the transaction. Additional description: - If value the field: "reconciliationType" is "PLUS", the commission during the transaction will be added to the amount sent (the amount charged from the sender will be increased by a commission). - If value the field: "reconciliationType" is "MINUS", then the commission during the transaction will be deducted from the amount received (the amount that will be received by the receiver will be reduced by the commission). - If value the field: "reconciliationType" is "DEPOSITED", the commission during the transaction will neither be subtracted nor added (the amount to be received by the receiver is the same as the amount sent). In addition, the merchant may specify in the field: type two values (SENDER OR RECEIVER). After selecting the value: "SENDER", the transaction will be sent in the amount indicated in the field: amount. Whereas after choosing the value: "RECEIVER", the transaction will be received in the amount indicated in the field: amount. The method allows merchant to calculate commissions for the currencies that have been entered.
*API-TOKEN is required for methods: PLAIN-CASH, DATACORE-PLAIN, PLAIN-DATACORE, DATACORE-PHONE, DATACORE-CASH, DATACORE-DATACORE
| The API-TOKEN is refreshed each time it is used in the header. The API-TOKEN is refreshed for 30 minutes. |
| Please notice that since 01-11-2021 there will be two new error statuses ERROR_WHILE_GETTING_RECEIVER_COUNTRY_CODE and ERROR_WHILE_GETTING_SENDER_COUNTRY_CODE. |
8.1. Request
POST /client/calculate-commission HTTP/1.1
Content-Type: application/vnd.calculate-commission.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 251
Host: java-staging.fenige.pl:8181
{
"amount" : 100,
"type" : "SENDER",
"sender" : {
"type" : "PLAIN",
"cardNumber" : "5117964247989169",
"currency" : "PLN"
},
"receiver" : {
"type" : "PLAIN",
"cardNumber" : "5575167825713507",
"currency" : "PLN"
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
amount |
Number |
Required |
@NotNull, @Min(100) |
The total transfer amount (in pennies) |
type |
String |
Required |
@NotNull |
Value of (SENDER or RECEIVER), for specific transaction type. CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER |
sender |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN SENDER, DATACORE SENDER, CASH SENDER) |
receiver |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN RECEIVER, PHONE RECEIVER, DATACORE RECEIVER, CASH RECEIVER) |
POST /client/calculate-commission HTTP/1.1
Content-Type: application/vnd.calculate-commission.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 187
Host: java-staging.fenige.pl:8181
{
"amount" : 100,
"type" : "SENDER",
"sender" : {
"type" : "PLAIN",
"cardNumber" : "5117964247989169",
"currency" : "PLN"
},
"receiver" : {
"type" : "CASH"
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
amount |
Number |
Required |
@NotNull, @Min(100) |
The total transfer amount (in pennies) |
type |
String |
Required |
@NotNull |
Value of (SENDER or RECEIVER), for specific transaction type. CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER |
sender |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN SENDER, DATACORE SENDER, CASH SENDER) |
receiver |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN RECEIVER, PHONE RECEIVER, DATACORE RECEIVER, CASH RECEIVER) |
POST /client/calculate-commission HTTP/1.1
Content-Type: application/vnd.calculate-commission.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 236
Host: java-staging.fenige.pl:8181
{
"amount" : 100,
"type" : "SENDER",
"sender" : {
"type" : "PLAIN",
"cardNumber" : "5117964247989169",
"currency" : "PLN"
},
"receiver" : {
"type" : "DATACORE",
"cardId" : 9999,
"currency" : "PLN"
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
amount |
Number |
Required |
@NotNull, @Min(100) |
The total transfer amount (in pennies) |
type |
String |
Required |
@NotNull |
Value of (SENDER or RECEIVER), for specific transaction type. CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER |
sender |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN SENDER, DATACORE SENDER, CASH SENDER) |
receiver |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN RECEIVER, PHONE RECEIVER, DATACORE RECEIVER, CASH RECEIVER) |
POST /client/calculate-commission HTTP/1.1
Content-Type: application/vnd.calculate-commission.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 236
Host: java-staging.fenige.pl:8181
{
"amount" : 100,
"type" : "SENDER",
"sender" : {
"type" : "DATACORE",
"cardId" : 8888,
"currency" : "PLN"
},
"receiver" : {
"type" : "PLAIN",
"cardNumber" : "5575167825713507",
"currency" : "PLN"
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
amount |
Number |
Required |
@NotNull, @Min(100) |
The total transfer amount (in pennies) |
type |
String |
Required |
@NotNull |
Value of (SENDER or RECEIVER), for specific transaction type. CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER |
sender |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN SENDER, DATACORE SENDER, CASH SENDER) |
receiver |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN RECEIVER, PHONE RECEIVER, DATACORE RECEIVER, CASH RECEIVER) |
POST /client/calculate-commission HTTP/1.1
Content-Type: application/vnd.calculate-commission.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 232
Host: java-staging.fenige.pl:8181
{
"amount" : 100,
"type" : "SENDER",
"sender" : {
"type" : "DATACORE",
"cardId" : 8888,
"currency" : "PLN"
},
"receiver" : {
"type" : "PHONE",
"phoneNumber" : "48123123123",
"currency" : "PLN"
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
amount |
Number |
Required |
@NotNull, @Min(100) |
The total transfer amount (in pennies) |
type |
String |
Required |
@NotNull |
Value of (SENDER or RECEIVER), for specific transaction type. CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER |
sender |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN SENDER, DATACORE SENDER, CASH SENDER) |
receiver |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN RECEIVER, PHONE RECEIVER, DATACORE RECEIVER, CASH RECEIVER) |
POST /client/calculate-commission HTTP/1.1
Content-Type: application/vnd.calculate-commission.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 172
Host: java-staging.fenige.pl:8181
{
"amount" : 100,
"type" : "SENDER",
"sender" : {
"type" : "DATACORE",
"cardId" : 8888,
"currency" : "PLN"
},
"receiver" : {
"type" : "CASH"
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
amount |
Number |
Required |
@NotNull, @Min(100) |
The total transfer amount (in pennies) |
type |
String |
Required |
@NotNull |
Value of (SENDER or RECEIVER), for specific transaction type. CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER |
sender |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN SENDER, DATACORE SENDER, CASH SENDER) |
receiver |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN RECEIVER, PHONE RECEIVER, DATACORE RECEIVER, CASH RECEIVER) |
POST /client/calculate-commission HTTP/1.1
Content-Type: application/vnd.calculate-commission.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Length: 221
Host: java-staging.fenige.pl:8181
{
"amount" : 100,
"type" : "SENDER",
"sender" : {
"type" : "DATACORE",
"cardId" : 8888,
"currency" : "PLN"
},
"receiver" : {
"type" : "DATACORE",
"cardId" : 9999,
"currency" : "PLN"
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
amount |
Number |
Required |
@NotNull, @Min(100) |
The total transfer amount (in pennies) |
type |
String |
Required |
@NotNull |
Value of (SENDER or RECEIVER), for specific transaction type. CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER |
sender |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN SENDER, DATACORE SENDER, CASH SENDER) |
receiver |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN RECEIVER, PHONE RECEIVER, DATACORE RECEIVER, CASH RECEIVER) |
POST /client/calculate-commission HTTP/1.1
Content-Type: application/vnd.calculate-commission.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 187
Host: java-staging.fenige.pl:8181
{
"amount" : 100,
"type" : "SENDER",
"sender" : {
"type" : "CASH"
},
"receiver" : {
"type" : "PLAIN",
"cardNumber" : "5575167825713507",
"currency" : "PLN"
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
amount |
Number |
Required |
@NotNull, @Min(100) |
The total transfer amount (in pennies) |
type |
String |
Required |
@NotNull |
Value of (SENDER or RECEIVER), for specific transaction type. CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER |
sender |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN SENDER, DATACORE SENDER, CASH SENDER) |
receiver |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN RECEIVER, PHONE RECEIVER, DATACORE RECEIVER, CASH RECEIVER) |
POST /client/calculate-commission HTTP/1.1
Content-Type: application/vnd.calculate-commission.v2+json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 183
Host: java-staging.fenige.pl:8181
{
"amount" : 100,
"type" : "SENDER",
"sender" : {
"type" : "CASH"
},
"receiver" : {
"type" : "PHONE",
"phoneNumber" : "48123123123",
"currency" : "PLN"
}
}| Path | Type | Validation | Rule | Description |
|---|---|---|---|---|
amount |
Number |
Required |
@NotNull, @Min(100) |
The total transfer amount (in pennies) |
type |
String |
Required |
@NotNull |
Value of (SENDER or RECEIVER), for specific transaction type. CARD_CARD: above, CASH_CARD: RECEIVER, CARD_CASH: SENDER |
sender |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN SENDER, DATACORE SENDER, CASH SENDER) |
receiver |
Object |
Required |
@NotNull |
Required configuration per request (PLAIN RECEIVER, PHONE RECEIVER, DATACORE RECEIVER, CASH RECEIVER) |
8.2. Response
8.2.1. Response status
Status |
Description |
|
Returned if the calculate commission completes successfully. |
|
Returned list of field name which has validation error. |
|
Returned when API-TOKEN was broken. |
8.2.2. Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 911
{
"status" : "SUCCESS",
"success" : {
"commission" : 5,
"transactionCommissions" : [ {
"value" : 50,
"bigDecimalValue" : 0.5,
"currencyExponent" : 2,
"currency" : "PLN",
"commissionConfiguration" : {
"currency" : "PLN",
"commissionType" : "PROVISION",
"reconciliationType" : "PLUS",
"geographicScope" : "DOMESTIC",
"transactionType" : {
"id" : "funding",
"name" : "MoneySend Funding"
}
}
} ],
"revaluationResult" : {
"revaluationFundingAmount" : 100,
"bigDecimalRevaluationFundingAmount" : 1,
"fundingCurrency" : "PLN",
"revaluationPaymentAmount" : 100,
"bigDecimalRevaluationPaymentAmount" : 1,
"paymentCurrency" : "PLN",
"determineCurrencyRate" : {
"from" : "PLN",
"to" : "PLN",
"currencyRate" : "1"
}
}
}
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Status |
|
|
Currencies supported by sender’s card |
|
|
Currencies supported by sender’s card |
|
|
Currencies supported by receiver’s card |
TransactionCommissions
| Path | Type | Description |
|---|---|---|
value |
Long |
Value of calculated commission (in pennies) depends on the above parameters |
bigDecimalValue |
BigDecimal |
Value of calculated commission depends on the above parameters |
currencyExponent |
Long |
Decimal places in currency |
currency |
String |
Commission value currency code the same as sender’s card currency when commission is for Funding or the same as receiver’s card currency when commission is for Payment |
commissionConfiguration |
Object (CommissionConfiguration) |
Configuration for commission |
CommissionConfiguration
| Path | Type | Description |
|---|---|---|
currency |
String |
Partner/Merchant currency |
commissionType |
String |
Commission type (PARTNER, FENIGE, ACCEPTANCE NETWORK) |
reconciliationType |
String |
PLUS - means that the commission will be added to the amount sent (the amount charged from the sender will be increased by a commission)., MINUS - means that the commission will be deducted from the amount received (the amount that will be received by the receiver will be reduced by the commission), DEPOSITED - means that the commission during the transaction will neither be subtracted nor added (the amount to be received by the receiver is the same as the amount sent). |
geographicScope |
String |
Type of transaction scope (DOMESTIC, CROSSBORDER, DOMESTIC_PL, INTRA_EU, INTER) |
transactionType |
Object (TransactionType) |
Transaction type for MoneySend Funding or MoneySend Payment |
TransactionType
| Path | Type | Description |
|---|---|---|
id |
String |
Id of transaction: funding or payment |
name |
String |
Name of transaction’s type: MoneySend Funding or MoneySend Payment |
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;charset=UTF-8
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [
{
"field": "amount",
"message": [
"may not be null"
]
},
{
"field": "type",
"message": [
"may not be null"
},
{
"field": "receiver.cardNumber",
"message": [
"may not be null"
]
},
{
"field": "receiver.currency",
"message": [
"may not be null"
]
},
{
"field": "sender.cardNumber",
"message": [
"may not be null"
]
},
{
"field": "sender.currency",
"message": [
"may not be null"
]
}
]
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"status": "ERROR_INVALID_JSON",
"error": {
"message": "Some properties are invalid."
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"status": "ERROR_WHILE_GETTING_COUNTRY_CODE",
"error": {
"message": "Could not get card country code."
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"status": "ERROR_WHILE_GETTING_SENDER_COUNTRY_CODE",
"error": {
"message": "Can not get card for sender."
}
}HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"status": "ERROR_WHILE_GETTING_RECEIVER_COUNTRY_CODE",
"error": {
"message": "Can not get card for 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": "/client/calculate-commission"
}| Path | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
9. Check card’s provider
This method is used to check the card provider, for example: VISA or MASTERCARD.
9.1. Request
POST /client/card/provider HTTP/1.1
Content-Type: application/json
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Content-Length: 39
Host: java-staging.fenige.pl:8181
{
"cardNumber" : "5117964247989169"
}9.2. Response
Response status
| Status | Description |
|---|---|
|
Returned card’s provider. |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 31
{
"provider" : "MASTERCARD"
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
Card’s provider |
10. Check deposit state
10.1. Check deposit state
This method is appropriate only for CASH-CARD transaction model. By use this endpoint it is possible to retrieve current deposit state in settlement currency.
10.1.1. Request
GET /client/merchant/deposit HTTP/1.1
Authorization: Basic bWVyY2hhbnQ6cGFzc3dvcmQ=
Host: java-staging.fenige.pl:818110.1.2. Response
Response status
| Status | Description |
|---|---|
|
Returned state of deposit. |
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 33
{
"remainingDeposit" : 150.99
}Response fields
| Path | Type | Description |
|---|---|---|
|
|
The amount remaining on deposit (in settlement currency) |
11. User authentication
11.1. Login
This method can be use to login to Datacenter by user's credentials. The user can be blocked in the system.
| Before using the login method, you must call 12.1 Add user which adds user to datacenter database. |
|
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. |
11.1.1. Request
POST /client/login HTTP/1.1
Authorization: Basic dGVzdF9tZXJjaGFudDpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 62
Host: java-staging.fenige.pl:8181
{
"id" : "mark.smith@fenige.pl",
"password" : "BBl2f665"
}| Path | Type | Constraints | Description |
|---|---|---|---|
id |
String |
@Length must be between 1 and 128 inclusive, @Must not be blank, @Must not be null |
User id |
password |
String |
@Length must be between 1 and 128 inclusive, @Must not be blank, @Must not be null |
User’s password |
11.1.2. Response
HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=C8E07885E560B8A67746712956EAD3AE; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:05 GMT
Content-Length: 365
{
"status" : "SUCCESS",
"success" : {
"user" : {
"id" : 4516,
"firstName" : "Mark",
"lastName" : "Smith",
"phone" : "48570100200",
"email" : "mark.smith@fenige.pl",
"personalId" : "ADFR34453",
"gender" : "M",
"birthDate" : "1990-11-24"
},
"token" : "d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds="
}
}| Path | Type | Description |
|---|---|---|
|
|
Unique user’s id |
|
|
User’s first name |
|
|
User’s last name |
|
|
User’s phone number |
|
|
User’s e-mail address |
|
|
User personal id (e.g. identity document number) |
|
|
User gender |
|
|
User birthDate |
|
|
Unique generated token that allows user to make other requests |
|
|
Status from Fenige system |
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_USER_NOTFOUND",
"error": {
"message": "Some information is missing or incorrect."
}
}HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=555BB2534CE9566AFBFB6EF7CE1FDEDD; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:05 GMT
Content-Length: 124
{
"status" : "USER_BLOCKED_IN_DATACENTER",
"error" : {
"message" : "Some information is missing or incorrect."
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [
{
"field": "userPasswordIn.id",
"message": [
"may not be null",
"may not be empty"
]
},
{
"field": "userPasswordIn.password",
"message": [
"may not be null",
"may not be empty"
]
},
{
"field": "userPasswordIn.id",
"message": [
"length must be between 1 and 128"
]
},
{
"field": "userPasswordIn.password",
"message": [
"length must be between 1 and 128"
]
}
]
}
}11.2. Logout
This method can be use to logout from Datacenter by user's credentials. This request must have header calling "API-TOKEN" and his value must be the same as token from the Log User method.
11.2.1. Request
POST /client/logout HTTP/1.1
Authorization: Basic dGVzdF9tZXJjaGFudDpwYXNzd29yZA==
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Type: application/json
Host: java-staging.fenige.pl:8181| Name | Description |
|---|---|
|
Basic auth credentials |
|
User’s token to authenticate in service |
11.2.2. Response
Response status
| Status | Description |
|---|---|
|
Returned when user successfully logout. |
|
Returned when API-TOKEN was missing. |
|
Returned when API-TOKEN was broken. |
HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=759626CDF028E147557223FCE31B480D; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:06 GMT
Content-Length: 46
{
"status" : "SUCCESS",
"success" : true
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_SOMETHING_WRONG",
"error": {
"message": "Something went wrong."
}
}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/logout"
}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/logout"
}12. User management
12.1. Add user
This method can be use to add new user in Datacenter. Notice that if 'verified' field is set as `true`, KYC_3 level will set for each transaction of this user (only for DATACENTER transactions).
|
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. |
12.1.1. Request
POST /client/users HTTP/1.1
Authorization: Basic dGVzdF9tZXJjaGFudDpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 381
Host: java-staging.fenige.pl:8181
{
"firstName" : "Mark",
"lastName" : "Smith",
"phone" : "48500600800",
"email" : "mark.smith@fenige.pl",
"password" : "sI1p9UJf",
"birthDate" : "10021994",
"gender" : "M",
"street" : "Olszewskiego",
"flatNumber" : "93",
"houseNumber" : "283",
"postalCode" : "21-023",
"city" : "Lublin",
"country" : "PL",
"personalId" : "AAA00000",
"verified" : true
}| Name | Description |
|---|---|
|
Basic auth credentials |
| Path | Type | Constraints | Description |
|---|---|---|---|
firstName |
String |
Required |
User’s first name |
lastName |
String |
Required |
User’s last name |
phone |
String |
Required |
User’s phone number |
String |
Required |
User’s email used to log in system |
|
password |
String |
Required |
User’s password |
birthDate |
String |
Optional |
Birth date in format ddmmyyyy |
gender |
String |
Optional |
Gender M/F |
street |
String |
Required |
User’s street |
flatNumber |
String |
Optional |
User’s flat number |
houseNumber |
String |
Required |
User’s house number |
postalCode |
String |
Required |
User’s postal code |
city |
String |
Required |
User’s city |
country |
String |
Required |
User country code in accordance with ISO 3166-1 Alpha-2 |
personalId |
String |
@Optional |
User personal id (e.g. identity document number) |
verified |
Boolean |
@Optional |
Is user verified or not. If field is empty or missing 'verified' field is set as 'false' |
POST /client/users HTTP/1.1
Authorization: Basic dGVzdF9tZXJjaGFudDpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 401
Host: java-staging.fenige.pl:8181
{
"firstName" : "Mark",
"lastName" : "Smith",
"phone" : "48500600800",
"email" : "mark.smith@fenige.pl",
"password" : "sI1p9UJf",
"birthDate" : "10021994",
"gender" : "M",
"street" : "Wallstreet",
"flatNumber" : "93",
"houseNumber" : "283",
"postalCode" : "01922",
"city" : "New York",
"country" : "US",
"province" : "NY",
"personalId" : "AAA00000",
"verified" : true
}| Name | Description |
|---|---|
|
Basic auth credentials |
| Path | Type | Constraints | Description |
|---|---|---|---|
firstName |
String |
User’s first name |
|
lastName |
String |
User’s last name |
|
phone |
String |
User’s phone number |
|
String |
User’s email used to log in system |
||
password |
String |
User’s password |
|
birthDate |
String |
Birth date in format ddmmyyyy |
|
gender |
String |
Gender M/F |
|
street |
String |
User’s street |
|
flatNumber |
String |
User’s flat number |
|
houseNumber |
String |
User’s house number |
|
postalCode |
String |
User’s postal code |
|
city |
String |
User’s city |
|
country |
String |
@Required |
User country code in accordance with ISO 3166-1 Alpha-2 |
province |
String |
@Optional |
User’s province |
personalId |
String |
@Optional |
User’s personalId |
verified |
Boolean |
@Optional |
Is user verified or not. If field is empty or missing 'verified' field is set as 'false' |
12.1.2. Response
HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=074A91CBAFD6FC1099BE80EB5A99C5C6; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:17 GMT
Content-Length: 41
{
"status" : "SUCCESS",
"id" : 5967
}| Path | Type | Description |
|---|---|---|
|
|
Response status |
|
|
User’s id |
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "USER_ALREADY_EXISTS",
"id": 2602
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "INVALID_FIRST_NAME",
"id": null
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "INVALID_LAST_NAME",
"id": null
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "INVALID_PHONE",
"id": null
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "INVALID_EMAIL",
"id": null
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "INVALID_PASSWORD",
"id": null
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_INVALID_JSON",
"error": {
"message": "Some properties are invalid."
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_USER_VERIFICATION",
"error": {
"message": "Some information is missing or incorrect."
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "INVALID_COUNTRY",
"error": {
"message": "Some information is missing or incorrect."
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [
{
"field": "addUserIn.province",
"message": [
"may not be null",
"is not correct province code for country code US"
]
},
{
"field": "addUserIn.province",
"message": [
"may not be null",
"is not correct province code for country code CA"
]
},
{
"field": "addUserIn.province",
"message": [
"is not correct country code for province NY"
]
},
{
"field": "addUserIn.province",
"message": [
"province is mandatory only if country code is US or CA"
]
},
{
"field": "addUserIn.province",
"message": [
"must match ^[A-Z]{2}$",
"may not be empty",
"is not correct province code for country code US",
"length must be 2"
]
},
{
"field": "addUserIn.province",
"message": [
"must match ^[A-Z]{2}$",
"may not be empty",
"is not correct province code for country code CA",
"length must be 2"
]
}
]
}
}12.2. Update user
Method allow to update user profile data. This request must have header calling "API-TOKEN" and his value must be the same as token from the Log User method. Notice that if 'verified' field is set as `true`, KYC_3 level will set for each transaction of this user (only for DATACENTER transactions).
*API-TOKEN is required for this method
| The API-TOKEN is refreshed each time it is used in the header. The API-TOKEN is refreshed for 30 minutes. |
|
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. |
12.2.1. Request
PUT /client/users HTTP/1.1
Authorization: Basic dGVzdF9tZXJjaGFudDpwYXNzd29yZA==
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Type: application/json;charset=UTF-8
Content-Length: 602
Host: java-staging.fenige.pl:8181
{
"id" : "4516",
"personalData" : {
"firstName" : "Mark",
"lastName" : "Smith",
"email" : "mark.smith@fenige.pl",
"phone" : "48570100200",
"birthDate" : "24111990",
"personalId" : "ADFR34453",
"verified" : true
},
"address" : {
"id" : "4407",
"street" : "Olszewskiego",
"flatNumber" : "17A",
"houseNumber" : "153",
"postalCode" : "20-400",
"city" : "Lublin",
"countryId" : 616,
"province" : null
},
"password" : {
"oldPassword" : "BBl2f665",
"newPassword" : "Qo9ZXdaGv6_I5",
"newPasswordRepeat" : "Qo9ZXdaGv6_I5"
}
}| Name | Description |
|---|---|
|
Basic auth credentials |
|
User’s token to authenticate in service |
| Path | Type | Constraints | Description |
|---|---|---|---|
id |
String |
Required |
User identifier, received from addUser |
personalData.firstName |
String |
Required |
User first name to update |
personalData.lastName |
String |
Required |
User last name to update |
personalData.email |
String |
Required |
User email to update |
personalData.phone |
String |
Required |
User phone to update |
personalData.birthDate |
String |
Optional |
User birth date to update in format ddMMyyyy |
personalData.personalId |
String |
Optional |
User personal id |
personalData.verified |
Boolean |
Optional |
Is user verified |
address.id |
String |
Required |
User address identifier |
address.street |
String |
Optional |
User street to update |
address.flatNumber |
String |
Optional |
User flat number to update |
address.houseNumber |
String |
Optional |
User house number to update |
address.postalCode |
String |
Optional |
User postal code to update |
address.city |
String |
Optional |
User city to update |
address.countryId |
Number |
Required |
User country id to update in accordance with ISO 3166-1 Alpha-2 |
address.province |
Null |
Optional |
User country province |
password.oldPassword |
String |
Required |
User old password |
password.newPassword |
String |
Required |
User new password |
password.newPasswordRepeat |
String |
Required |
User new password repeated |
12.2.2. Response
HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=9974185A3C1E5F6BCA7117892A7632C6; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:16 GMT
Content-Length: 26
{
"status" : "SUCCESS"
}| Path | Type | Description |
|---|---|---|
|
|
Response status |
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ALREADY_UNSET"
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "INVALID_COUNTRY_ID",
"error": {
"message": "Some information is missing or incorrect."
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [
{
"field": "updateUserIn.password",
"message": [
"newPassword and newPasswordRepeat fields must be the same"
]
},
{
"field": "updateUserIn.password.newPasswordRepeat",
"message": [
"may not be empty"
]
},
{
"field": "updateUserIn.personalData.phone",
"message": [
"may not be null",
"may not be empty"
]
},
{
"field": "updateUserIn.address.id",
"message": [
"may not be empty",
"may not be null"
]
},
{
"field": "updateUserIn.address.province",
"message": [
"is not correct province code for country code CA"
]
},
{
"field": "updateUserIn.address.province",
"message": [
"is not correct province code for country code US",
"may not be null"
]
},
{
"field": "updateUserIn.address.province",
"message": [
"province is mandatory only if country code is US or CA"
]
},
{
"field": "updateUserIn.address.province",
"message": [
"length must be 2",
"may not be empty",
"must match ^[A-Z]{2}$",
"is not correct province code for country code US"
]
},
{
"field": "updateUserIn.address.province",
"message": [
"length must be 2",
"may not be empty",
"must match ^[A-Z]{2}$",
"is not correct province code for country code CA"
]
}
]
}
}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/users"
}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/users"
}| Path | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
12.3. Delete user
This method can be use to delete user from database. In field 'id' you can type user's phone number or email.
|
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. |
12.3.1. Request
DELETE /client/users HTTP/1.1
Authorization: Basic dGVzdF9tZXJjaGFudDpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 17
Host: java-staging.fenige.pl:8181
{
"id" : 7147
}| Name | Description |
|---|---|
|
Basic auth credentials |
| Path | Type | Constraints | Description |
|---|---|---|---|
id |
Number |
@Only digits allowed |
Unique user id |
12.3.2. Response
HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=26A68D9B28EB3E4365034F04CE3B109C; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:14 GMT
Content-Length: 26
{
"status" : "SUCCESS"
}| Path | Type | Description |
|---|---|---|
|
|
Response status |
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "CANT_FIND_USER"
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "UNKNOWN_ERROR"
}12.4. Get user address
This method can be use to receive address details of user.
12.4.1. Request
POST /client/users/address HTTP/1.1
Authorization: Basic dGVzdF9tZXJjaGFudDpwYXNzd29yZA==
Content-Type: application/json;charset=UTF-8
Content-Length: 19
Host: java-staging.fenige.pl:8181
{
"id" : "4407"
}| Name | Description |
|---|---|
|
Basic auth credentials |
| Path | Type | Constraints | Description |
|---|---|---|---|
id |
String |
@Only digits allowed |
Id number of address |
12.4.2. Response
HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=CBE001074EB6EB4726B57612F624C7ED; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:13 GMT
Content-Length: 207
{
"id" : "4407",
"street" : "Olszewskiego",
"city" : "Lublin",
"flatNumber" : "17A",
"houseNumber" : "153",
"postalCode" : "20-400",
"countryId" : 616,
"country" : "PL",
"province" : null
}| Path | Type | Description |
|---|---|---|
|
|
Address’s id |
|
|
User’s street |
|
|
User’s city |
|
|
User’s flat number |
|
|
User’s house number |
|
|
User’s postal code |
|
|
User’s numeric country code |
|
|
User country code in accordance with ISO 3166-1 Alpha-2 |
|
|
User’s province |
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_WHILE_GETTING_ADDRESS",
"error": {
"message": "Some information is missing or incorrect."
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_INVALID_JSON",
"error": {
"message": "Some properties are invalid."
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_SOMETHING_WRONG",
"error": {
"message": "Something went wrong."
}
}12.5. Get countries
Method returns list of countries with specified country code alphabetic and numeric phone prefix for each country.
12.5.1. Request
GET /client/countries HTTP/1.1
Content-Type: application/json
Authorization: Basic eW91cl9tZXJjaGFudDp5b3VyX3Bhc3N3b3Jk
HOST: java-staging.fenige.pl:818112.5.2. Response
Response status
| Status | Description |
|---|---|
|
Returned phone number prefix with country code for countries. |
Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"countryCode": "AF",
"prefix": "93"
},
{
"countryCode": "AL",
"prefix": "355"
},
{
"countryCode": "AQ",
"prefix": "672"
},
{
"countryCode": "DZ",
"prefix": "213"
},
...
]Response fields
| Name | Type | Description |
|---|---|---|
|
|
|
|
|
|
12.6. User password reset
The following API methods resets the password of a user registered in the Fenige system. Resetting the password is done in two steps:
The first step requires a request to retrieve a one-time sms token for the end user and to do this the merchant performs reset user password get token API method. Next
user receives an sms token, which is required in step two as confirmation that the account belongs to that user. The token is a one-time use for password reset and is valid by
default for up to 2 hours from the time it is generated.
Step two is the confirmation of password reset. Merchant executes the reset user password PUT API method with providing the sms token, new password and new password repeat for
the end user.
If all requirements are met, the password has been reset correctly and the merchant gets a confirmation on the API.
12.6.1. Get sms token
One time sms token is sent to end user after execution of this method.
|
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
POST /client/users/password/token HTTP/1.1
Authorization: Basic dGVzdF9tZXJjaGFudDpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 32
Host: java-staging.fenige.pl:8181
{
"email" : "user@email.com"
}| Name | Description |
|---|---|
|
Basic auth credentials |
| Path | Type | Constraints | Description |
|---|---|---|---|
String |
Required |
User’s email address |
Response
HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=2E71F8CE11150DEF47DCBE55E6FF1F8B; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:19 GMT
Content-Length: 26
{
"status" : "SUCCESS"
}| Path | Type | Description |
|---|---|---|
|
|
Response status |
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_USER_NOTFOUND"
}12.6.2. User password reset
Once this method has been performed, the user's password will be reset. The method requires
a one-time sms token.
The new password should meet the requirements for password strength and should contain at least
8 characters, at least 1 capital letter and at least 1 digit. New Password should be repeated.
The number of possible user password changes within a given API client is limited per day
and is configurable as required.
| The smsToken is only required in a production environment for real user data. For testing on test environment, please use the value 'test' for this field. |
|
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
PUT /client/users/password HTTP/1.1
Authorization: Basic dGVzdF9tZXJjaGFudDpwYXNzd29yZA==
Content-Type: application/json
Content-Length: 129
Host: java-staging.fenige.pl:8181
{
"email" : "user@email.com",
"smsToken" : "test",
"newPassword" : "New_passw*rd",
"newPasswordRepeat" : "New_passw*rd"
}| Name | Description |
|---|---|
|
Basic auth credentials |
| Path | Type | Constraints | Description |
|---|---|---|---|
String |
Required |
User’s email address |
|
smsToken |
String |
Required |
User’s sms verification token to authenticate password reset |
newPassword |
String |
Required |
User’s new password |
newPasswordRepeat |
String |
Required |
User’s new password repeat |
Response
HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=8FD7B7CE5FD758A57E8D278E2BE27557; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:16 GMT
Content-Length: 26
{
"status" : "SUCCESS"
}| Path | Type | Description |
|---|---|---|
|
|
API status from Fenige system |
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_USER_NOTFOUND"
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "INVALID_PASSWORD"
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "PASSWORD_RESET_LIMIT_REACHED"
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "INVALID_TOKEN"
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_PASSWORDS_ARE_NOT_THE_SAME"
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [
{
"field": "updatePasswordIn.email",
"message": [
"must not be blank",
"must not be null"
]
},
{
"field": "updatePasswordIn.smsToken",
"message": [
"must not be blank",
"must not be null"
]
},
{
"field": "updatePasswordIn.newPassword",
"message": [
"must not be blank",
"must not be null"
]
},
{
"field": "updatePasswordIn.newPasswordRepeat",
"message": [
"must not be blank",
"must not be null"
]
}
]
}
}13. Card management
13.1. Add card
This method can be use to add new card for existing user. In default limit per user is 5 cards, Fenige can configure it per merchant.
*API-TOKEN is required for this method
In some cases, for some of our clients it is beneficial to combine the sender and receiver database. Each of our clients can do this, but additional configuration is needed on the Fenige side. After changing the database configuration, the sender and receiver cards will be in one database with no distinction between Friend Receivers and Senders.
| The API-TOKEN is refreshed each time it is used in the header. The API-TOKEN is refreshed for 30 minutes. |
|
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. |
13.1.1. Request
PUT /client/card HTTP/1.1
Authorization: Basic dGVzdF9tZXJjaGFudDpwYXNzd29yZA==
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Type: application/json
Content-Length: 299
Host: java-staging.fenige.pl:8181
{
"userIdentifier" : "mark.smith@fenige.pl",
"card" : {
"expDate" : "10/26",
"cardNo" : "5442016597039990",
"defaultValue" : false,
"description" : "Test card number",
"phoneNumber" : "48570102956",
"cardHolderFirstName" : "Mark",
"cardHolderLastName" : "Smith"
}
}| Name | Description |
|---|---|
|
Basic auth credentials |
| Path | Type | Constraints | Description |
|---|---|---|---|
userIdentifier |
String |
@Own constraint |
Sender email address |
card |
Object |
@NotNull |
Card detail information |
card.expDate |
String |
@NotNull, @NotEmpty, @ExpDate |
Expiration date of card mm/yy |
card.cardNo |
String |
@NotNull, @NotEmpty, @CardNumber, @Length(min=12, max=19), @LuhnCheck |
Full sender card number must be between 12-digits and 19-digits |
card.description |
String |
@NotNull, @NotEmpty |
Description of the card |
card.defaultValue |
Boolean |
@NotEmpty |
Is card default |
card.cardHolderFirstName |
String |
@Optional |
Card holder first name |
card.cardHolderLastName |
String |
@Optional |
Card holder last name |
card.phoneNumber |
String |
@Optional |
Optional phone number. It is useful when Merchant has one database for Senders and Receivers. |
13.1.2. Response
HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=8BE4C5AFA4A8DA64FDB8ED38B58641D4; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:09 GMT
Content-Length: 46
{
"status" : "SUCCESS",
"card_id" : 9024
}| Path | Type | Description |
|---|---|---|
|
|
Response status |
|
|
Unique card identifier |
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "CARD_ALREADY_EXISTS",
"card_id": 4368
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_CARD_ALREADY_EXISTS_FOR_ANOTHER_USER",
"card_id": null
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "INVALID_CARD_NO",
"error": {
"message": "Some information is missing or incorrect."
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "CARD_DESC_REQUIRED",
"error": {
"message": "Some information is missing or incorrect."
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "CARD_DESC_INVALID",
"error": {
"message": "Some information is missing or incorrect."
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "CARD_LIMIT_REACHED",
"card_id": null
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "CARD_MODIFY_LIMIT_REACHED",
"card_id": null
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "INVALID_CARD_EXP",
"error": {
"message": "Some information is missing or incorrect."
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "UNKNOWN_ERROR",
"card_id": null
}| Returned UNKNOWN_ERROR when user email was invalid or missing. |
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
Set-Cookie: JSESSIONID=9D87C57ED82A9A45CE556E8604F1940E; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:09 GMT
Content-Length: 141
{
"timestamp" : 1695594189477,
"status" : 403,
"error" : "Forbidden",
"message" : "No message available",
"path" : "/client/card"
}13.2. Update card
This method can be used to update card's data for user. This request must have header calling "API-TOKEN" and his value must be the same as token from the Log User method.
*API-TOKEN is required for this method
| The API-TOKEN is refreshed each time it is used in the header. The API-TOKEN is refreshed for 30 minutes. |
|
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. |
13.2.1. Request
PUT /client/cards HTTP/1.1
Authorization: Basic dGVzdF9tZXJjaGFudDpwYXNzd29yZA==
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Type: application/json
Content-Length: 42
Host: java-staging.fenige.pl:8181
{
"id" : 3815,
"defaultValue" : true
}| Name | Description |
|---|---|
|
Basic auth credentials |
|
User’s token to authenticate in service |
| Path | Type | Constraints | Description |
|---|---|---|---|
id |
Number |
@Not null |
Card id |
defaultValue |
Boolean |
@Not Null |
Is this card default |
13.2.2. Response
HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=51B887C8DEA5E45B39A50743352019AE; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:10 GMT
Content-Length: 43
{
"id" : "3815",
"status" : "SUCCESS"
}| Path | Type | Description |
|---|---|---|
|
|
Response status |
|
|
Unique card identifier |
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "43",
"status": "CANT_FIND_CARD"
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_INVALID_JSON",
"error": {
"message": "Some properties are invalid."
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_SOMETHING_WRONG",
"error": {
"message": "Something went wrong."
}
}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/cards"
}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/cards"
}| Path | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
HTTP/1.1 403 Forbidden
Set-Cookie: JSESSIONID=9D87C57ED82A9A45CE556E8604F1940E; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:09 GMT
Content-Length: 141
{
"timestamp" : 1695594189477,
"status" : 403,
"error" : "Forbidden",
"message" : "No message available",
"path" : "/client/card"
}13.3. Get card list
This method can be use to receive list of cards for user. This request must have header calling "API-TOKEN" and his value must be the same as token from the Log User method.
*API-TOKEN is required for this method
| The API-TOKEN is refreshed each time it is used in the header. The API-TOKEN is refreshed for 30 minutes. |
|
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. |
13.3.1. Request
GET /client/cards HTTP/1.1
Authorization: Basic dGVzdF9tZXJjaGFudDpwYXNzd29yZA==
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Host: java-staging.fenige.pl:8181| Name | Description |
|---|---|
|
Basic auth credentials |
|
User’s token to authenticate in service |
13.3.2. Response
HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=773C5D2048C00553234C21C196EB1A00; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:10 GMT
Content-Length: 564
{
"status" : "SUCCESS",
"success" : [ {
"id" : 2183,
"cardNo" : "0463",
"bin" : "535167",
"description" : "Basic debit card",
"defaultValue" : true,
"strongVerified" : true,
"expDate" : "1026",
"cardHolderFirstName" : "Mark",
"cardHolderLastName" : "Smith"
}, {
"id" : 223,
"cardNo" : "9169",
"bin" : "511796",
"description" : "Basic debit card",
"defaultValue" : false,
"strongVerified" : true,
"expDate" : "0324",
"cardHolderFirstName" : "Mark",
"cardHolderLastName" : "Smith"
} ]
}| Path | Type | Description |
|---|---|---|
|
|
Response status |
|
|
Card id |
|
|
Card number |
|
|
Card bin |
|
|
Card description |
|
|
Is card default value |
|
|
Is card string verified |
|
|
Card holder first name |
|
|
Card holder last name |
|
|
Card expiration date |
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/cards"
}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/cards"
}| Path | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
HTTP/1.1 403 Forbidden
Set-Cookie: JSESSIONID=9D87C57ED82A9A45CE556E8604F1940E; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:09 GMT
Content-Length: 141
{
"timestamp" : 1695594189477,
"status" : 403,
"error" : "Forbidden",
"message" : "No message available",
"path" : "/client/card"
}13.4. Delete card
This method can be use to delete card of some user.
*API-TOKEN is required for this method
| The API-TOKEN is refreshed each time it is used in the header. The API-TOKEN is refreshed for 30 minutes. |
|
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. |
13.4.1. Request
DELETE /client/cards/4787 HTTP/1.1
Authorization: Basic dGVzdF9tZXJjaGFudDpwYXNzd29yZA==
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Host: java-staging.fenige.pl:8181| Name | Description |
|---|---|
|
Basic auth credentials |
|
User’s token to authenticate in service |
13.4.2. Response
HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=FCB51FDA8121EDC1AA8503DFA5453C67; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:10 GMT
Content-Length: 26
{
"status" : "SUCCESS"
}| Path | Type | Description |
|---|---|---|
|
|
Response status |
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_CARD_NOT_FOUND",
"error": {
"message": "Some information is missing or incorrect."
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "CARD_MODIFY_LIMIT_REACHED"
}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/cards/1234"
}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/cards/1234"
}| Path | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
HTTP/1.1 403 Forbidden
Set-Cookie: JSESSIONID=9D87C57ED82A9A45CE556E8604F1940E; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:09 GMT
Content-Length: 141
{
"timestamp" : 1695594189477,
"status" : 403,
"error" : "Forbidden",
"message" : "No message available",
"path" : "/client/card"
}13.5. Get country for card
Method returns country code from which the card is issued. Received country code is in accordance with ISO 3166-1 Alpha-2
13.5.1. Request
| Name | Type | Validation | Description |
|---|---|---|---|
|
|
|
|
POST /client/card/country HTTP/1.1
Content-Type: application/json
Authorization: Basic eW91cl9tZXJjaGFudDp5b3VyX3Bhc3N3b3Jk
Host: java-staging.fenige.pl:8181
{
"cardNumber" : "5351672923040463"
}13.5.2. Response
Response status
| Status | Description |
|---|---|
|
Returned country code from which the card was issued. |
|
Returned country code as UNDEFINED when card number is unsupported. |
|
Returned when card number is invalid or missing. |
Example HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"country" : "PL"
}| Name | Type | Description |
|---|---|---|
|
|
|
HTTP/1.1 200 OK
Content-Type: application/json
{
"country": "UNDEFINED"
}HTTP/1.1 400 Bad Request
{
"timestamp": 1532339149084,
"status": 400,
"error": "Bad Request",
"exception": "org.springframework.web.bind.MethodArgumentNotValidException",
"errors": [
{
"codes": [
"NotBlank.cardCountryRequest.cardNumber",
"NotBlank.cardNumber",
"NotBlank.java.lang.String",
"NotBlank"
],
"arguments": [
{
"codes": [
"cardCountryRequest.cardNumber",
"cardNumber"
],
"arguments": null,
"defaultMessage": "cardNumber",
"code": "cardNumber"
}
],
"defaultMessage": "may not be empty",
"objectName": "cardCountryRequest",
"field": "cardNumber",
"rejectedValue": "",
"bindingFailure": false,
"code": "NotBlank"
},
{
"codes": [
"NotNull.cardCountryRequest.cardNumber",
"NotNull.cardNumber",
"NotNull.java.lang.String",
"NotNull"
],
"arguments": [
{
"codes": [
"cardCountryRequest.cardNumber",
"cardNumber"
],
"arguments": null,
"defaultMessage": "cardNumber",
"code": "cardNumber"
}
],
"defaultMessage": "may not be null",
"objectName": "cardCountryRequest",
"field": "cardNumber",
"rejectedValue": null,
"bindingFailure": false,
"code": "NotNull"
},
{
"codes": [
"LuhnCheck.cardCountryRequest.cardNumber",
"LuhnCheck.cardNumber",
"LuhnCheck.java.lang.String",
"LuhnCheck"
],
"arguments": [
{
"codes": [
"cardCountryRequest.cardNumber",
"cardNumber"
],
"arguments": null,
"defaultMessage": "cardNumber",
"code": "cardNumber"
},
-1,
2147483647,
true,
0
],
"defaultMessage": "invalid card number",
"objectName": "cardCountryRequest",
"field": "cardNumber",
"rejectedValue": "",
"bindingFailure": false,
"code": "LuhnCheck"
},
{
"codes": [
"Size.cardCountryRequest.cardNumber",
"Size.cardNumber",
"Size.java.lang.String",
"Size"
],
"arguments": [
{
"codes": [
"cardCountryRequest.cardNumber",
"cardNumber"
],
"arguments": null,
"defaultMessage": "cardNumber",
"code": "cardNumber"
},
16,
16
],
"defaultMessage": "card number length must be 16",
"objectName": "cardCountryRequest",
"field": "cardNumber",
"rejectedValue": "",
"bindingFailure": false,
"code": "Size"
}
],
"message": "Validation failed for object='cardCountryRequest'. Error count: 3",
"path": "/client/card/country"
}14. Friendly receiver cards
14.1. Add friend card
Method allows you to register favourite receiver card number and phone number to enable mobile-2-mobile MoneySend transactions. This request must have header calling "API-TOKEN" and his value must be the same as token from the Log User method. In default limit per user is 5 friend cards, Fenige can configure it per merchant.
*API-TOKEN is required for Friendly receiver cards methods
| The API-TOKEN is refreshed each time it is used in the header. The API-TOKEN is refreshed for 30 minutes. |
|
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. |
14.1.1. Request
POST /client/friend-card HTTP/1.1
Authorization: Basic dGVzdF9tZXJjaGFudDpwYXNzd29yZA==
API-TOKEN: d94NYa+xqRrazUPzSgYeJ6qR/MzIOb3IzePb7t9sWds=
Content-Type: application/json
Content-Length: 185
Host: java-staging.fenige.pl:8181
{
"cardNumber" : "5442013217661428",
"phoneNumber" : "48570100200",
"friendData" : {
"firstName" : "Mark",
"lastName" : "Smith",
"email" : "mark.smith@fenige.pl"
}
}| Name | Description |
|---|---|
|
Basic auth credentials |
|
User’s token to authenticate in service |
| Path | Type | Constraints | Description |
|---|---|---|---|
cardNumber |
String |
@NotNull, @NotEmpty, @CardNumber, @Length(min=12, max=19), @LuhnCheck |
Full sender card number must be between 12-digits and 19-digits |
phoneNumber |
String |
Optional |
Phone number of friendcard’s holder |
friendData.firstName |
String |
@NotNull, @NotBlank, @Pattern(regexp = "[0-9]+$") |
Friendcard’s holder first name |
friendData.lastName |
String |
@NotNull, @NotBlank, @Pattern(regexp = "[0-9]+$") |
Friendcard’s holder last name |
friendData.email |
String |
Sender email address |
14.1.2. Response
HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=544428974998764C5F33CC4330B63518; Path=/; HttpOnly
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 24 Sep 2023 22:23:07 GMT
Content-Length: 62
{
"status" : "SUCCESS",
"success" : {
"id" : 323
}
}| Path | Type | Description |
|---|---|---|
|
|
Response status from Fenige system |
|
|
Friendcard’s id |
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_VALIDATION",
"error": {
"message": "Some information is missing or incorrect.",
"errors": [
{
"field": "friendCardIn.cardNumber",
"message": [
"may not be empty",
"invalid card number",
"may not be null"
]
},
{
"field": "friendCardIn.friendData",
"message": [
"may not be null"
]
},
{
"field": "friendCardIn.cardNumber",
"message": [
"card number length must be 16",
"card failed luhn check",
"invalid card number"
]
}.
{
"field": "friendCardIn.friendData.firstName",
"message": [
"must match \"^[^0-9]+$\""
]
},
{
"field": "friendCardIn.friendData.lastName",
"message": [
"must match \"^[^0-9]+$\""
]
},
{
"field": "friendCardIn.friendData.firstName",
"message": [
"may not be empty"
]
},
{
"field": "friendCardIn.friendData.lastName",
"message": [
"may not be empty"
]
]
}
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_PHONE_ALREADY_EXISTS",
"card_id": null
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_WHILE_ADDING_CARD",
"card_id": null
}HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "ERROR_CARD_ALREADY_EXISTS",
"card_id": null
}