Logo

Peer To Peer Transaction Service (P2P)

Service provides logic for Peer To Peer transactions by Fenige API.

1. Methods in API

1.1. Calculate commission

1.1.1. Request

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/calculate_commission/http-request.adoc[]

1.1.2. Request body

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/calculate_commission/request-fields.adoc[]

1.1.3. Request headers

Type

Value

Constraints

Description

Authorization

Basic bG9naW46YWNrbWU=

Required

Authentication header. Product login & password. Provided while integrating to API.

1.1.4. Response

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/calculate_commission/http-response.adoc[]

1.1.5. Response body

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/calculate_commission/response-fields.adoc[]

1.1.6. Examples

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/calculate_commission/curl-request.adoc[] Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/calculate_commission/httpie-request.adoc[]

1.2. Calculate currency rate

1.2.1. Request

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/CURRENCY_RATE/http-request.adoc[]

1.2.2. Request headers

Type

Value

Constraints

Description

Authorization

Basic bG9naW46YWNrbWU=

Required

Authentication header. Product login & password. Provided while integrating to API.

1.2.3. Response

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/CURRENCY_RATE/http-response.adoc[]

1.2.4. Response body

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/CURRENCY_RATE/response-fields.adoc[]

1.2.5. Examples

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/CURRENCY_RATE/curl-request.adoc[] Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/CURRENCY_RATE/httpie-request.adoc[]

1.3. Determine currency

1.3.1. Request

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/DETERMINE_CURRENCY/http-request.adoc[]

1.3.2. Request headers

Type

Value

Constraints

Description

Authorization

Basic bG9naW46YWNrbWU=

Required

Authentication header. Product login & password. Provided while integrating to API.

1.3.3. Request fields

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/DETERMINE_CURRENCY/request-fields.adoc[]

1.3.4. Response

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/DETERMINE_CURRENCY/http-response.adoc[]

1.3.5. Response body

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/DETERMINE_CURRENCY/response-fields.adoc[]

1.3.6. Examples

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/DETERMINE_CURRENCY/curl-request.adoc[] Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/DETERMINE_CURRENCY/httpie-request.adoc[]

1.4. Send Money

1.4.1. Request

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/SEND_MONEY/http-request.adoc[]

1.4.2. Request with external authentication

ONLY_AUTHENTICATION_ID
Listing 1. ExternalAuthentication.authenticationId
{
  "amount" : 1000,
  "cvc2" : "123",
  "type" : "RECEIVER",
  "addressIp" : "192.168.0.1",
  "sender" : {
    "currency" : "PLN",
    "expirationDate" : "03/20",
    "personalId" : "AGC688910",
    "cardId" : "219708",
    "userId" : "12345",
    "addressId" : "12345"
  },
  "receiver" : {
    "firstName" : "Rob",
    "lastName" : "Wring",
    "currency" : "PLN",
    "card" : "219708",
    "displayName" : "displayName",
    "phoneNumber" : "phoneNumber",
    "receiverType" : "WALLET_CARD_ID",
    "userId" : "123"
  },
  "externalAuthentication" : {
    "authenticationId" : "authenticationId"
  }
}
WITHOUT_AUTHENTICATION_ID
Listing 2. ExternalAuthentication.cavv, eci, transactionXId, authenticationStatus
{
  "amount" : 1000,
  "cvc2" : "123",
  "type" : "RECEIVER",
  "addressIp" : "192.168.0.1",
  "sender" : {
    "currency" : "PLN",
    "expirationDate" : "03/20",
    "personalId" : "AGC688910",
    "cardId" : "219708",
    "userId" : "12345",
    "addressId" : "12345"
  },
  "receiver" : {
    "firstName" : "Rob",
    "lastName" : "Wring",
    "currency" : "PLN",
    "card" : "219708",
    "displayName" : "displayName",
    "phoneNumber" : "phoneNumber",
    "receiverType" : "WALLET_CARD_ID",
    "userId" : "123"
  },
  "externalAuthentication" : {
    "cavv" : "jEu04WZns7pbARAApU4qgNdJTag",
    "eci" : "PLN",
    "authenticationStatus" : "Y",
    "transactionXId" : "9742432a-dfdc-41ca-9ae9-b6595de65f1d"
  }
}

