iFrame Initialization

eWallet iFrame

HTTP Request

Header

ParameterTypeDescription
Content-TypeStringUse value 'application/json'
AcceptStringUse value 'application/json'
x-api-versionStringUse value 1
KeyStringAPI key

Parameters

NameTypeRequiredDescription
returnUrlURLtrueURL to send callback after successful transfer. Response will be JSON representation of ApiSGPGPaymentResponse object. Results will be sent asynchronously as soon as transfer will be executed by remote processor (this can happen after closing of iframe). Time of execution is not guaranteed and can be different for different processors.
errorUrlURLfalse

URL to send callback after failed transfer. Response will be JSON representation of ApiSGPGErrorResponse object. Results will be sent asynchronously as soon as transfer will be executed by remote processor (this can happen after closing of iframe). Time of execution is not guaranteed and can be different for different processors.

validationKeyStringtrue

Secret key to validate payment response and get status of payment. It should be generated from merchant end and should be unique for each request. Minimum characters are 48 and maximum characters are 255.

clientSGPGPlatformUsertrue

Complex object containing information about client. All information except email can be edited in iframe

clientReferenceStringtrue

Id of client in merchant’s system. Maximum characters are 48.

addressSGPGAddresstrue

Complex object containing information about client’s address, can be edited in iframe

traceIdStringtrue

Merchant's identifier for the call. Maximum characters are 48.

moneyMoneytrue

Complex Money object containing transfer amount and currency

descriptionStringtrue

Description of transfer. Sofort/Klarna deposits are limited to 27 characters. Maximum characters are 255.

destinationAccountNumberStringtrue

Merchant’s account number to collect payment

iframeIdEntityIdfalse

Id of iframe if merchant has several iFrame with different types

brandIdStringtrue

A 3-digit ID provided by MiFinity which indicates through which brand is the call being made.

languagePreferenceStringfalse

A 2-5-character string indicating the language in which the iFrame will be initialized. Possible values are: BR,PT_BR,CN,ZH_CN,DE,DK,DA,DA_DK,EN,ES,FI,FR,GR,EL,EL_GR,HR,IT,JP,JA,JA_JP,LA,ES_LA,NL,NO,PL,PT,RU,SV,SE,SV_SE,ZH,TW,ZH_TW. If not provided, the iFrame is presented in English.

logoUrlURLfalse

The URL of the logo which will appear right underneath the iFrame's header aligned to the middle. The logo container has a maximum height of 45px so the image will be resized to fit while keeping the aspect ratio. Avoid large images to minimize the loading time.

paymentMethodStringfalse

Payment method for the iFrame to be initialized with. This parameter is mandatory for the Split Gateway feature.

SGPGPlatformUser

NameTypeRequiredDescription
dobLocalDatetrue

Date of birth. Format: YYYY-MM-DD

firstNameStringtrue

First name. Min 1 and Max 20

lastNameStringtrue

Last name. Min 1 and Max 20

phoneStringtrue

Phone number

dialingCodeStringtrue

Dialing Code

nationalityStringtrue

The ISO 2 digit country code

emailAddressStringtrue

Email address. Maximum characters are 40.

SGPGAddress

NameTypeFormatRequiredDescription
addressLine1StringMax 60 charstrue

Contains Building Name/Number

addressLine2StringMax 60 charsfalse

Contains Street

countryCodeString2 charstrue

The ISO 2 digit country code

postalCodeStringMax 15 charsfalse

Address postcode

stateStringMax 2 charsfalse

State code

cityStringMax 30 charstrue

City

Money

NameTypeRequiredDescription
amountBigDecimaltrue

The amount of Money

currencyStringtrue

Currency in ISO 4217 Format

Successful Response

NameTypeDescription
traceIdString

The trace id that was submitted with the call

initializationTokenString

Encoded iframe initialization token

clientSGPGPlatformUser

Complex object containing initial information about client

addressSGPGAddress

Complex object containing initial information about client's address

