Skip to main content

Precheck

POST 

/financing/v1/precheck

Precheck application

Returns probability of application's approval and limits of particular customer, if known to Skip Pay

Financing typeSupported
DEFERRED_PAYMENTYES
PAY_IN_THREEYES

It has to be called with valid access token (see the Security section) from your server. If you plan to integrate it in client flow, you should implement REST endpoint bound to your shopping basket session, that will be used as a proxy to call Skip Pay API - NEVER put access token directly to client side.

Possible error codes explanation:

Status codeCodeExplanation
400INVALID_REQUESTRequest was not well formatted (malformed request syntax, size too large, etc.)
422PERSONAL_ID_INVALIDPersonalId is not valid

Request

Body

    customer

    object

    Customer data

    titleBefore stringnullable

    Possible values: <= 60 characters

    Academical degree, in front of the name.

    titleAfter stringnullable

    Possible values: <= 60 characters

    Academical degree, behind name.

    email stringrequired

    Possible values: <= 254 characters

    E-mail address of customer

    addresses

    object[]

    Addresses. All types are allowed.

  • Array [

  • name stringnullable

    Name on address

    country stringnullable

    Country. (see ISO 3166 alpha-2)

    city stringnullable

    Possible values: <= 100 characters

    City

    streetAddress stringnullable

    Possible values: <= 100 characters

    Street/city part

    streetNumber stringnullable

    Possible values: <= 50 characters

    Street number

    zip stringnullable

    Possible values: <= 30 characters

    Postal code

    addressType addressType

    Possible values: [PERMANENT, CONTACT, DELIVERY, BILLING]

    Type of the address. Only some of the types are allowed in each context.

  • ]

  • tin stringnullable

    Possible values: <= 20 characters

    Tax identification number (ICO)

    vatin stringnullable

    Possible values: <= 20 characters

    VAT identification number

    extraData

    object

    transactionsNumber numberrequired

    Historical count of customer transactions made in partner's e-shop

    cashlessTransactionsNumber number

    Historical count of customer cashless transactions made in partner's e-shop

    transactionsSum

    object

    required

    Financial amount

    amount numberrequired

    Amount in minor units (12590 represents 125,90 CZK) ISO 4217

    currency stringrequired

    Amount currency. ISO 4217 (only CZK and EUR values are allowed)

    cashlessTransactionsSum

    object

    Financial amount

    amount numberrequired

    Amount in minor units (12590 represents 125,90 CZK) ISO 4217

    currency stringrequired

    Amount currency. ISO 4217 (only CZK and EUR values are allowed)

    latestTransactionDate datenullable

    Date of customer's latest (newest) transaction on partner e-shop.

    earliestTransactionDate daterequired

    Date of customer's earliest (oldest) transaction on partner e-shop.

    pageTotalTime numbernullable

    Possible values: >= 1

    Total time spent on partners website (in seconds)

    pageReviewsTime numbernullable

    Possible values: >= 1

    Total time spent on partners website in review and comments sections (in seconds)

    cartItemsRemoved numbernullable

    Possible values: >= 1

    Total count of removed items form shopping basket during current shopping

    itemsViewed numbernullable

    Possible values: >= 1

    Number of viewed pages with products

    tags string[]nullable

    Possible values: <= 10 characters

    List of custom tags (ie. information, that customer is club member, vip customer, etc.)

    firstName string

    Possible values: <= 60 characters

    Customer first (given) name. Must be paired with lastName. Required if fullName is empty.

    lastName string

    Possible values: <= 60 characters

    Customer last (family) name. Must be paired with firstName. Required if fullName is empty.

    fullName string

    Possible values: <= 240 characters

    Customer full name, including academical degrees and salutation. Required only if firstName or lastName are empty.

    phone stringrequired

    Possible values: <= 13 characters

    Phone number with country code (including leading +).

    order

    object

    Order information for precheck validation

    number string

    Possible values: <= 100 characters

    Order number (internal for e-shop)

    variableSymbols string[]

    Variable symbols for pairing. First symbol in array is used for making the payment to your account (if not specified later in Mark order items as sent or Mark order items as delivered) or we expect you make payment on our account with this symbol (if not specified later in Mark order items as returned operation). Strings must contain only numbers, maximum length is 10 characters (digits). Leading zeros are ignored.

    totalPrice

    object

    Financial amount

    amount numberrequired

    Amount in minor units (12590 represents 125,90 CZK) ISO 4217

    currency stringrequired

    Amount currency. ISO 4217 (only CZK and EUR values are allowed)

    totalVat object[]

    Total VAT amounts split by their VAT rates

    addresses

    object[]

    Addresses. Only BILLING and DELIVERY types are allowed.

  • Array [

  • name stringnullable

    Possible values: <= 100 characters

    Name on address

    country stringrequired

    Country. (see ISO 3166 alpha-2)

    city stringrequired

    Possible values: <= 100 characters

    City

    streetAddress stringrequired

    Possible values: <= 100 characters

    Street/city part

    streetNumber stringnullable

    Possible values: <= 100 characters

    Street number

    zip stringrequired

    Possible values: <= 30 characters

    Postal code

    addressType addressTyperequired

    Possible values: [PERMANENT, CONTACT, DELIVERY, BILLING]

    Type of the address. Only some of the types are allowed in each context.

  • ]

  • deliveryType deliveryType

    Possible values: [DELIVERY_CARRIER, PERSONAL_BRANCH, PERSONAL_PARTNER, ONLINE]

    Delivery type, for DELIVERY_CARRIER type can be further specified by deliveryCarrier attribute.

    deliveryCarrier

    object

    oneOf

    carrierId carrierIdrequired

    Possible values: [AIRWAY, CZ_POST_HAND, CZ_POST_OFFICE, CZ_POST_OTHER, DACHSER, DB_SCHENKER, DEUTSCHE_POST_DHL, DHL, DHL_EXPRESS, DHL_FREIGHT, DPD, DSV, FEDEX, FOFR, GEBRUDER_WEISS, GEIS, GLS, HDS_COMFORT, HDS_STANDARD, IN_TIME, JAPO_TRANSPORT, LIFTAGO, LOCAL_COURIER, MAGYAR_POSTA, MALL_DELIVERY, MALL_DEPOSIT, MESSENGER, POSTA_BEZ_HRANIC, PPL, PPL_PARCEL_CONNECT, RABEN, SAMEDAY, SDS, SLOVAK_PARCEL_SERVICE, SLOVENSKA_POSTA, SPRING_GDS, TNT, TOP_TRANS, UPS, WEDO, WEDO_ULOZENKA, ZASILKOVNA]

    reservationDate datetimenullable

    Date and time until order is reserved.

    Until 'reservationDate' Skip Pay will try to notify partner with Application notification about approval or rejection.

    After this date and time, e-shop does not guarantee items availability (if application processing is longer, it may endanger order fullfillment).

    items

    object[]

    Order items

  • Array [

  • code stringnullable

    Possible values: <= 200 characters

    Internal code for item (internal to e-shop). Used to better identify the item for future changes

    ean stringnullable

    Possible values: <= 64 characters

    EAN code

    name stringnullable

    Possible values: <= 255 characters

    Item name

    type Item Typenullable

    Possible values: [PHYSICAL, DISCOUNT, SHIPPING_FEE, SALES_TAX, DIGITAL, GIFT_CARD, STORE_CREDIT, FEE, INSURANCE]

    Item type

    variant stringnullable

    Possible values: <= 250 characters

    Item variant

    description stringnullable
    producer stringnullable

    Possible values: <= 250 characters

    Producer name

    categories string[]nullable

    List of item categories

    totalPrice

    object

    Financial amount

    amount numberrequired

    Amount in minor units (12590 represents 125,90 CZK) ISO 4217

    currency stringrequired

    Amount currency. ISO 4217 (only CZK and EUR values are allowed)

    totalVat

    object

    Financial amount

    amount numberrequired

    Amount in minor units (12590 represents 125,90 CZK) ISO 4217

    currency stringrequired

    Amount currency. ISO 4217 (only CZK and EUR values are allowed)

    vatRate numberrequired

    VAT rate as positive number (ie. 15 represents 15% rate). 0 is allowed.

    productUrl urlnullable

    Possible values: <= 200 characters

    URL of the item in e-shop

    unitPrice

    object

    Financial amount

    amount numberrequired

    Amount in minor units (12590 represents 125,90 CZK) ISO 4217

    currency stringrequired

    Amount currency. ISO 4217 (only CZK and EUR values are allowed)

    unitVat

    object

    Financial amount

    amount numberrequired

    Amount in minor units (12590 represents 125,90 CZK) ISO 4217

    currency stringrequired

    Amount currency. ISO 4217 (only CZK and EUR values are allowed)

    vatRate numberrequired

    VAT rate as positive number (ie. 15 represents 15% rate). 0 is allowed.

    quantity number

    (positive float/decimal up to 3 decimal places) Item quantity. If empty, considered as 1.

  • ]

  • merchantId string

    Merchant identification (ie. in case of multiple e-shops managed by one credentials)

    type Financing Type 2

    Possible values: [DEFERRED_PAYMENT, PAY_IN_THREE]

    Financing type, if type is not sent DEFERRED_PAYMENT is selected.

