Page Comparison

id

number, unique

no

All

Payment id, which will be used for the next communication

status

enum

no

All

Status of the payment. Possible statuses are described below in separate table: https://everifin.atlassian.net/wiki/spaces/EFMBAPI/pages/edit-v2/2675179539#Payment-statuses

If status is FINISHED or FAILED, processing is done and there is nothing else to do. Otherwise you should call process endpoint.

type

enum

yes

All

Processing flow step type (given by specific bank):

• REDIRECT - you should redirect to redirectUrl

• INPUT - some user input is required

• NEXT - if status is CONFIRMED/BOOKED or FAILED, processing is done and there is nothing else to do. Otherwise you You should call process endpoint.

• PUSH - waiting for the confirmation of PUSH notification (no action required but status needs to be checked after some time by calling this endpoint). Payer needs to handle the push notification in the mobile device.

redirectUrl

text

yes

REDIRECT

The URL for redirect (only for REDIRECT response types)

inputSet

InputObject[]

yes

INPUT

Array of input objects required for next processing. Values from this set has to be displayed to the user, so she/he can enter or select required values.

input

InputObject

yes

INPUT

Input object required for next processing. Input has to be displayed to the user, so she/he can enter or select required value. Response might contain this field, if only one input is requested. If multiple inputs are requested, response contains inputSet field.

inputsToEncrypt

string[]

yes

INPUT

List of inputs to encrypt, if sensitive user’s data are required in input or inputSet. These inputs must be encrypted in the request body.

inputEncryptionConfig

InputEncryptionConfig

yes

INPUT

If response contains inputsToEncrypt, this field specifies encryption method and encryption key.

Input Object

type

enum

no

INPUT

Type of the input:

• TEXT - user has to enter some text, e.g. username, sms code etc.

• PASSWORD - user has to input his bank password

• BOOLEAN - user has to give consent to some action

• SELECT - user has to select an option

• IMAGE_SCAN - user has to scan some image into his mobile app, e.g. QR

• IBAN - user has to enter his IBAN

Based on this field you can set the UI for the user like html input types and validation.

name

text

no

INPUT

Name of the input to identify it by Everifin system. This name must be returned back together with the value the user has provided.

selectOptions

SelectObject[]

yes

INPUT

Only for SELECT input type. User has to select one of offered options.

image

yes

INPUT

Only for IMAGE_SCAN input type. User has to scan the image into his mobile banking app.

Select Object

name

text

no

INPUT

Name of the select option.

value

text

no

INPUT

Value of the select option.

InputEncryptionConfig

encryptionKey

string

no

INPUT

Public key for data encryption.

encryptionMethod

string

no

INPUT

Method of data encryption. Currently, only supported value is RSAES-OAEP/SHA-256.