{
  "payload": [
    {
      "traceId": "traceIdutTn7_14bQWAsAARrdUeV",
      "initializationToken": "75lh4Lh_M5SCrA_k4Yse-Z_5NYk95eq6jKcovrOhoSS291nXBhv7EQAgZeBvaZ5SSaHI8aYibqSOPuWRaliSyCmp2JhWQw1PNhA0Rs0PKnti8tY-rG_k_rFpO636m0oX5yx446YyBNO0IOcvFvTHQPdGTBXQM1rFqpyk3hELFI3q0FKcIqqjzoGqjcFzuO6pSwUM1BsBxnRL6JUcVtsCm_EOlk2W_iyD0Ek_Myv-WRQxyHLxpfb_oOwVvKF8CVmhmlwBMEevnkjokQfUmiXzeUdjzjGzLTcbYzQnkoF5INCyxxzRCZSs-hJ0nLEUkFtqAALTA7Wrlh-wtcf-2Bsj75DenzDkvGUjiB_mVYlFrKHvVF8onm3WZgt3dOmD9BkdTkeVhuWUtAGa_3AnuarcmYG59NqPWyt__BjtBCErwd_i_H8dQSw0ClkOWcNzvrpUlr_tHucUMZQRERW1CzC5OF8o1-UKxYkn4TIPJIu6RxqZhe_A35RqzsgmJptuzedNMuL5uZ12y_yE-xgCidD5MdjO-_4kn2b75FdMRhIcQp5AQEfUaZWyB7J1PQiCpBzEwVZ9QZMprpAhxhrw03Ad3_PsckmqeSRAuMx8bodldaa3GjrYQZnBRauK5S2aNJEv9cvkU74t0sr4R1ITSTWG7ge4xQQYg_h2ZnA58Qeus3cp32wM7o4OreznS1gvJhnqojVyIHR3LGu-4hfMgsV93SPL4Ao-DCZAGXjSufBYzlURT9lon376fmmNvIUdjnOuniYLPf9cA1gQOx_w81TG_iUDDDo9RA2Oe3Ouj_wzd6lD2eIn8Id9FEtUZ4RA8QGCnpCPuqjeyo4XGnMHUzfOgC_aqPQuJZTevYyfvcDOVium_jS1hSpZ3lWqhTaekQO8Dqjb8pi8HTcUgd1yH02ybaeCBB-k7g_kXmNJb1o2ZfdTrOjm88uy_-GsdM2D0Md7jvZHFZEWXmZCRZXfTDgAPVO5Z7RhMM-AU7tpodEXsLHjAyHKvQwjQTI0yCFZf-2oc_k5RdO7cPqiPHyrlX530n3YufapockDQXNG41opFzjdDT5swe4wOfE7zLcFIXnyV6_535UFKqP6UOYj0LlGc4f3osp70sfR2o-67kOpgcSeTwFPWTsdfmu4llTqv813_GvLa4aQ2s_ottTF7XmaXZ5HcNugmbDpwKJ8dxbvBIDl2fYlxyLG7XXcpSx0mJYOOUQeZgIsyIm6ogf6wQd7HWe81a7ofDO8AkDbZ6T_w75jmZJR8rolPWa8nfHenHMDGbnfFTThHbffWCZpSL7fQtRLNmpeXuQlgymPDK0I_U1_c7W5drXi9UQ08pz0KTuoBuah7dkdKaBDLNa-lopTTa6_lKI-PaknpOBBiFjMfeOtUDYQ6jlqWcZkk-XU7WbtnqNAWXNi5De_mSNNo3BOJwn_JEFPr0IZz7GUdNJs7e3ra_LtERLGQB_HtPE0_nEoEvd923RXFrVrZQSQkZBBu9MB8UMr95L7Dws0IvgnDGUTk5ct6sRssY7otR0ZxcFSaa-tfyHdLyCSkK0xH3MSMPPaDM6YYaCRsDFZ8-UauyQdDeqmvSFpsEzpqtsnI2rEjXi5StMf-N_1PbUXm7gavKBYWSU_e4--BQDzmel6EJ8Rz_ovuNaCOSUEH3owHGGN9s6tUszkTsn9-5e0xYHqq6O6CsX3PagkOYtrnhhPr81mMUO5KS72u_472utM2A8ZJQYuLcZ6bd1fmA7QN1p3YGMb9bOtoN8M9VwmXX8ovwyaI8DLYjwImy2FDiSn127docOecnU1IZ5s1UQFSIpbf4lsgb_bmeQmWFdsOaOfeV8R-zZsUJ2w_jvlelK9n9688tO97Ei2tlUTM6-ptM_nRBld4YcHm9gOfx7qSH0lktvcYTQqnqB25mpj6vyj8py8rXPC_KZiFuhjOfgqX2AW45JQ4sLlk2kRdXX8SNohvGfMuENWIUVJ5jUcxOLb4s6knDp7zRuC_UE0I-Z0jxuT1k71FRw0_bAo9MHCOc9XVQ7vg92Gzj6CICzajg_Uc4NW0ZDKVXkvts2AqHrGRM146DQbu18kk9UUqC3RC33_INvWMzd2iwet9-JVEh7_y2MBl0pHM8AzZO8ROYooeEpoRLXCagtPoV3v594seHzww0I23m1H80DFhCfj24cWBgYdPtu9788WoD81-ewpAaB6LQlIyu8c33Szqo7SXnDy-3s=",
      "client": {
        "dob": "1985-10-10",
        "firstName": "John",
        "lastName": "Smith",
        "dialingCode": "353",
        "phone": "81234567890",
        "nationality": "GB",
        "emailAddress": "[email protected]"
      },
      "address": {
        "addressLine1": "Baker str 212B",
        "countryCode": "IE",
        "postalCode": "123456",
        "city": "London"
      }
    }
  ]
}

What’s Next

Generate JavaScript html code for your clients.