1.4.3. Request headers

Type

Value

Constraints

Description

Authorization

Basic bG9naW46YWNrbWU=

Required

Authentication header. Product login & password. Provided while integrating to API.

Accept-Language

en

Optional

Header indicates the language that the client prefers. If you want to start using this header, contact your administrator

1.4.4. Request fields

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/SEND_MONEY/request-fields.adoc[]

1.4.5. Response

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/SEND_MONEY/http-response.adoc[]

1.4.6. Response body

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/SEND_MONEY/response-fields.adoc[]

1.4.7. Examples

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/SEND_MONEY/curl-request.adoc[] Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/SEND_MONEY/httpie-request.adoc[]

1.5. Send Money Details

This method allow user to get transaction details using orderId. Parameter orderId is returned by method: Send Money

1.5.1. Request

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/SEND_MONEY_DETAILS/http-request.adoc[]

1.5.2. Request headers

Type

Value

Constraints

Description

Authorization

Basic bG9naW46YWNrbWU=

Required

Authentication header. Product login & password. Provided while integrating to API.

1.5.3. Response

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/SEND_MONEY_DETAILS/http-response.adoc[]

1.5.4. Response body

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/SEND_MONEY_DETAILS/response-fields.adoc[]

1.5.5. Examples

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/SEND_MONEY_DETAILS/curl-request.adoc[] Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/SEND_MONEY_DETAILS/httpie-request.adoc[]

1.6. Add Friend

1.6.1. Request

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/add-friend/http-request.adoc[]

1.6.2. Request headers

Type

Value

Constraints

Description

Authorization

Basic bG9naW46YWNrbWU=

Required

Authentication header. Product login & password. Provided while integrating to API.

1.6.3. Request fields

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/add-friend/request-fields.adoc[]

1.6.4. Response

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/add-friend/http-response.adoc[]

1.6.5. Examples

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/add-friend/curl-request.adoc[] Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/add-friend/httpie-request.adoc[]

1.7. Get User friends list

1.7.1. Request

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/get-user-friends/http-request.adoc[]

1.7.2. Request headers

Type

Value

Constraints

Description

Authorization

Basic bG9naW46YWNrbWU=

Required

Authentication header. Product login & password. Provided while integrating to API.

1.7.3. Response

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/get-user-friends/http-response.adoc[]

1.7.4. Response body

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/get-user-friends/response-fields.adoc[]

1.7.5. Examples

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/get-user-friends/curl-request.adoc[] Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/get-user-friends/httpie-request.adoc[]

1.8. Update Friend

1.8.1. Request

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/update-friend/http-request.adoc[]

1.8.2. Request headers

Type

Value

Constraints

Description

Authorization

Basic bG9naW46YWNrbWU=

Required

Authentication header. Product login & password. Provided while integrating to API.

1.8.3. Request fields

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/update-friend/request-fields.adoc[]

1.8.4. Response

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/update-friend/http-response.adoc[]

1.8.5. Examples

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/update-friend/curl-request.adoc[] Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/update-friend/httpie-request.adoc[]

1.9. Delete Friend

1.9.1. Request

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/delete-friend/http-request.adoc[]

1.9.2. Request headers

Type

Value

Constraints

Description

Authorization

Basic bG9naW46YWNrbWU=

Required

Authentication header. Product login & password. Provided while integrating to API.

1.9.3. Response

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/delete-friend/http-response.adoc[]

1.9.4. Examples

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/delete-friend/curl-request.adoc[] Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/delete-friend/httpie-request.adoc[]