Responses

Probability of approval

Schema

    id stringrequired

    Unique identificator of precheck. Send this identificator in ApplicationRequest for better approval rate.

    results

    object[]

    required

    Precheck results for each type of product.

  • Array [

  • type Precheck Typerequired

    Possible values: [DEFERRED_PAYMENT, PAY_IN_THREE]

    Precheck result type for Funding type.

    recommendation booleanrequired

    A recommendation of whether the order should be passed to the Skip Pay.

    true = Application is going to be likely approved. false = Application is going to be likely rejected.

    probabilityOfApproval numberrequired

    Probability of approval.

    0 = 0% to be approved 1 = 100% to be approved

    Partner can create custom logic not to follow the recommendation (be more strict or benevolent).

    completeness number

    Completness of the result. <0, 1> The lower is the value, the lower accuracy of the result.

    code codenullablerequired

    Possible values: [OK, UNKNOWN, NOT_AVAILABLE, ADDITIONAL_DATA_SECURITY, ADDITIONAL_DATA_LIMIT, INSUFFICIENT_LIMIT, INSUFFICIENT_LIMIT_OPPORTUNITY, DETAILS_NOT_MATCHING, MANUAL_VERIFICATION]

    Result code.

    PrecheckResultResponseSerializer PrecheckResultResponseSerializerrequired

    Possible values: [UNKNOWN, FIRST_ORDER, FULL, BLOCKED]

    Customer type.

    message string

    Custom message for customer.

    Examples: “V Skip Pay peněžence nemáte dostatečný limit.” “Uveďte do objednávky jméno a příjmení, které používáte ve službě Skip Pay.” etc.

    additionalData string[]

    List of additional data that customer has to send.

    Possible values in array: PERSONAL_ID, ID_CARD_NO, ID_CARD_EXPIRY_DATE, ID_CARD_SCAN, THIRD_PARTY_TELCO_CONSENT.

  • ]

  • limits

    object

    Customer's limits

    availableLimit

    object

    required

    Financial amount

    amount numberrequired

    Amount in minor units (12590 represents 125,90 CZK) ISO 4217

    currency stringrequired

    Amount currency. ISO 4217 (only CZK and EUR values are allowed)

    totalLimit

    object

    required

    Financial amount

    amount numberrequired

    Amount in minor units (12590 represents 125,90 CZK) ISO 4217

    currency stringrequired

    Amount currency. ISO 4217 (only CZK and EUR values are allowed)

Loading...