# Technical Documentation API

Money Transfer Hub provides possibility to process Person-2-Person and Person-2-Merchant transactions in various forms. Please check details in the below documentation.

<p class="callout info">This documentation contains the methods for **mobile-server** integration. The methods included in the documentation are intended for Customers creating their own mobile SDK.</p>

<p class="callout info">The Customer creating the SDK must also remember about the integration with the [MobileDC](https://developer.verestro.com/books/user-lifecycle-card-management-api-sdk) component</p>

<p class="callout warning">Documentation for the **server-to-server** integration is available [here](https://p2ptransactions.upaidtest.pl/docs/index.html) but is **deprecated.**</p>

## Receiver types which can be used to set Receiver.Type

Based on ReceiverType user can fill different field in Receiver object in requests.

<table id="bkmrk-receivertype-descrip"><colgroup><col></col><col></col></colgroup><tbody><tr class="odd"><td>**ReceiverType**

</td><td>**Description**

</td></tr><tr class="even"><td>BARE\_CARD\_NUMBER

</td><td>Bare card number in **Receiver.card** field

</td></tr><tr class="odd"><td>FRIEND\_ID

</td><td>Should pass FriendId in **Receiver.Card** field

</td></tr><tr class="even"><td>WALLET\_CARD\_ID

</td><td>Should pass DataCoreCardId to **Receiver.Card** field and UserDataCoreCardId to **Receiver.userId** field

</td></tr><tr class="odd"><td>EMPTY

</td><td>Means that the receiver have the same card data like sender. This type may be useful on [Determine Currency](#determine-currency)

</td></tr></tbody></table>

## JWE

Peer To Peer Transaction Service supports encryption of requests and responses as standard JSON Web Encryption (JWE) per RFC 7516.

Recommended to read the JWE standard: [RFC 7516](https://datatracker.ietf.org/doc/html/rfc7516).

Methods that support request encryption in the JWE standard are tagged in the documentation with the header: *Content-Type:application/x-jwe-encryption-body+json*. If the response is to be encrypted with the JWE standard then the header must be added: *X-Encryption-Public-Key* with the public key.

Processing requests and responses can be divided into 4 options listed below:

1. Base request → Base response - the following headers should be provided to pass this case:
    
    
    - *Content-Type: application/json*
2. Base request → Encrypted response - the following headers should be provided to pass this case:
    
    
    - *Content-Type: application/json*
3. Encrypted request → Base response - the following headers should be provided to pass this case:
    
    
    - *Content-Type: application/x-jwe-encryption-body+json*
4. Encrypted request → Encrypted response - the following headers should be provided to pass this case:
    
    
    - *Content-Type: application/x-jwe-encryption-body+json*

### Overview

JWE represents encrypted content using JSON data structures and Base64 encoding. The representation consists of three parts: a JWE Header, a encrypted payload, and a signature. The three parts are serialized to UTF-8 bytes, then encoded using base64url encoding. The JWE’s header, payload, and signature are concatenated with periods (.).

JWE typically takes the following form:

```
{Base64 encoded header}.{Base64 encoded payload}.{Base64 encoded signature}
```

JWE header contains:

<table id="bkmrk-type-value-constrain" style="width: 100%;"><colgroup><col style="width: 7.530864%;"></col><col style="width: 16.666667%;"></col><col style="width: 15.185185%;"></col><col style="width: 60.493827%;"></col></colgroup><tbody><tr class="odd"><td>**Type**

</td><td>**Value**

</td><td>**Constraints**

</td><td>**Description**

</td></tr><tr class="even"><td>alg

</td><td>RSA-OAEP-256

</td><td>Required

</td><td>Identifies the cryptographic algorithm used to secure the JWE Encrypted Key. Supported algorithms: **RSA-OAEP-256**, **RSA-OAEP-384**, **RSA-OAEP-512**. Recommend value: **RSA-OAEP-256**.

</td></tr><tr class="odd"><td>enc

</td><td>A256GCM

</td><td>Required

</td><td>Identifies the cryptographic algorithm used to secure the payload. Supported algorithms: **A128GCM**, **A192GCM**, **A256GCM**, **A128CBC-HS256**, **A192CBC-HS384**, **A256CBC-HS512**. Recommend value: **A256GCM**.

</td></tr><tr class="even"><td>typ

</td><td>JOSE

</td><td>Optional

</td><td>Identifies the type of encrypted payload. Recommend value: **JOSE**.

</td></tr><tr class="odd"><td>iat

</td><td>1637929226

</td><td>Optional

</td><td>Identifies the time of generation of the JWT token. Supported date format: unix time in UTC. In the case of *iat*send, the validity of JWE is validated. Recommend send the header due to the increase in the security level.

</td></tr><tr class="even"><td>kid

</td><td>5638742a5094327fcd7a5945d06a45a9d83e9006

</td><td>Optional

</td><td>Identifies the public key of use to encrypt payload. Supported format: SHA-1 value of the public key. In the case of *kid* send, the validity of public key is validated, so we can inform the client that the public key has changed.

</td></tr></tbody></table>

### Payload Encryption

Every encrypted request should include JWE token. The jwe token should be passed in the field: *value*.

In case of problems with the implementation of JWE, please contact the administrator.

To prepare the encrypted payload:

The steps may differ depending on the libraries used.

1. Get the public key using the method: \[???\](#Get publicKey). The public key is encoded with Base64.
2. Decode the public key.
3. Then create a correct object to be encrypted.
4. Encrypt the created object with the public key.
5. Create JWE header compatible with: [JWE Header](#JWE_Header)
6. Make a request on the method that supports JWE. Set the JWE token in the field: *value*. Methods supporting JWE use the following header: *Content-Type:application/x-jwe-encryption-body+json*.

### Payload Decryption

To prepare the decrypted payload:

The steps may differ depending on the libraries used.

The cryptographic algorithm used to secure the payload is: **A256GCM**, while to secure the encrypted JWE key: **RSA-OAEP-256**.

1. For the response to be encrypted you need to send *public key* in the header: *X-Encryption-Public-Key*. The header value must be encoded *Base64*.
2. After receiving the response, you should get the JWE token from the field: *value*.
3. Decrypt the JWE token from the field: *value* with the private key.

**Public key format to be encoded in Base64.**

```
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0IDAQAB...
-----END PUBLIC KEY-----

```

# P2P

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

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

### Request

### Request headers

<table id="bkmrk-request-body-with-he" style="width: 100%;"><caption>Request body with header: *X-Encryption-Public-Key*</caption><colgroup><col style="width: 24.567901%;"></col><col style="width: 14.691358%;"></col><col style="width: 12.592593%;"></col><col style="width: 48.024691%;"></col></colgroup><tbody><tr class="odd"><td>**Type**

</td><td>**Value**

</td><td>**Constraints**

</td><td>**Description**

</td></tr><tr class="even"><td>Authorization

</td><td>Mobile bG9naW46YWNrbWU=

</td><td>Required

</td><td>Device token with "Mobile " prefix

</td></tr><tr class="odd"><td>Product-Name

</td><td>TestProduct

</td><td>Required

</td><td>Application product name

</td></tr><tr class="even"><td>Content-Type

</td><td>application/x-jwe-encryption-body+json

</td><td>Optional

</td><td>Header must be present if the request body is encrypted using the JWE standard.

</td></tr><tr class="odd"><td>X-Encryption-Public-Key

</td><td>  
</td><td>Optional

</td><td>Header must be present if the response body is to be encrypted using the JWE standard. Public key must be encoded Base64.

</td></tr></tbody></table>

### Request fields

### Response

**Error response - ERROR\_VALIDATION.**

```
HTTP/1.1 400 BAD REQUEST
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "ERROR_VALIDATION",
    "message": "Some fields are invalid",
    "data": [
        {
            "field": "{{field_name_from_request}}",
            "message": "{{message}}"
        }
    ]
}

```

**Error response - ERROR\_BAD\_TOKEN.**

```
HTTP/1.1 400 BAD REQUEST
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "ERROR_BAD_TOKEN"
}

```

**Error response - PRODUCT\_NOT\_FOUND.**

```
HTTP/1.1 404 NOT FOUND
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "PRODUCT_NOT_FOUND",
    "message": "Product by name {{product_name}} not found."
}

```

**Error response - INTERNAL\_SERVER\_ERROR.**

```
HTTP/1.1 500 INTERNAL SERVER ERROR
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "INTERNAL_SERVER_ERROR"
}

```

### Response fields

### Errors

<table id="bkmrk-encrypted-response-f"><caption>Encrypted response fields when sent header: *X-Encryption-Public-Key*</caption><colgroup><col></col><col></col><col></col></colgroup><tbody><tr class="odd"><td>**Http Status**

</td><td>**Error Status**

</td><td>**Description**

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>ERROR\_VALIDATION

</td><td>Some fields are invalid

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>ERROR\_BAD\_TOKEN

</td><td>Invalid authorization token

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>Error decoding public key has sent in header: *X-Encryption-Public-Key*

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>Error on decrypting request

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>Error on encrypting response

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>JWE encryption Key is invalid

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>JWE payload is expired

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>INVALID\_PHONE\_NUMBERS

</td><td>Phone numbers has incorrect format

</td></tr><tr class="even"><td>404 - Not Found

</td><td>PRODUCT\_NOT\_FOUND

</td><td>Product not found based on sent header: *Product-Name*

</td></tr><tr class="odd"><td>500 - Internal Server Error

</td><td>INTERNAL\_SERVER\_ERROR

</td><td>Internal application error

</td></tr></tbody></table>

### Examples

## Determine currency

**Request body with header: *X-Encryption-Public-Key*.**

Method is used to determine currencies applied for given sender and receiver cards.

### Request

**Receiver.receiverType = WALLET\_CARD\_ID.**

```
POST /mobile-api/determine-currency HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9nzW46YWNrbWU=
Product-Name:
Content-Type: application/json
Content-Length: 56

{
    "sender": {
        "cardId": "219754"
    },
    "receiver": {
        "card": ["2","1","4","4","9","2"],
        "userId": "1223",
        "receiverType": "WALLET_CARD_ID"
    }
}

```

**Receiver.receiverType = FRIEND\_ID.**

```
POST /mobile-api/determine-currency HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9nzW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 56

{
    "sender": {
        "cardId": "219754"
    },
    "receiver": {
        "userId": "21",
        "receiverType": "FRIEND_ID"
    }
}

```

**Receiver.receiverType = EMPTY.**

```
POST /mobile-api/determine-currency HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9nzW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 56

{
    "sender": {
        "cardId": "219754"
    },
    "receiver": {
        "receiverType": "EMPTY"
    }
}

```

**Receiver.receiverType = BARE\_CARD\_NUMBER.**

```
POST /mobile-api/determine-currency HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9nzW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 56

{
    "sender": {
        "cardId": "219754"
    },
    "receiver": {
        "card": ["2","2","2","1","0","0","4","0","7","2","1","9","0","1","8","5"],
        "receiverType": "BARE_CARD_NUMBER"
    }
}

```

### Request headers

<table id="bkmrk-request-body-with-he-1" style="width: 100%;"><caption>Request body with header: X-Encryption-Public-Key</caption><colgroup><col style="width: 12.839506%;"></col><col style="width: 19.876543%;"></col><col style="width: 9.876543%;"></col><col style="width: 57.283951%;"></col></colgroup><tbody><tr class="odd"><td>**Type**

</td><td>**Value**

</td><td>**Constraints**

</td><td>**Description**

</td></tr><tr class="even"><td>Authorization

</td><td>Mobile bG9naW46YWNrbWU=

</td><td>Required

</td><td>Device token with "Mobile " prefix

</td></tr><tr class="odd"><td>Product-Name

</td><td>TestProduct

</td><td>Required

</td><td>Application product name

</td></tr><tr class="even"><td>Content-Type

</td><td>application/x-jwe-encryption-body+json

</td><td>Optional

</td><td>Header must be present if the request body is encrypted using the JWE standard.

</td></tr><tr class="odd"><td>X-Encryption-Public-Key

</td><td>  
</td><td>Optional

</td><td>Header must be present if the response body is to be encrypted using the JWE standard. Public key must be encoded Base64.

</td></tr></tbody></table>

### Request fields

### Response

**Error response - ERROR\_VALIDATION.**

```
HTTP/1.1 400 BAD REQUEST
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "ERROR_VALIDATION",
    "message": "Some fields are invalid",
    "data": [
        {
            "field": "{{field_name_from_request}}",
            "message": "{{message}}"
        }
    ]
}

```

**Error response - ERROR\_BAD\_TOKEN.**

```
HTTP/1.1 400 BAD REQUEST
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "ERROR_BAD_TOKEN"
}

```

**Error response - PRODUCT\_NOT\_FOUND.**

```
HTTP/1.1 404 NOT FOUND
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "PRODUCT_NOT_FOUND",
    "message": "Product by name {{product_name}} not found."
}

```

**Error response - INTERNAL\_SERVER\_ERROR.**

```
HTTP/1.1 500 INTERNAL SERVER ERROR
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "INTERNAL_SERVER_ERROR"
}

```

### Response fields

### Errors

<table id="bkmrk-encrypted-response-f-0"><caption>Encrypted response fields when sent header: *X-Encryption-Public-Key*</caption><colgroup><col></col><col></col><col></col></colgroup><tbody><tr class="odd"><td>**Http Status**

</td><td>**Error Status**

</td><td>**Description**

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>ERROR\_VALIDATION

</td><td>Some fields are invalid

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>ERROR\_BAD\_TOKEN

</td><td>Invalid authorization token

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>Error decoding public key has sent in header: *X-Encryption-Public-Key*

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>Error on decrypting request

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>Error on encrypting response

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>JWE encryption Key is invalid

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>JWE payload is expired

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>ERROR\_SENDER\_CARD\_NOT\_ACTIVE

</td><td>Sender card is not active

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>ERROR\_RECEIVER\_CARD\_NOT\_ACTIVE

</td><td>Receiver card is not active

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>UNKNOWN\_ERROR

</td><td>Unknown error

</td></tr><tr class="even"><td>404 - Not Found

</td><td>PRODUCT\_NOT\_FOUND

</td><td>Product not found based on sent header: *Product-Name*

</td></tr><tr class="odd"><td>404 - Not Found

</td><td>CANT\_FIND\_CARD

</td><td>Not found card

</td></tr><tr class="even"><td>404 - Not Found

</td><td>FRIEND\_NOT\_EXISTS

</td><td>Not found friend

</td></tr><tr class="odd"><td>500 - Internal Server Error

</td><td>INTERNAL\_SERVER\_ERROR

</td><td>Internal application error

</td></tr><tr class="even"><td>500 - Internal Server Error

</td><td>ERROR\_ON\_GETTING\_DEFAULT\_CARD

</td><td>Error on getting card for friend

</td></tr><tr class="odd"><td>500 - Internal Server Error

</td><td>FENIGE\_ERROR

</td><td>Fenige error

</td></tr></tbody></table>

### Examples

## Currency Rate

**Request body with header: *X-Encryption-Public-Key*.**

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

### Request

### Request headers

<table id="bkmrk-request-body-with-he-3" style="width: 100%;"><caption>Request body with header: *X-Encryption-Public-Key*</caption><colgroup><col style="width: 13.45679%;"></col><col style="width: 16.17284%;"></col><col style="width: 12.962963%;"></col><col style="width: 57.283951%;"></col></colgroup><tbody><tr class="odd"><td>**Type**

</td><td>**Value**

</td><td>**Constraints**

</td><td>**Description**

</td></tr><tr class="even"><td>Authorization

</td><td>Mobile bG9naW46YWNrbWU=

</td><td>Required

</td><td>Device token with "Mobile " prefix

</td></tr><tr class="odd"><td>Product-Name

</td><td>TestProduct

</td><td>Required

</td><td>Application product name

</td></tr><tr class="even"><td>X-Encryption-Public-Key

</td><td>  
</td><td>Optional

</td><td>Header must be present if the response body is to be encrypted using the JWE standard. Public key must be encoded Base64.

</td></tr></tbody></table>

### Response

**Error response - ERROR\_BAD\_TOKEN.**

```
HTTP/1.1 400 BAD REQUEST
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "ERROR_BAD_TOKEN"
}

```

**Error response - PRODUCT\_NOT\_FOUND.**

```
HTTP/1.1 404 NOT FOUND
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "PRODUCT_NOT_FOUND",
    "message": "Product by name {{product_name}} not found."
}

```

**Error response - INTERNAL\_SERVER\_ERROR.**

```
HTTP/1.1 500 INTERNAL SERVER ERROR
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "INTERNAL_SERVER_ERROR"
}

```

### Response fields

### Errors

<table id="bkmrk-encrypted-response-f-1"><caption>Encrypted response fields when sent header: *X-Encryption-Public-Key*</caption><colgroup><col></col><col></col><col></col></colgroup><tbody><tr class="odd"><td>**Http Status**

</td><td>**Error Status**

</td><td>**Description**

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>ERROR\_BAD\_TOKEN

</td><td>Invalid authorization token

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>Error decoding public key has sent in header: *X-Encryption-Public-Key*

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>Error on encrypting response

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>JWE encryption Key is invalid

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>JWE payload is expired

</td></tr><tr class="odd"><td>404 - Not Found

</td><td>PRODUCT\_NOT\_FOUND

</td><td>Product not found based on sent header: *Product-Name*

</td></tr><tr class="even"><td>500 - Internal Server Error

</td><td>INTERNAL\_SERVER\_ERROR

</td><td>Internal application error

</td></tr><tr class="odd"><td>500 - Internal Server Error

</td><td>FENIGE\_ERROR

</td><td>Fenige error

</td></tr></tbody></table>

### Examples

## Calculate commission

**Request body with header: *X-Encryption-Public-Key*.**

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 user 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 user to calculate commissions for the currencies that have been entered.

### Request

**Receiver.receiverType = WALLET\_CARD\_ID.**

```
POST /mobile-api/calculate-commission HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9nzW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 101

{
    "amount": 200078,
    "type": "RECEIVER",
    "sender":{
        "cardId":"219834",
        "currency":"PLN"
    },
    "receiver":{
        "userId": 2345,
        "card": ["2","2","1","2","4","5"],
        "currency": "PLN",
        "receiverType": "WALLET_CARD_ID"
    }
}

```

**Receiver.receiverType = FRIEND\_ID.**

```
POST /mobile-api/calculate-commission HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9nzW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 101

{
    "amount": 200078,
    "type": "RECEIVER",
    "sender":{
        "cardId":"219834",
        "currency":"PLN"
    },
    "receiver":{
        "userId": 2345,
        "currency": "PLN",
        "receiverType": "FRIEND_ID"
    }
}

```

**Receiver.receiverType = BARE\_CARD\_NUMBER.**

```
POST /mobile-api/calculate-commission HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9nzW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 101

{
    "amount": 200078,
    "type": "RECEIVER",
    "sender":{
        "cardId":"219834",
        "currency":"PLN"
    },
    "receiver":{
        "card": ["5","4","9","5","9","8","4","1","7","9","0","8","2","6","4","5"],
        "currency": "PLN",
        "receiverType": "BARE_CARD_NUMBER"
    }
}

```

### Request headers

<table id="bkmrk-request-body-with-he-5" style="width: 100%;"><caption>Request body with header: *X-Encryption-Public-Key*</caption><colgroup><col style="width: 12.839506%;"></col><col style="width: 19.876543%;"></col><col style="width: 15.679012%;"></col><col style="width: 51.481481%;"></col></colgroup><tbody><tr class="odd"><td>**Type**

</td><td>**Value**

</td><td>**Constraints**

</td><td>**Description**

</td></tr><tr class="even"><td>Authorization

</td><td>Mobile bG9naW46YWNrbWU=

</td><td>Required

</td><td>Device token with "Mobile " prefix

</td></tr><tr class="odd"><td>Product-Name

</td><td>TestProduct

</td><td>Required

</td><td>Application product name

</td></tr><tr class="even"><td>Content-Type

</td><td>application/x-jwe-encryption-body+json

</td><td>Optional

</td><td>Header must be present if the request body is encrypted using the JWE standard.

</td></tr><tr class="odd"><td>X-Encryption-Public-Key

</td><td>  
</td><td>Optional

</td><td>Header must be present if the response body is to be encrypted using the JWE standard. Public key must be encoded Base64.

</td></tr></tbody></table>

### Request fields

### Response

**Error response - ERROR\_VALIDATION.**

```
HTTP/1.1 400 BAD REQUEST
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "ERROR_VALIDATION",
    "message": "Some fields are invalid",
    "data": [
        {
            "field": "{{field_name_from_request}}",
            "message": "{{message}}"
        }
    ]
}

```

**Error response - ERROR\_BAD\_TOKEN.**

```
HTTP/1.1 400 BAD REQUEST
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "ERROR_BAD_TOKEN"
}

```

**Error response - PRODUCT\_NOT\_FOUND.**

```
HTTP/1.1 404 NOT FOUND
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "PRODUCT_NOT_FOUND",
    "message": "Product by name {{product_name}} not found."
}

```

**Error response - INTERNAL\_SERVER\_ERROR.**

```
HTTP/1.1 500 INTERNAL SERVER ERROR
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "INTERNAL_SERVER_ERROR"
}

```

### Response fields

### Errors

<table id="bkmrk-encrypted-response-f-2"><caption>Encrypted response fields when sent header: *X-Encryption-Public-Key*</caption><colgroup><col></col><col></col><col></col></colgroup><tbody><tr class="odd"><td>**Http Status**

</td><td>**Error Status**

</td><td>**Description**

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>ERROR\_VALIDATION

</td><td>Some fields are invalid

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>ERROR\_BAD\_TOKEN

</td><td>Invalid authorization token

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>Error decoding public key has sent in header: *X-Encryption-Public-Key*

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>Error on decrypting request

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>Error on encrypting response

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>JWE encryption Key is invalid

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>JWE payload is expired

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>ERROR\_WHILE\_GETTING\_COUNTRY\_CODE

</td><td>Could not get card country code

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>ERROR\_WHILE\_GETTING\_SENDER\_COUNTRY\_CODE

</td><td>Could not get card country code for sender

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>ERROR\_WHILE\_GETTING\_RECEIVER\_COUNTRY\_CODE

</td><td>Could not get card country code for receiver

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>ERROR\_SENDER\_CARD\_NOT\_ACTIVE

</td><td>Sender card is not active

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>ERROR\_RECEIVER\_CARD\_NOT\_ACTIVE

</td><td>Receiver card is not active

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>UNKNOWN\_ERROR

</td><td>Unknown error

</td></tr><tr class="odd"><td>404 - Not Found

</td><td>PRODUCT\_NOT\_FOUND

</td><td>Product not found based on sent header: *Product-Name*

</td></tr><tr class="even"><td>404 - Not Found

</td><td>CANT\_FIND\_CARD

</td><td>Not found card

</td></tr><tr class="odd"><td>404 - Not Found

</td><td>FRIEND\_NOT\_EXISTS

</td><td>Not found friend

</td></tr><tr class="even"><td>500 - Internal Server Error

</td><td>INTERNAL\_SERVER\_ERROR

</td><td>Internal application error

</td></tr><tr class="odd"><td>500 - Internal Server Error

</td><td>ERROR\_ON\_GETTING\_DEFAULT\_CARD

</td><td>Error on getting card for friend

</td></tr><tr class="even"><td>500 - Internal Server Error

</td><td>FENIGE\_ERROR

</td><td>Fenige error

</td></tr></tbody></table>

### Examples

## Send Money

**Request body with header: *X-Encryption-Public-Key*.**

This method is used to full MoneySend transaction (funding and payment).  
Transfers can be make in any currency.  
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.  
**This method adds friend to sender after successful transaction.**

Additionally, you can perform full MoneySend transaction with externalAuthentication (see: [???](#send-money-with-external-authentication) and [Authentication](#authentication))

### Request

**Receiver.receiverType = WALLET\_CARD\_ID.**

```
POST /mobile-api/send-money HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9nzW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 56

{
    "amount": 1000,
    "cvc2": ["1","2","3"],
    "type": "RECEIVER",
    "addressIp": "192.168.0.1",
    "sender": {
        "firstName": "Mark",
        "lastName": "Wards",
        "street": "Olszewskiego",
        "houseNumber": "17A",
        "city": "Lublin",
        "postalCode": "20-400",
        "flatNumber": "2",
        "email": "senderEmail@fenige.pl",
        "currency": "PLN",
        "expirationDate": "03/20",
        "personalId": "AGC688910",
        "cardId": "219708"
    },
    "receiver": {
        "firstName": "Rob",
        "lastName": "Wring",
        "currency": "PLN",
        "card": ["2","1","9","7","0","8"],
        "displayName": "Rob W.",
        "phoneNumber": "48718222333",
        "receiverType": "WALLET_CARD_ID",
        "userId": "13001"
    }
}

```

**Receiver.receiverType = FRIEND\_ID.**

```
POST /mobile-api/send-money HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9nzW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 56

{
    "amount": 1000,
    "cvc2": ["1","2","3"],
    "type": "RECEIVER",
    "addressIp": "192.168.0.1",
    "sender": {
        "firstName": "Mark",
        "lastName": "Wards",
        "street": "Olszewskiego",
        "houseNumber": "17A",
        "city": "Lublin",
        "postalCode": "20-400",
        "flatNumber": "2",
        "email": "senderEmail@fenige.pl",
        "currency": "PLN",
        "expirationDate": "03/20",
        "personalId": "AGC688910",
        "cardId": "219708"
    },
    "receiver": {
        "firstName": "Rob",
        "lastName": "Wring",
        "currency": "PLN",
        "displayName": "Rob W.",
        "receiverType": "FRIEND_ID",
        "userId": "123"
    }
}

```

**Receiver.receiverType = BARE\_CARD\_NUMBER.**

```
POST /mobile-api/send-money HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9nzW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 56

{
    "amount": 1000,
    "cvc2": ["1","2","3"],
    "type": "RECEIVER",
    "addressIp": "192.168.0.1",
    "sender": {
        "firstName": "Mark",
        "lastName": "Wards",
        "street": "Olszewskiego",
        "houseNumber": "17A",
        "city": "Lublin",
        "postalCode": "20-400",
        "flatNumber": "2",
        "email": "senderEmail@fenige.pl",
        "currency": "PLN",
        "expirationDate": "03/20",
        "personalId": "AGC688910",
        "cardId": "219708"
    },
    "receiver": {
        "firstName": "Rob",
        "lastName": "Wring",
        "currency": "PLN",
        "card": ["5","1","4","2","3","3","3","6","2","9","5","2","3","7","3","2"],
        "displayName": "displayName",
        "phoneNumber": "48299000111",
        "receiverType": "BARE_CARD_NUMBER"
    }
}

```

**ExternalAuthentication.authenticationId.**

```
POST /mobile-api/send-money HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9nzW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 56

{
  "amount" : 1000,
  "cvc2" : [ "1", "2", "3" ],
  "type" : "RECEIVER",
  "addressIp" : "192.168.0.1",
  "sender" : {
    "firstName" : "Mark",
    "lastName" : "Asdasd",
    "street" : "Olszewskiego",
    "houseNumber" : "17A",
    "city" : "Lublin",
    "postalCode" : "20-400",
    "flatNumber" : "2",
    "email" : "senderEmail@fenige.pl",
    "currency" : "PLN",
    "expirationDate" : "03/20",
    "personalId" : "AGC688910",
    "cardId" : "219708"
  },
  "receiver" : {
    "firstName" : "Rob",
    "lastName" : "Wring",
    "currency" : "PLN",
    "card" : [ "2", "1", "9", "7", "0", "8" ],
    "displayName" : "displayName",
    "phoneNumber" : "phoneNumber",
    "receiverType" : "WALLET_CARD_ID",
    "userId" : "123"
  },
  "externalAuthentication" : {
    "authenticationId" : "authenticationId"
  }
}

```

**ExternalAuthentication.cavv, eci, transactionXId, authenticationStatus.**

```
POST /mobile-api/send-money HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9nzW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 56

{
  "amount" : 1000,
  "cvc2" : [ "1", "2", "3" ],
  "type" : "RECEIVER",
  "addressIp" : "192.168.0.1",
  "sender" : {
    "firstName" : "Mark",
    "lastName" : "Asdasd",
    "street" : "Olszewskiego",
    "houseNumber" : "17A",
    "city" : "Lublin",
    "postalCode" : "20-400",
    "flatNumber" : "2",
    "email" : "senderEmail@fenige.pl",
    "currency" : "PLN",
    "expirationDate" : "03/20",
    "personalId" : "AGC688910",
    "cardId" : "219708"
  },
  "receiver" : {
    "firstName" : "Rob",
    "lastName" : "Wring",
    "currency" : "PLN",
    "card" : [ "2", "1", "9", "7", "0", "8" ],
    "displayName" : "displayName",
    "phoneNumber" : "phoneNumber",
    "receiverType" : "WALLET_CARD_ID",
    "userId" : "123"
  },
  "externalAuthentication" : {
    "cavv" : "jEu04WZns7pbARAApU4qgNdJTag",
    "eci" : "PLN",
    "authenticationStatus" : "Y",
    "transactionXId" : "9742432a-dfdc-41ca-9ae9-b6595de65f1d"
  }
}

```

### Request headers

<table id="bkmrk-type-value-constrain-0"><colgroup><col></col><col></col><col></col><col></col></colgroup><tbody><tr class="odd"><td>**Type**

</td><td>**Value**

</td><td>**Constraints**

</td><td>**Description**

</td></tr><tr class="even"><td>Authorization

</td><td>Mobile bG9naW46YWNrbWU=

</td><td>Required

</td><td>Device token with "Mobile " prefix

</td></tr><tr class="odd"><td>Product-Name

</td><td>TestProduct

</td><td>Required

</td><td>Application product name

</td></tr><tr class="even"><td>Content-Type

</td><td>application/x-jwe-encryption-body+json

</td><td>Optional

</td><td>Header must be present if the request body is encrypted using the JWE standard.

</td></tr><tr class="odd"><td>X-Encryption-Public-Key

</td><td>  
</td><td>Optional

</td><td>Header must be present if the response body is to be encrypted using the JWE standard. Public key must be encoded Base64.

</td></tr></tbody></table>

### Request fields

### Response

**Error response - ERROR\_VALIDATION.**

```
HTTP/1.1 400 BAD REQUEST
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "ERROR_VALIDATION",
    "message": "Some fields are invalid",
    "data": [
        {
            "field": "{{field_name_from_request}}",
            "message": "{{message}}"
        }
    ]
}

```

**Error response - ERROR\_BAD\_TOKEN.**

```
HTTP/1.1 400 BAD REQUEST
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "ERROR_BAD_TOKEN"
}

```

**Error response - PRODUCT\_NOT\_FOUND.**

```
HTTP/1.1 404 NOT FOUND
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "PRODUCT_NOT_FOUND",
    "message": "Product by name {{product_name}} not found."
}

```

**Error response - INTERNAL\_SERVER\_ERROR.**

```
HTTP/1.1 500 INTERNAL SERVER ERROR
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "INTERNAL_SERVER_ERROR"
}

```

### Response fields

### Errors

<table id="bkmrk-encrypted-response-f-3"><caption>Encrypted response fields when sent header: *X-Encryption-Public-Key*</caption><colgroup><col></col><col></col><col></col></colgroup><tbody><tr class="odd"><td>**Http Status**

</td><td>**Error Status**

</td><td>**Description**

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>ERROR\_VALIDATION

</td><td>Some fields are invalid

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>ERROR\_BAD\_TOKEN

</td><td>Invalid authorization token

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>Error decoding public key has sent in header: *X-Encryption-Public-Key*

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>Error on decrypting request

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>Error on encrypting response

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>JWE encryption Key is invalid

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>CRYPTOGRAPHY\_ERROR

</td><td>JWE payload is expired

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>ERROR\_WHILE\_GETTING\_COUNTRY\_CODE

</td><td>Could not get card country code

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>ERROR\_MERCHANT\_NOT\_SUPPORT\_CARD\_PROVIDER

</td><td>Merchant not support card provider

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>ERROR\_SENDER\_CARD\_NOT\_ACTIVE

</td><td>Sender card is not active

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>ERROR\_RECEIVER\_CARD\_NOT\_ACTIVE

</td><td>Receiver card is not active

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>ERROR\_SENDER\_CARD\_IS\_BLOCKED

</td><td>Sender card is blocked

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>ERROR\_RECEIVER\_CARD\_IS\_BLOCKED

</td><td>Receiver card is blocked

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>UNKNOWN\_ERROR

</td><td>Unknown error

</td></tr><tr class="even"><td>404 - Not Found

</td><td>PRODUCT\_NOT\_FOUND

</td><td>Product not found based on sent header: *Product-Name*

</td></tr><tr class="odd"><td>404 - Not Found

</td><td>CANT\_FIND\_CARD

</td><td>Not found card

</td></tr><tr class="even"><td>404 - Not Found

</td><td>FRIEND\_NOT\_EXISTS

</td><td>Not found friend

</td></tr><tr class="odd"><td>500 - Internal Server Error

</td><td>INTERNAL\_SERVER\_ERROR

</td><td>Internal application error

</td></tr><tr class="even"><td>500 - Internal Server Error

</td><td>FENIGE\_ERROR

</td><td>Fenige error

</td></tr><tr class="odd"><td>500 - Internal Server Error

</td><td>ERROR\_ON\_GETTING\_DEFAULT\_CARD

</td><td>Error on getting card for friend

</td></tr></tbody></table>

### Examples

## Add Friend

**Request body with header: *X-Encryption-Public-Key*.**

This method allow user to add Friend.

### Request

**friendType = WALLET.**

```
POST /mobile-api/wallet-users/friends HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9nzW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 56

{
  "friendWalletDataCoreId": 1,
  "displayName": "Display name",
  "phoneNumber": "48999111222",
  "friendType": "WALLET",
  "firstName": "First",
  "lastName": "Last",
}

```

**friendType = EXTERNAL.**

```
POST /mobile-api/wallet-users/friends HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9nzW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 56

{
  "displayName": "Display name",
  "phoneNumber": "48999111222",
  "friendType": "EXTERNAL",
  "firstName": "First",
  "lastName": "Last",
  "cardNumber": ["5","5","2","7","4","7","9","6","6","8","3","9","0","9","5","7"]
}

```

### Request headers

<table id="bkmrk-request-body-with-he-8" style="width: 100%;"><caption>Request body with header: *X-Encryption-Public-Key*</caption><colgroup><col style="width: 12.839506%;"></col><col style="width: 19.876543%;"></col><col style="width: 12.839506%;"></col><col style="width: 54.320988%;"></col></colgroup><tbody><tr class="odd"><td>**Type**

</td><td>**Value**

</td><td>**Constraints**

</td><td>**Description**

</td></tr><tr class="even"><td>Authorization

</td><td>Mobile bG9naW46YWNrbWU=

</td><td>Required

</td><td>Device token with "Mobile " prefix

</td></tr><tr class="odd"><td>Product-Name

</td><td>TestProduct

</td><td>Required

</td><td>Application product name

</td></tr><tr class="even"><td>Content-Type

</td><td>application/x-response-body+json

</td><td>Optional

</td><td>Header must be present if the response body must have body.

</td></tr><tr class="odd"><td>Content-Type

</td><td>application/x-jwe-encryption-body+json

</td><td>Optional

</td><td>Header must be present if the request body is encrypted using the JWE standard.

</td></tr><tr class="even"><td>X-Encryption-Public-Key

</td><td>  
</td><td>Optional

</td><td>Header must be present if the response body is to be encrypted using the JWE standard. Public key must be encoded Base64.

</td></tr></tbody></table>

### Request fields

### Response

### Response fields

### Examples

## Get User friends

**Request body with header: *X-Encryption-Public-Key*.**

This method allow user to get all his friends

### Request

### Request headers

<table id="bkmrk-encrypted-request-bo" style="width: 100%;"><caption>Encrypted request body with header: Content-Type: application/x-jwe-encryption-body+json</caption><colgroup><col style="width: 13.45679%;"></col><col style="width: 16.17284%;"></col><col style="width: 13.703704%;"></col><col style="width: 56.54321%;"></col></colgroup><tbody><tr class="odd"><td>**Type**

</td><td>**Value**

</td><td>**Constraints**

</td><td>**Description**

</td></tr><tr class="even"><td>Authorization

</td><td>Mobile bG9naW46YWNrbWU=

</td><td>Required

</td><td>Device token with "Mobile " prefix

</td></tr><tr class="odd"><td>Product-Name

</td><td>TestProduct

</td><td>Required

</td><td>Application product name

</td></tr><tr class="even"><td>X-Encryption-Public-Key

</td><td>  
</td><td>Optional

</td><td>Header must be present if the response body is to be encrypted using the JWE standard. Public key must be encoded Base64.

</td></tr></tbody></table>

### Response

### Response fields

### Examples

## Update Friend

**Request body with header: *X-Encryption-Public-Key*.**

This method allow user to update friend. For a friend of the type: WALLET, can update only the field: displayName. For a friend of the type: EXTERNAL, can update the fields: phoneNumber, displayName, firstName, lastName, cardNumber.

### Request

**friendType = WALLET.**

```
PUT /mobile-api/wallet-users/friends/24 HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9naW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 101

{
   "displayName":"Display name"
}

```

**friendType = EXTERNAL.**

```
PUT /mobile-api/wallet-users/friends/24 HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9naW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 101

{
   "phoneNumber":"48999000111",
   "displayName":"Display name",
   "firstName":"First",
   "lastName":"Last",
   "cardNumber":["4","4","4","0","0","0","0","4","4","4","0","4","0"]
}

```

### Request headers

<table id="bkmrk-encrypted-request-bo-0" style="width: 100%;"><caption>Encrypted request body with header: *Content-Type: application/x-jwe-encryption-body+json*</caption><colgroup><col style="width: 10.864198%;"></col><col style="width: 26.790123%;"></col><col style="width: 12.592593%;"></col><col style="width: 49.62963%;"></col></colgroup><tbody><tr class="odd"><td>**Type**

</td><td>**Value**

</td><td>**Constraints**

</td><td>**Description**

</td></tr><tr class="even"><td>Authorization

</td><td>Mobile bG9naW46YWNrbWU=

</td><td>Required

</td><td>Device token with "Mobile " prefix

</td></tr><tr class="odd"><td>Product-Name

</td><td>TestProduct

</td><td>Required

</td><td>Application product name

</td></tr><tr class="even"><td>Content-Type

</td><td>application/x-jwe-encryption-body+json

</td><td>Optional

</td><td>Header must be present if the request body is encrypted using the JWE standard.

</td></tr></tbody></table>

### Request fields

### Response

### Examples

## Delete friend

**Encrypted request body with header: *Content-Type: application/x-jwe-encryption-body+json*.**

This method allow user to delete friend

### Request

### Request headers

<table id="bkmrk-type-value-constrain-1"><colgroup><col></col><col></col><col></col><col></col></colgroup><tbody><tr class="odd"><td>**Type**

</td><td>**Value**

</td><td>**Constraints**

</td><td>**Description**

</td></tr><tr class="even"><td>Authorization

</td><td>Mobile bG9naW46YWNrbWU=

</td><td>Required

</td><td>Device token with "Mobile " prefix

</td></tr><tr class="odd"><td>Product-Name

</td><td>TestProduct

</td><td>Required

</td><td>Application product name

</td></tr></tbody></table>

### Response

### Examples

## Get publicKey

This method allow user to get publicKey

### Request

### Request headers

<table id="bkmrk-type-value-constrain-2"><colgroup><col></col><col></col><col></col><col></col></colgroup><tbody><tr class="odd"><td>**Type**

</td><td>**Value**

</td><td>**Constraints**

</td><td>**Description**

</td></tr><tr class="even"><td>Authorization

</td><td>Mobile bG9naW46YWNrbWU=

</td><td>Required

</td><td>Device token with "Mobile " prefix

</td></tr><tr class="odd"><td>Product-Name

</td><td>TestProduct

</td><td>Required

</td><td>Application product name

</td></tr></tbody></table>

### Response

### Response fields

### Examples

# MC Send

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

## Master Card Send

Methods allow sending money in MasterCard Send 2.0

### Request

**Sender.paymentAccountType = WALLET\_CARD\_ID.**

```
POST /mobile-api/mc-send HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9naW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 885

{
  "transactionId" : "bbb8597d-582c-4a12-a1c8-be9377aed6f9",
  "amount" : 40,
  "currency" : "INR",
  "sender" : {
    "account" : "walletCardId",
    "cvc2": ["3","2","1"],
    "addressId" : "123",
    "paymentAccountType" : "WALLET_CARD_ID"
  },
  "recipient" : {
    "name" : "Juniper Jane",
    "accountUri" : "402414000000006",
    "nationality" : "USA",
    "dateOfBirth" : "2011-05-13",
    "address" : {
      "city" : "Cape Girardeau",
      "country" : "USA",
      "state" : "MO",
      "postalCode" : "23232",
      "street" : "Mastercard Blvd"
    },
    "phone" : "1234567890",
    "email" : "jane.doe@mastercard.com",
    "governmentIds" : [ "123456789", "123456789" ],
    "receiverType" : "BARE_CARD_NUMBER"
  },
  "qrData" : "12",
  "transactionPurpose" : "07",
  "additionalMessage" : "message",
  "merchantCategoryCode" : "6536"
}

```

**Sender.paymentAccountType = IBAN\_ID.**

```
POST /mobile-api/mc-send HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9naW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 885

{
  "transactionId" : "bbb8597d-582c-4a12-a1c8-be9377aed6f9",
  "amount" : 40,
  "currency" : "INR",
  "sender" : {
    "account" : "ibanId",
    "addressId" : "123",
    "paymentAccountType" : "IBAN_ID"
  },
  "recipient" : {
    "name" : "Juniper Jane",
    "accountUri" : "402414000000006",
    "nationality" : "USA",
    "dateOfBirth" : "2011-05-13",
    "address" : {
      "city" : "Cape Girardeau",
      "country" : "USA",
      "state" : "MO",
      "postalCode" : "23232",
      "street" : "Mastercard Blvd"
    },
    "phone" : "1234567890",
    "email" : "jane.doe@mastercard.com",
    "governmentIds" : [ "123456789", "123456789" ],
    "receiverType" : "BARE_CARD_NUMBER"
  },
  "qrData" : "12",
  "transactionPurpose" : "07",
  "additionalMessage" : "message",
  "merchantCategoryCode" : "6536"
}

```

**Recipient.receiverType = WALLET\_CARD\_ID.**

```
POST /mobile-api/mc-send HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9naW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 885

{
  "transactionId" : "bbb8597d-582c-4a12-a1c8-be9377aed6f9",
  "amount" : 40,
  "currency" : "INR",
  "sender" : {
    "account" : "ibanId",
    "addressId" : "123",
    "paymentAccountType" : "IBAN_ID"
  },
  "recipient" : {
    "name" : "Juniper Jane",
    "accountUri" : "4024",
    "nationality" : "USA",
    "dateOfBirth" : "2011-05-13",
    "address" : {
      "city" : "Cape Girardeau",
      "country" : "USA",
      "state" : "MO",
      "postalCode" : "23232",
      "street" : "Mastercard Blvd"
    },
    "phone" : "1234567890",
    "email" : "jane.doe@mastercard.com",
    "governmentIds" : [ "123456789", "123456789" ],
    "userId" : 13001,
    "receiverType" : "WALLET_CARD_ID"
  },
  "qrData" : "12",
  "transactionPurpose" : "07",
  "additionalMessage" : "message",
  "merchantCategoryCode" : "6536"
}

```

**Recipient.receiverType = FRIEND\_ID.**

```
POST /mobile-api/mc-send HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9naW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 885

{
  "transactionId" : "bbb8597d-582c-4a12-a1c8-be9377aed6f9",
  "amount" : 40,
  "currency" : "INR",
  "sender" : {
    "account" : "ibanId",
    "addressId" : "123",
    "paymentAccountType" : "IBAN_ID"
  },
  "recipient" : {
    "name" : "Juniper Jane",
    "nationality" : "USA",
    "dateOfBirth" : "2011-05-13",
    "address" : {
      "city" : "Cape Girardeau",
      "country" : "USA",
      "state" : "MO",
      "postalCode" : "23232",
      "street" : "Mastercard Blvd"
    },
    "phone" : "1234567890",
    "email" : "jane.doe@mastercard.com",
    "governmentIds" : [ "123456789", "123456789" ],
    "userId" : 13001,
    "receiverType" : "FRIEND_ID"
  },
  "qrData" : "12",
  "transactionPurpose" : "07",
  "additionalMessage" : "message",
  "merchantCategoryCode" : "6536"
}

```

**Recipient.receiverType = BARE\_CARD\_NUMBER.**

```
POST /mobile-api/mc-send HTTP/1.1
Content-Type: application/json
Authorization: Mobile bG9naW46YWNrbWU=
Product-Name: TestProduct
Content-Length: 885

{
  "transactionId" : "bbb8597d-582c-4a12-a1c8-be9377aed6f9",
  "amount" : 40,
  "currency" : "INR",
  "sender" : {
    "account" : "ibanId",
    "addressId" : "123",
    "paymentAccountType" : "IBAN_ID"
  },
  "recipient" : {
    "name" : "Juniper Jane",
    "accountUri" : "402414000000006",
    "nationality" : "USA",
    "dateOfBirth" : "2011-05-13",
    "address" : {
      "city" : "Cape Girardeau",
      "country" : "USA",
      "state" : "MO",
      "postalCode" : "23232",
      "street" : "Mastercard Blvd"
    },
    "phone" : "1234567890",
    "email" : "jane.doe@mastercard.com",
    "governmentIds" : [ "123456789", "123456789" ],
    "receiverType" : "BARE_CARD_NUMBER"
  },
  "qrData" : "12",
  "transactionPurpose" : "07",
  "additionalMessage" : "message",
  "merchantCategoryCode" : "6536"
}

```

### Request headers

<table id="bkmrk-request-body-with-he-11" style="width: 100%;"><caption>Request body with header: *X-Encryption-Public-Key*</caption><colgroup><col style="width: 12.839506%;"></col><col style="width: 19.876543%;"></col><col style="width: 13.82716%;"></col><col style="width: 53.333333%;"></col></colgroup><tbody><tr class="odd"><td>**Type**

</td><td>**Value**

</td><td>**Constraints**

</td><td>**Description**

</td></tr><tr class="even"><td>Authorization

</td><td>Mobile bG9naW46YWNrbWU=

</td><td>Required

</td><td>Device token with "Mobile " prefix

</td></tr><tr class="odd"><td>Product-Name

</td><td>TestProduct

</td><td>Required

</td><td>Application product name

</td></tr><tr class="even"><td>Content-Type

</td><td>application/x-jwe-encryption-body+json

</td><td>Optional

</td><td>Header must be present if the request body is encrypted using the JWE standard.

</td></tr><tr class="odd"><td>X-Encryption-Public-Key

</td><td>  
</td><td>Optional

</td><td>Header must be present if the response body is to be encrypted using the JWE standard. Public key must be encoded Base64.

</td></tr></tbody></table>

### Request fields

### Response

**errorStatus = INVALID\_INPUT\_FORMAT.**

```
HTTP/1.1 400 BAD REQUEST
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

{
    "traceId": "b4ce7ad5-758d-444f-90b3-ffbadb757e3f",
    "errorStatus": "INVALID_INPUT_FORMAT",
    "message": "Invalid Format",
    "data": {
        "error": [
            {
                "source": "recipient.accountURI.Expiration date",
                "reasonCode": "INVALID_INPUT_FORMAT",
                "errorDetailCode": "062000",
                "description": "Invalid Format"
            }
        ]
    }
}

```

<table id="bkmrk-a-formal-table-with-"><caption>A formal table with Reason Code</caption><colgroup><col></col><col></col><col></col></colgroup><tbody><tr class="odd"><td>**Error Detail Code**

</td><td>**Reason Code**

</td><td>**Description**

</td></tr><tr class="even"><td>062000

</td><td>INVALID\_INPUT\_FORMAT

</td><td>Value contains invalid character

</td></tr><tr class="odd"><td>072000

</td><td>INVALID\_INPUT\_LENGTH

</td><td>Invalid length

</td></tr><tr class="even"><td>082000

</td><td>INVALID\_INPUT\_VALUE

</td><td>Invalid value

</td></tr><tr class="odd"><td>092000

</td><td>MISSING\_REQUIRED\_INPUT

</td><td>Value is required

</td></tr><tr class="even"><td>110501

</td><td>RESOURCE\_ERROR

</td><td>Duplicate value

</td></tr><tr class="odd"><td>110503

</td><td>RESOURCE\_ERROR

</td><td>Account not eligible

</td></tr><tr class="even"><td>110505

</td><td>RESOURCE\_ERROR

</td><td>Invalid currency

</td></tr><tr class="odd"><td>110507

</td><td>RESOURCE\_UNKNOWN

</td><td>Record not found

</td></tr><tr class="even"><td>110510

</td><td>RESOURCE\_ERROR

</td><td>Invalid Request

</td></tr><tr class="odd"><td>110537

</td><td>RESOURCE\_ERROR

</td><td>Value is not supported for the merchant

</td></tr><tr class="even"><td>130004

</td><td>DECLINE

</td><td>Per transaction maximum amount limit reached

</td></tr><tr class="odd"><td>130006

</td><td>DECLINE

</td><td>Transaction Limit is less than the minimum configured for the partner

</td></tr><tr class="even"><td>130010

</td><td>DECLINE

</td><td>Partner not onboarded for the network to reach the account

</td></tr></tbody></table>

**errorStatus = ERROR\_BAD\_TOKEN.**

```
HTTP/1.1 400 BAD REQUEST
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

{
    "traceId": "{{traceId}}",
    "errorStatus": "ERROR_BAD_TOKEN"
}

```

**errorStatus = CANT\_FIND\_PAYMENT\_TOKEN.**

```
HTTP/1.1 404 NOT FOUND
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

{
    "traceId": "89cdfc2b-346e-42d0-b20d-f3afa01cec68",
    "errorStatus": "CANT_FIND_PAYMENT_TOKEN",
    "message": "Payment token with given id was not found"
}

```

**errorStatus = SYSTEM\_ERROR.**

```
HTTP/1.1 500 INTERNAL SERVER ERROR
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

{
    "traceId": "1c8d4f1f-16db-4c43-bdce-0fe43ae39195",
    "errorStatus": "SYSTEM_ERROR",
    "message": "Internal exception occurred.",
    "data": {
        "error": [
            {
                "source": "SYSTEM",
                "reasonCode": "SYSTEM_ERROR",
                "errorDetailCode": null,
                "description": "Internal exception occurred."
            }
        ]
    }
}

```

### Response fields

### Examples

# Authentication

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

## 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 ThreeDs method flow. After executing ThreeDs method flow, make a request for the method: [Continue Authentication](#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](#finalize-authentication)

### Request

### Request headers

<table id="bkmrk-request-body-with-he-12"><caption>Request body with header: *X-Encryption-Public-Key*</caption><colgroup><col></col><col></col><col></col><col></col></colgroup><tbody><tr class="odd"><td>**Type**

</td><td>**Value**

</td><td>**Constraints**

</td><td>**Description**

</td></tr><tr class="even"><td>Authorization

</td><td>Mobile bG9naW46YWNrbWU=

</td><td>Required

</td><td>Device token with "Mobile " prefix

</td></tr><tr class="odd"><td>Product-Name

</td><td>TestProduct

</td><td>Required

</td><td>Application product name

</td></tr><tr class="even"><td>Content-Type

</td><td>application/x-jwe-encryption-body+json

</td><td>Optional

</td><td>Header must be present if the request body is encrypted using the JWE standard.

</td></tr><tr class="odd"><td>X-Encryption-Public-Key

</td><td>  
</td><td>Optional

</td><td>Header must be present if the response body is to be encrypted using the JWE standard. Public key must be encoded Base64.

</td></tr></tbody></table>

### Request fields

### Response

**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"
}

```

**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"
}

```

**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"
}

```

### Response fields

<table id="bkmrk-base-response-fields" style="width: 100%;"><caption>Base response fields</caption><colgroup><col style="width: 19.62963%;"></col><col style="width: 8.518519%;"></col><col style="width: 71.728395%;"></col></colgroup><tbody><tr class="odd"><td>**Path**

</td><td>**Type**

</td><td>**Description**

</td></tr><tr class="even"><td>authenticationId

</td><td>String

</td><td>Unique authentication identifier

</td></tr><tr class="odd"><td>threeDsMethodData

</td><td>String

</td><td>Encoded data used for request to ACS

</td></tr><tr class="even"><td>threeDsMethodUrl

</td><td>String

</td><td>ACS endpoint for hidden request. If endpoint is not present then request is not required.

</td></tr><tr class="odd"><td>authenticationStatus

</td><td>String

</td><td>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.

</td></tr><tr class="even"><td>transactionXId

</td><td>String

</td><td>This field indicates the transactionXid from recurring initial authentication.

</td></tr><tr class="odd"><td>cavv

</td><td>String

</td><td>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.

</td></tr><tr class="even"><td>eci

</td><td>String

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

</td></tr><tr class="odd"><td>acsUrl

</td><td>String

</td><td>If challenge is required, data for building a form such as challengeHtmlFormBase64

</td></tr><tr class="even"><td>creq

</td><td>String

</td><td>If challenge is required, data for building a form such as challengeHtmlFormBase64

</td></tr><tr class="odd"><td>challengeHtmlFormBase64

</td><td>String

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

</td></tr><tr class="even"><td>threeDsSessionData

</td><td>String

</td><td>ThreeDsSessionData value

</td></tr><tr class="odd"><td>threeDsMode

</td><td>String

</td><td>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](#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](#finalize-authentication)

</td></tr></tbody></table>

### Examples

### Errors

<table id="bkmrk-request-body-with-he-13"><caption>Request body with header: *X-Encryption-Public-Key*</caption><colgroup><col></col><col></col><col></col></colgroup><tbody><tr class="odd"><td>**Http Status**

</td><td>**Error Status**

</td><td>**Description**

</td></tr><tr class="even"><td>400 - Bad Request

</td><td>PROCESS\_NOT\_ALLOWED

</td><td>Method not allowed - invoke calculate commission method is necessary first.

</td></tr><tr class="odd"><td>400 - Bad Request

</td><td>ERROR\_SENDER\_CARD\_NOT\_ACTIVE

</td><td>Sender card is not active

</td></tr></tbody></table>

## 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](#finalize-authentication)

### Request

### Request headers

<table id="bkmrk-request-body-with-he-14" style="width: 100%;"><caption>Request body with header: *X-Encryption-Public-Key*</caption><colgroup><col style="width: 12.839506%;"></col><col style="width: 19.876543%;"></col><col style="width: 13.82716%;"></col><col style="width: 53.333333%;"></col></colgroup><tbody><tr class="odd"><td>**Type**

</td><td>**Value**

</td><td>**Constraints**

</td><td>**Description**

</td></tr><tr class="even"><td>Authorization

</td><td>Mobile bG9naW46YWNrbWU=

</td><td>Required

</td><td>Device token with "Mobile " prefix

</td></tr><tr class="odd"><td>Product-Name

</td><td>TestProduct

</td><td>Required

</td><td>Application product name

</td></tr><tr class="even"><td>Content-Type

</td><td>application/x-jwe-encryption-body+json

</td><td>Optional

</td><td>Header must be present if the request body is encrypted using the JWE standard.

</td></tr><tr class="odd"><td>X-Encryption-Public-Key

</td><td>  
</td><td>Optional

</td><td>Header must be present if the response body is to be encrypted using the JWE standard. Public key must be encoded Base64.

</td></tr></tbody></table>

### Request fields

### Response

**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"
}

```

**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"
}

```

### Response fields

<table id="bkmrk-base-response-fields-0" style="width: 100%;"><caption>Base response fields</caption><colgroup><col style="width: 20.864198%;"></col><col style="width: 11.481481%;"></col><col style="width: 67.530864%;"></col></colgroup><tbody><tr class="odd"><td>**Path**

</td><td>**Type**

</td><td>**Description**

</td></tr><tr class="even"><td>authenticationId

</td><td>String

</td><td>Unique authentication identifier

</td></tr><tr class="odd"><td>authenticationStatus

</td><td>String

</td><td>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.

</td></tr><tr class="even"><td>transactionXId

</td><td>String

</td><td>This field indicates the transactionXid from recurring initial authentication.

</td></tr><tr class="odd"><td>cavv

</td><td>String

</td><td>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.

</td></tr><tr class="even"><td>eci

</td><td>String

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

</td></tr><tr class="odd"><td>acsUrl

</td><td>String

</td><td>If challenge is required, data for building a form such as challengeHtmlFormBase64

</td></tr><tr class="even"><td>creq

</td><td>String

</td><td>If challenge is required, data for building a form such as challengeHtmlFormBase64

</td></tr><tr class="odd"><td>challengeHtmlFormBase64

</td><td>String

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

</td></tr><tr class="even"><td>threeDsSessionData

</td><td>String

</td><td>ThreeDsSessionData value

</td></tr><tr class="odd"><td>threeDsMode

</td><td>String

</td><td>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](#finalize-authentication)

</td></tr></tbody></table>

### Examples

## Finalize Authentication

**Request body with header: *X-Encryption-Public-Key*.**

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

### Request

### Request headers

<table id="bkmrk-request-body-with-he-16" style="width: 100%;"><caption>Request body with header: *X-Encryption-Public-Key*</caption><colgroup><col style="width: 12.839506%;"></col><col style="width: 19.876543%;"></col><col style="width: 12.716049%;"></col><col style="width: 54.444444%;"></col></colgroup><tbody><tr class="odd"><td>**Type**

</td><td>**Value**

</td><td>**Constraints**

</td><td>**Description**

</td></tr><tr class="even"><td>Authorization

</td><td>Mobile bG9naW46YWNrbWU=

</td><td>Required

</td><td>Device token with "Mobile " prefix

</td></tr><tr class="odd"><td>Product-Name

</td><td>TestProduct

</td><td>Required

</td><td>Application product name

</td></tr><tr class="even"><td>Content-Type

</td><td>application/x-jwe-encryption-body+json

</td><td>Optional

</td><td>Header must be present if the request body is encrypted using the JWE standard.

</td></tr><tr class="odd"><td>X-Encryption-Public-Key

</td><td>  
</td><td>Optional

</td><td>Header must be present if the response body is to be encrypted using the JWE standard. Public key must be encoded Base64.

</td></tr></tbody></table>

### Request fields

### Response

### Response fields

<table id="bkmrk-base-response-fields-1" style="width: 100%;"><caption>Base response fields</caption><colgroup><col style="width: 18.765432%;"></col><col style="width: 11.358025%;"></col><col style="width: 69.753086%;"></col></colgroup><tbody><tr class="odd"><td>**Path**

</td><td>**Type**

</td><td>**Description**

</td></tr><tr class="even"><td>authenticationId

</td><td>String

</td><td>Unique authentication identifier

</td></tr><tr class="odd"><td>authenticationStatus

</td><td>String

</td><td>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.

</td></tr><tr class="even"><td>transactionXId

</td><td>String

</td><td>This field indicates the transactionXid from recurring initial authentication.

</td></tr><tr class="odd"><td>cavv

</td><td>String

</td><td>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.

</td></tr><tr class="even"><td>eci

</td><td>String

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

</td></tr></tbody></table>

### Examples