1.10. Active Accounts

Method used to find users with valid mc card type (not expired, strong verified). Response will contain phone numbers with user and card identifiers. Users without accepted TOS or without valid MC card will not be returned in response. If user has multiple cards that match criteria response will contain only user’s default card id.

1.10.1. Request

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/ACTIVE_ACCOUNTS/http-request.adoc[]

1.10.2. Request headers

Type

Value

Constraints

Description

Authorization

Basic bG9naW46YWNrbWU=

Required

Authentication header. Product login & password. Provided while integrating to API.

1.10.3. Request fields

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/ACTIVE_ACCOUNTS/request-fields.adoc[]

1.10.4. Response

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/ACTIVE_ACCOUNTS/http-response.adoc[]

1.10.5. Response body

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/ACTIVE_ACCOUNTS/response-fields.adoc[]

1.10.6. Examples

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/ACTIVE_ACCOUNTS/curl-request.adoc[] Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/ACTIVE_ACCOUNTS/httpie-request.adoc[]

2. Authentication

Every single method should contains Authorization and Mobile-Product headers.

2.1. Init Authentication

The authentication stage flow is indicated by the following field: threeDsMode

Method allows us to do initialize authentication using ThreeDs 2.0 protocol.

After this method you have 3 options:

  • FRICTIONLESS - In response: authenticationStatus, transactionXId, cavv, eci and threeDsMode = FRICTIONLESS are present. This response denotes that authentication was finished.

  • ThreeDsMethod flow - In response: threeDsMethodData and threeDsMode = THREE_DS_METHOD are present. This response denotes that you should perform 3DS method flow. After executing ThreeDs method flow, make a request for the method: Continue Authentication

  • CHALLENGE - In response: acsUrl, creq, challengeHtmlFormBase64 and threeDsMode = CHALLENGE are present. This response denotes that you should perform challenge. After executing challenge, make a request for the method: Finalize Authentication

2.1.1. Request headers

Type

Value

Constraints

Description

Authorization

Basic bG9naW46YWNrbWU=

Required

Authentication header. Product login & password. Provided while integrating to API.

2.1.2. Request

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/INITIALIZE_AUTHENTICATION/http-request.adoc[]

2.1.3. Request fields

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/INITIALIZE_AUTHENTICATION/request-fields.adoc[]

2.1.4. Response

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/INITIALIZE_AUTHENTICATION/http-response.adoc[]

2.1.5. Response fields

Path

Type

Description

authenticationId

String

Unique authentication identifier

threeDsMethodData

String

Encoded data used for request to ACS

threeDsMethodUrl

String

ACS endpoint for hidden request. If endpoint is not present then request is not required.

authenticationStatus

String

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

The CRes message can contain only a value of Y or N. Values of D and I are only applicable for ThreeDs version 2.2.0.

transactionXId

String

This field indicates the transactionXid from recurring initial authentication.

cavv

String

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.

eci

String

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".

acsUrl

String

If challenge is required, data for building a form such as challengeHtmlFormBase64

creq

String

If challenge is required, data for building a form such as challengeHtmlFormBase64

challengeHtmlFormBase64

String

This field is a BASE64 encrypted html source file containing the challenge 3-D Secure frame

threeDsSessionData

String

threeDsSessionData value

threeDsMode

String

threeDs process mode which informs about. One of: [FRICTIONLESS, THREE_DS_METHOD, CHALLENGE]

FRICTIONLESS - this is where the authentication process was finished.

THREE_DS_METHOD - next step is to execute the ThreeDs method process. After it is done, we need to make a request to the method: Continue Authentication

CHALLENGE - next step is to execute the challenge process. After it is done, we need to make a request to the method: Finalize Authentication

2.1.6. Success Response body Examples

FRICTIONLESS
Listing 3. threeDsMode = FRICTIONLESS
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
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

