returnUrl

URL

true

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

errorUrl

URL

false

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.

validationKey

String

true

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.

client

SGPGPlatformUser

true

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

clientReference

String

true

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

address

SGPGAddress

true

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

traceId

String

true

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

money

Money

true

Complex Money object containing transfer amount and currency

description

String

true

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

destinationAccountNumber

String

true

Merchant’s account number to collect payment

iframeId

EntityId

false

Id of iframe if merchant has several iFrame with different types

brandId

String

true

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

languagePreference

String

false

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.

logoUrl

URL

false

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.

paymentMethod

String

false

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

dob

LocalDate

true

Date of birth. Format: YYYY-MM-DD

firstName

String

true

First name. Min 1 and Max 20

lastName

String

true

Last name. Min 1 and Max 20

phone

String

true

Phone number

dialingCode

String

true

Dialing Code

nationality

String

true

The ISO 2 digit country code

emailAddress

String

true

Email address. Maximum characters are 40.

addressLine1

String

Max 40 chars

true

Contains Building Name/Number

addressLine2

String

Max 40 chars

false

Contains Street

countryCode

String

2 chars

true

The ISO 2 digit country code

postalCode

String

Max 15 chars

false

Address postcode

state

String

Max 2 chars

false

State code

city

String

Max 30 chars

true

City

amount

BigDecimal

true

The amount of Money

currency

String

true

Currency in ISO 4217 Format

traceId

String

The trace id that was submitted with the call

initializationToken

String

Encoded iframe initialization token

client

SGPGPlatformUser

Complex object containing initial information about client

address

SGPGAddress

Complex object containing initial information about client's address