{
    "authenticationId": "authenticationId",
    "authenticationStatus": "Y",
    "transactionXId": "9742432a-dfdc-41ca-9ae9-b6595de65f1d",
    "cavv": "jEu04WZns7pbARAApU4qgNdJTag",
    "eci": "02",
    "threeDsMode": "FRICTIONLESS"
}
THREE_DS_METHOD
Listing 4. threeDsMode = THREE_DS_METHOD
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
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

{
    "authenticationId": "authenticationId",
    "threeDsMethodData": "eyJ0aHJlZURWZpY2F0aW9uVVJMIjoiaHR0cHM6Ly93ZWJob29rLnNpdGUvc3MiLCJ0aHJlZURTU2VydmVyVHJhbnNJRCI6IjNmYWYwZjFZi1iYjQyLThkN2RhM2M0NjY5OSJ9",
    "threeDsMethodUrl": "https://threeDsMethodUrl-test.verestro.com/acs-mock",
    "threeDsMode": "THREE_DS_METHOD"
}
CHALLENGE
Listing 5. threeDsMode = CHALLENGE
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
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

{
    "authenticationId": "authenticationId",
    "acsUrl": "https://acs-url.verestro.com/mock-acs",
    "creq": "eyJjYXJkQXV0aGVudGljYNmODlhLTk2MjQtNGQ1OS04NzZmLTNkMWViYTcyNzM3NiIsIm5vdGlmaWNhdGlvblVybvd2ViaG9vay5zaXRlLzE5ODI3MWMyLTljYWYtNGEyMy05ZGJiLWRlZTc3ODExMDdlOSIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiM2ZhZjBmMWQtM2YxNy00MTJmLWJiNDItOGQ3ZGEzYzQ2Njk5IiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCJ9",
    "challengeHtmlFormBase64": "PGh0bWw+PFNDUklQVCBMQU5mF2YXNjcmlwdCI+ZnVuY3Rpb24gT25Mb2FkRXZlbW1lbnQuZG93bmxvYWRGb3JtLnN1Ym1pdCgpOyB9PC9TQ1JJUFQ+PGJvZHkgT25Mb2FkmVudCgpOyI+PGZvcm0gbmFtZT0iZG93bmxvYWRGb3JtIiBhY3Rpb249Imh0dHBzOi8vbXBpLXN0YWdpbmcuZmVuaWdlLnBsL21vY2stYWNzIiBtZXRob2Q9IlBPU1QiPjxJTlBVVCB0eXBlPSJoaWRkZW4iXEiIHZhbHVlPSJleUpqWVhKa1FYVjBhR1Z1ZEdsallYUnBiMjVKWkNJNkltRmpZbU5tT0RsaExUazJNalF0TkdRMU9TMDROelptTFROa01XVmlZVGN5TnpNM05pSXNJbTV2ZEdsbWFXTmhkR2x2YmxWeWJDSTZJbWgwZEhCek9pOHZkMlZpYUc5dmF5NXphWFJsTHpFNU9ESTNNV015TFRsallXWXROR0V5TXkwNVpHSmlMV1JsWlRjM09ERXhNRGRsT1NJc0luUm9jbVZsUkZOVFpYSjJaWEpVY21GdWMwbEVJam9pTTJaaFpqQm1NV1F0TTJZeE55MDBNVEptTFdKaU5ESXRPR1EzWkdFell6UTJOams1SWl3aWJXVnpjMkZuWlZabGNuTnBiMjRpT2lJeUxqRXVNQ0o5Ij48SU5QVVQgdHlwZT0iaGlkZGVuIiBuYW1lPSJ0aHJlZURTU2Vzc2lvbkRhdGEiIHZhbHVlPSJZV05pWTJZNE9XRXRPVFl5TkMwMFpEVTVMVGczTm1ZdE0yUXhaV0poTnpJM016YzIiPjwvZm9ybT48L2JvZHk+PC9odG1sPg==",
    "threeDsSessionData": "YWNiY2Y4OWEtONC00ZDU5LTg3NmYtM2QxZWJhNzI3Mzc2",
    "threeDsMode": "CHALLENGE"
}

2.1.7. Examples

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/INITIALIZE_AUTHENTICATION/curl-request.adoc[]

2.2. Continue Authentication

The authentication stage flow is indicated by the following field: threeDsMode

Method allows us to do continue authentication using ThreeDs 2.0 protocol. Use this method after perform process ThreeDsMethod. This step is optional in the authentication process. Required only if ThreeDsMethod case is present.

After this method you have 2 options:

  • FRICTIONLESS - In response: authenticationStatus, transactionXId, cavv, eci and threeDsMode = FRICTIONLESS are present. This response denotes that authentication was finished.

  • CHALLENGE - In response: acsUrl, creq, challengeHtmlFormBase64 and threeDsMode = CHALLENGE are present. This response denotes that you should perform challenge. After executing challenge, make a request for the method: Finalize Authentication

2.2.1. Request headers

Type

Value

Constraints

Description

Authorization

Basic bG9naW46YWNrbWU=

Required

Authentication header. Product login & password. Provided while integrating to API.

2.2.2. Request

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/CONTINUE_AUTHENTICATION/http-request.adoc[]

2.2.3. Request fields

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/CONTINUE_AUTHENTICATION/request-fields.adoc[]

2.2.4. Response

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/CONTINUE_AUTHENTICATION/http-response.adoc[]

2.2.5. Response fields

Path

Type

Description

authenticationId

String

Unique authentication identifier

authenticationStatus

String

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; ThreeDs Requestor challenge preference acknowledged

The CRes message can contain only a value of Y or N. Values of D and I are only applicable for ThreeDs version 2.2.0.

transactionXId

String

This field indicates the transactionXid from recurring initial authentication.

cavv

String

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.

eci

String

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".

acsUrl

String

If challenge is required, data for building a form such as challengeHtmlFormBase64

creq

String

If challenge is required, data for building a form such as challengeHtmlFormBase64

challengeHtmlFormBase64

String

This field is a BASE64 encrypted html source file containing the challenge 3-D Secure frame

threeDsSessionData

String

threeDsSessionData value

threeDsMode

String

ThreeDs process mode which informs about. One of: [FRICTIONLESS, CHALLENGE]

FRICTIONLESS - this is where the authentication process was finished.

CHALLENGE - next step is to execute the challenge process. After it is done, we need to make a request to the method: Finalize Authentication

2.2.6. Success Response body Examples

FRICTIONLESS
Listing 6. threeDsMode = FRICTIONLESS
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
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

{
    "authenticationId": "authenticationId",
    "authenticationStatus": "Y",
    "transactionXId": "9742432a-dfdc-41ca-9ae9-b6595de65f1d",
    "cavv": "jEu04WZns7pbARAApU4qgNdJTag",
    "eci": "02",
    "threeDsMode": "FRICTIONLESS"
}
CHALLENGE
Listing 7. threeDsMode = CHALLENGE
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
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

{
    "authenticationId": "authenticationId",
    "acsUrl": "https://acs-url.verestro.com/mock-acs",
    "creq": "eyJjYXJkQXV0aGVudGljYNmODlhLTk2MjQtNGQ1OS04NzZmLTNkMWViYTcyNzM3NiIsIm5vdGlmaWNhdGlvblVybvd2ViaG9vay5zaXRlLzE5ODI3MWMyLTljYWYtNGEyMy05ZGJiLWRlZTc3ODExMDdlOSIsInRocmVlRFNTZXJ2ZXJUcmFuc0lEIjoiM2ZhZjBmMWQtM2YxNy00MTJmLWJiNDItOGQ3ZGEzYzQ2Njk5IiwibWVzc2FnZVZlcnNpb24iOiIyLjEuMCJ9",
    "challengeHtmlFormBase64": "PGh0bWw+PFNDUklQVCBMQU5mF2YXNjcmlwdCI+ZnVuY3Rpb24gT25Mb2FkRXZlbW1lbnQuZG93bmxvYWRGb3JtLnN1Ym1pdCgpOyB9PC9TQ1JJUFQ+PGJvZHkgT25Mb2FkmVudCgpOyI+PGZvcm0gbmFtZT0iZG93bmxvYWRGb3JtIiBhY3Rpb249Imh0dHBzOi8vbXBpLXN0YWdpbmcuZmVuaWdlLnBsL21vY2stYWNzIiBtZXRob2Q9IlBPU1QiPjxJTlBVVCB0eXBlPSJoaWRkZW4iXEiIHZhbHVlPSJleUpqWVhKa1FYVjBhR1Z1ZEdsallYUnBiMjVKWkNJNkltRmpZbU5tT0RsaExUazJNalF0TkdRMU9TMDROelptTFROa01XVmlZVGN5TnpNM05pSXNJbTV2ZEdsbWFXTmhkR2x2YmxWeWJDSTZJbWgwZEhCek9pOHZkMlZpYUc5dmF5NXphWFJsTHpFNU9ESTNNV015TFRsallXWXROR0V5TXkwNVpHSmlMV1JsWlRjM09ERXhNRGRsT1NJc0luUm9jbVZsUkZOVFpYSjJaWEpVY21GdWMwbEVJam9pTTJaaFpqQm1NV1F0TTJZeE55MDBNVEptTFdKaU5ESXRPR1EzWkdFell6UTJOams1SWl3aWJXVnpjMkZuWlZabGNuTnBiMjRpT2lJeUxqRXVNQ0o5Ij48SU5QVVQgdHlwZT0iaGlkZGVuIiBuYW1lPSJ0aHJlZURTU2Vzc2lvbkRhdGEiIHZhbHVlPSJZV05pWTJZNE9XRXRPVFl5TkMwMFpEVTVMVGczTm1ZdE0yUXhaV0poTnpJM016YzIiPjwvZm9ybT48L2JvZHk+PC9odG1sPg==",
    "threeDsSessionData": "YWNiY2Y4OWEtONC00ZDU5LTg3NmYtM2QxZWJhNzI3Mzc2",
    "threeDsMode": "CHALLENGE"
}

2.2.7. Examples

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/CONTINUE_AUTHENTICATION/curl-request.adoc[]

2.3. Finalize Authentication

Method allows us to do finalize authentication using ThreeDs 2.0 protocol.

2.3.1. Request headers

Type

Value

Constraints

Description

Authorization

Basic bG9naW46YWNrbWU=

Required

Authentication header. Product login & password. Provided while integrating to API.

2.3.2. Request

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/FINALIZE_AUTHENTICATION/http-request.adoc[]

2.3.3. Request fields

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/FINALIZE_AUTHENTICATION/request-fields.adoc[]

2.3.4. Response

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/FINALIZE_AUTHENTICATION/http-response.adoc[]

2.3.5. Response fields

Path

Type

Description

authenticationId

String

Unique authentication identifier

authenticationStatus

String

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; ThreeDs Requestor challenge preference acknowledged

The CRes message can contain only a value of Y or N. Values of D and I are only applicable for ThreeDs version 2.2.0.

transactionXId

String

This field indicates the transactionXid from recurring initial authentication.

cavv

String

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.

eci

String

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".

2.3.6. Success Response body Examples

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/FINALIZE_AUTHENTICATION/http-response.adoc[]

2.3.7. Examples

Unresolved directive in index.adoc - include::/home/jenkins/workspace/Temurin/Services/java_peer_to_peer_transactions/java_peer_to_peer_transactions-build-deploy-beta/target/generated-snippets/FINALIZE_AUTHENTICATION/curl-request.adoc[]