Create application
POST/financing/v1/applications
Elementary flow starts when customer wants to use one of Skip Pay's payment method for financing his purchase made in partner e-shop.
| Financing type | Supported |
|---|---|
DEFERRED_PAYMENT | YES |
PAY_IN_THREE | YES |
Use /financing/v1/applications resource with properly filled request that contains at least following data
-
Customer information
- Name (first name and last name - if possible, otherwise full name)
- Phone number
-
Order details
- Number
- Total Price (including VAT)
- Total VAT (array of total amounts split by VAT rates)
- Order items (array, at least one item is required)
- Code
- Order item name
- Total price (all pieces, including VAT)
- Total VAT
-
Additional information necessary for the continuation and completion of the process
- Your URL where the customer should be redirected after application approval
- Your URL where the customer should be redirected after application rejection
- URL of your notification endpoint you want us to send you notifications about particular application updates
For best customer experience request should contain following data:
-
Customer information
- Extra data
- Historical count of customer's transactions made in partner's e-shop
- Extra data
-
Order details
- Delivery carrier information
- Address (type BILLING)
- Country
- City
- Street
- Street number
- ZIP
- Address type
- Order items
- Image
-
Personal data processing and terms and conditions agreement
If the request was successfully processed, you receive HTTP status code 201 and application object with following important information in the response:
-
Application unique ID
-
Application state
-
Application substate
-
Gateway redirect URL where you should redirect a customer after processing of the response
-
Recurrence ID if you sent
isRecurring=truein request (for recurring orders)
If the request was recognized as duplication, you receive HTTP status code 200 and the application object created during the first related successful request.
Note: If the optional agreementTermsAndConditions field was not sent with the request (or it was sent with a value of false), the application will be created with agreementTermsAndConditions value set to false, state PROCESSING and stateReason PROCESSING_REDIRECT_NEEDED.
In other cases, you may receive errors similar to the following ones:
| Status code | Code | Explanation |
|---|---|---|
| 400 | INVALID_REQUEST | Request was not well formatted (malformed request syntax, size too large, etc.) |
| 422 | UNPROCESSABLE | Request was well-formed but was unable to be followed due to semantic errors |
Request
- application/json
Body
Array [
]
Array [
]
- DeliveryCarrierPredefined
- DeliveryCarrierCustom
Array [
- MOD1
- MOD2
]
Array [
- MOD1
- MOD2
]
Array [
]
order
object
required
Order information, needed to create an application.
Possible values: <= 100 characters
Order number (internal for e-shop)
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.
totalVat
object[]
required
Total VAT amounts split by their VAT rates.
Amount in minor units (12590 represents 125,90 CZK) ISO 4217
Amount currency. ISO 4217 (only CZK and EUR values are allowed)
VAT rate as positive number (ie. 15 represents 15% rate). 0 is allowed.
addresses
object[]
Addresses. Only BILLING and DELIVERY types are allowed.
Possible values: <= 100 characters
Name on address
Country. (see ISO 3166 alpha-2)
Possible values: <= 100 characters
City
Possible values: <= 100 characters
Street/city part
Possible values: <= 100 characters
Street number
Possible values: <= 30 characters
Postal code
Possible values: [PERMANENT, CONTACT, DELIVERY, BILLING]
Type of the address. Only some of the types are allowed in each context.
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
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]
Possible values: <= 250
For carriers not found in the enumeration of carrierId, specify the value as text.
Possible values: [ESHOP, BRANCH, FRANCHISE, TELEPHONE, INTERNAL]
Default value: ESHOP
Sales channel, indicates how or where the order is created. (ie. via e-mail, eshop or at a branch)
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).
documents
object[]
Attached documents (invoices etc.)
Possible values: [INVOICE, PROFORMA_INVOICE, CREDIT_NOTE, OTHER]
Type of the document
file
object
required
oneOf
string
string
File description
extraData
object
Variable symbol of this document (proforma, invoice, ...). This string must contain only numbers, maximum length is 10 characters (digits). Leading zeros are ignored.
items
object[]
required
Order items
Possible values: <= 200 characters
Internal code for item (internal to e-shop). Used to better identify the item for future changes
Possible values: <= 64 characters
EAN code.
Possible values: <= 255 characters
Item name
Possible values: [PHYSICAL, DISCOUNT, SHIPPING_FEE, SALES_TAX, DIGITAL, GIFT_CARD, STORE_CREDIT, FEE, INSURANCE]
Item type
Possible values: <= 250 characters
Item variant
Possible values: <= 250 characters
Producer name
List of item categories
totalVat
object
required
Possible values: <= 200 characters
URL of the item in e-shop
image
object
oneOf
string
string
unitVat
object
Possible values: >= 1
(positive float/decimal up to 3 decimal places) Item quantity. If empty, considered as 1.
Merchant identification (ie. in case of multiple e-shops managed by one credentials)
Possible values: [DEFERRED_PAYMENT, PAY_IN_THREE]
Financing type
Terms and conditions agreement
Array of all precheck ids related to this application. See Precheck operation and it's response (PrecheckResultsResponse).
merchantUrls
object
required
Collection of URLs used for redirection of a customer back to a partner website or as a notification endpoint. Services that should be developed and exposed by partner e-shops to allow Skip Pay to asynchronously inform these partners about important changes regarding particular applications and orders.
Possible values: <= 512 characters
URL of the partner used for redirection of the customer back to partner website (from Skip Pay gateway) after application approval. Do not implement any business logic on accessing this URL by customer. Implement business logic to READY notification via notificationEndpoint.
Possible values: <= 512 characters
URL of the partner used for redirection of the customer back to partner website (from Skip Pay gateway) after application rejection. Do not implement any business logic on accessing this URL by customer. Implement business logic to REJECTED notification via notificationEndpoint.
Possible values: <= 512 characters
URL of the partner used as a notification endpoint for obtaining important updates about application (approval, rejection, storno, etc.).
Possible values: <= 512 characters
URL of the partner used as a notification endpoint for obtaining information about payments connected with application.
customer
object
required
Customer data
Possible values: <= 60 characters
Academical degree, in front of the name
Possible values: <= 60 characters
Academical degree, behind name
Possible values: <= 254 characters
E-mail address of customer
addresses
object[]
Addresses. All types are allowed.
Possible values: <= 100 characters
Name on address
Country. (see ISO 3166 alpha-2)
Possible values: <= 100 characters
City
Possible values: <= 100 characters
Street/city part
Possible values: <= 100 characters
Street number
Possible values: <= 30 characters
Postal code
Possible values: [PERMANENT, CONTACT, DELIVERY, BILLING]
Type of the address. Only some of the types are allowed in each context.
Possible values: <= 20 characters
Tax identification number (ICO)
Possible values: <= 20 characters
VAT identification number
extraData
object
required
Historical count of customer transactions made in partner's e-shop
Historical count of customer cashless transactions made in partner's e-shop
Date of customer's latest (newest) transaction on partner e-shop.
Date of customer's earliest (oldest) transaction on partner e-shop.
Possible values: >= 1
Total time spent on partners website (in seconds)
Possible values: >= 1
Total time spent on partners website in review and comments sections (in seconds)
Possible values: >= 1
Total count of removed items form shopping basket during current shopping
Possible values: >= 1
Number of viewed pages with products
Possible values: <= 10 characters
List of custom tags (ie. information, that customer is club member, vip customer, etc.)
Possible values: <= 60 characters
Customer first (given) name. Must be paired with lastName. Required if fullName is empty.
Possible values: <= 60 characters
Customer last (family) name. Must be paired with firstName. Required if fullName is empty.
Possible values: <= 240 characters
Customer full name, including academical degrees and salutation. Required only if firstName or lastName are empty.
Possible values: <= 13 characters
Phone number with country code (including leading +). Phone number is by default required if you are not able to send it contact us.
Default value: false
Ensures recurrence ID in reponse. Default is false
Responses
- 200
- 201
- 400
Application data is duplicate. Existing application is returned.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Array [
]
- DeliveryCarrierPredefined
- DeliveryCarrierCustom
Array [
]
Array [
]
Unique identifier in Skip Pay
Possible values: [PROCESSING, READY, REJECTED, CANCELLED]
Application state.
Possible values: [PROCESSING_REDIRECT_NEEDED, PROCESSING_PREAPPROVED, PROCESSING_VALIDATION_IN_PROGRESS, REJECTED, CANCELLED_NOT_PAID, READY_TO_SHIP, READY_SHIPPED, READY_DELIVERED, READY_PAID, CANCELLED_RETURNED]
Describes internal state of application, e.g. when state is PROCESSING - reason why application remains in processing state
customer
object
required
Customer data
Possible values: <= 60 characters
Academical degree, in front of the name
Possible values: <= 60 characters
Academical degree, behind name
Possible values: <= 254 characters
E-mail address of customer
addresses
object[]
Addresses. All types are allowed.
Possible values: <= 100 characters
Name on address
Country. (see ISO 3166 alpha-2)
Possible values: <= 100 characters
City
Possible values: <= 100 characters
Street/city part
Possible values: <= 100 characters
Street number
Possible values: <= 30 characters
Postal code
Possible values: [PERMANENT, CONTACT, DELIVERY, BILLING]
Type of the address. Only some of the types are allowed in each context.
Possible values: <= 20 characters
Tax identification number (ICO)
Possible values: <= 20 characters
VAT identification number
extraData
object
required
Historical count of customer transactions made in partner's e-shop
Historical count of customer cashless transactions made in partner's e-shop
Date of customer's latest (newest) transaction on partner e-shop.
Date of customer's earliest (oldest) transaction on partner e-shop.
Possible values: >= 1
Total time spent on partners website (in seconds)
Possible values: >= 1
Total time spent on partners website in review and comments sections (in seconds)
Possible values: >= 1
Total count of removed items form shopping basket during current shopping
Possible values: >= 1
Number of viewed pages with products
Possible values: <= 10 characters
List of custom tags (ie. information, that customer is club member, vip customer, etc.)
Possible values: <= 60 characters
Customer first (given) name. Must be paired with lastName. Required if fullName is empty.
Possible values: <= 60 characters
Customer last (family) name. Must be paired with firstName. Required if fullName is empty.
Possible values: <= 240 characters
Customer full name, including academical degrees and salutation. Required only if firstName or lastName are empty.
Possible values: <= 13 characters
Phone number with country code (including leading +).
Possible values: [UNKNOWN, FIRST_ORDER, FULL, BLOCKED]
Customer type.
order
object
required
Order information, needed to create an application.
Possible values: <= 100 characters
Order number (internal for e-shop)
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.
totalVat
object[]
required
Total VAT amounts split by their VAT rates.
Amount in minor units (12590 represents 125,90 CZK) ISO 4217
Amount currency. ISO 4217 (only CZK and EUR values are allowed)
VAT rate as positive number (ie. 15 represents 15% rate). 0 is allowed.
addresses
object[]
Addresses. Only BILLING and DELIVERY types are allowed.
Possible values: <= 100 characters
Name on address
Country. (see ISO 3166 alpha-2)
Possible values: <= 100 characters
City
Possible values: <= 100 characters
Street/city part
Possible values: <= 100 characters
Street number
Possible values: <= 30 characters
Postal code
Possible values: [PERMANENT, CONTACT, DELIVERY, BILLING]
Type of the address. Only some of the types are allowed in each context.
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
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]
Possible values: <= 250
For carriers not found in the enumeration of carrierId, specify the value as text.
Possible values: [ESHOP, BRANCH, FRANCHISE, TELEPHONE, INTERNAL]
Default value: ESHOP
Sales channel, indicates how or where the order is created. (ie. via e-mail, eshop or at a branch)
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).
Possible values: [PROCESSING, SENT, DELIVERED, RETURNED, CANCELLED]
Order state.
Date and time of delivery
Possible values: <= 64 characters
Delivery tracking number
Date and time of order shipping
documents
object[]
Attached documents (invoices etc.)
Possible values: [INVOICE, PROFORMA_INVOICE, CREDIT_NOTE, OTHER]
Type of the document
file
object
required
Possible values: <= 100 characters
File name.
File URL (URL is accessible only 1 hour from its generation for security reasons)
File description
extraData
object
Variable symbol of this document (proforma, invoice, ...). This string must contain only numbers, maximum length is 10 characters (digits). Leading zeros are ignored.
items
object[]
required
Order items
Possible values: <= 200 characters
Internal code for item (internal to e-shop). Used to better identify the item for future changes
Possible values: <= 64 characters
EAN code.
Possible values: <= 255 characters
Item name
Possible values: [PHYSICAL, DISCOUNT, SHIPPING_FEE, SALES_TAX, DIGITAL, GIFT_CARD, STORE_CREDIT, FEE, INSURANCE]
Item type
Possible values: <= 250 characters
Item variant
Possible values: <= 250 characters
Producer name
List of item categories
totalVat
object
required
Possible values: <= 200 characters
URL of the item in e-shop
Possible values: [PROCESSING, SENT, DELIVERED, RETURNED, CANCELLED]
Order state.
Date when item was sent. Only when the whole order was NOT sent at once.
Date when item was delivered. Only when the whole order was NOT sent at once.
Possible values: <= 64 characters
Tracking number for the item. Only when the whole order was NOT sent at once.
image
object
Possible values: <= 100 characters
File name.
File URL.
unitVat
object
required
Possible values: >= 1
(positive float/decimal up to 3 decimal places) Item quantity.
Merchant identification
Possible values: [DEFERRED_PAYMENT, PAY_IN_THREE]
Financing type
Terms and conditions agreement
Gateway redirect URL. Redirect user to this URL if state is PROCESSING and stateReason is PROCESSING_REDIRECT_NEEDED.
recurrence
object
Unique identifier in Skip Pay
Possible values: [APPROVING, READY, CANCELLED, EXPIRED]
Recurrence state
{
"id": "11200a0ee1",
"state": "PROCESSING",
"stateReason": "PROCESSING_REDIRECT_NEEDED",
"customer": {
"titleBefore": "Ing.",
"titleAfter": "CSc.",
"email": "john.newborn@country.com",
"addresses": [
{
"name": "John Doe",
"country": "CZ",
"city": "Prague",
"streetAddress": "Letenská",
"streetNumber": "22",
"zip": "140 00",
"addressType": "PERMANENT"
}
],
"tin": "12333321",
"vatin": "CZ8402154456",
"extraData": {
"transactionsNumber": 10,
"cashlessTransactionsNumber": 5,
"transactionsSum": {
"amount": 12590,
"currency": "CZK"
},
"cashlessTransactionsSum": {
"amount": 12590,
"currency": "CZK"
},
"latestTransactionDate": "2024-05-15",
"earliestTransactionDate": "2015-10-12",
"pageTotalTime": 250,
"pageReviewsTime": 100,
"cartItemsRemoved": 2,
"itemsViewed": 10,
"tags": [
"string"
]
},
"firstName": "John",
"lastName": "Newborn",
"fullName": "Ing. John Newborn, Csc.",
"phone": "+420123456789",
"PrecheckResultResponseSerializer": "UNKNOWN"
},
"order": {
"number": "AA234",
"variableSymbols": [
"string"
],
"totalPrice": {
"amount": 12590,
"currency": "CZK"
},
"totalVat": [
{
"amount": 12590,
"currency": "CZK",
"vatRate": 15
}
],
"addresses": [
{
"name": "John Doe",
"country": "CZ",
"city": "Prague",
"streetAddress": "Letenská",
"streetNumber": "22",
"zip": "140 00",
"addressType": "PERMANENT"
}
],
"deliveryType": "DELIVERY_CARRIER",
"deliveryCarrier": {
"carrierId": "DPD"
},
"channel": "BRANCH",
"reservationDate": "2017-07-15T00:00:00+02:00",
"state": "PROCESSING",
"deliveryDate": "2017-01-17",
"deliveryTrackingNumber": "EX12221",
"sentDate": "2017-01-12",
"documents": [
{
"type": "INVOICE",
"file": {
"filename": "invoice.pdf",
"url": "https://www.partner.com/file?id=12345"
},
"description": "This is an invoice",
"extraData": {
"variableSymbol": "1234567890"
}
}
],
"items": [
{
"code": "EXC4677-1a",
"ean": "888462064002",
"name": "iPhone 6s 32GB SpaceGray",
"type": "PHYSICAL",
"variant": "32GB SpaceGray",
"description": "Mobile phone with 32GB of RAM",
"producer": "Apple",
"categories": [
"string"
],
"totalPrice": {
"amount": 12590,
"currency": "CZK"
},
"totalVat": {
"amount": 12590,
"currency": "CZK",
"vatRate": 15
},
"productUrl": "https://www.example.com",
"state": "PROCESSING",
"sentDate": "2017-01-10",
"deliveryDate": "2017-01-12",
"deliveryTrackingNumber": "EX21121",
"image": {
"filename": "invoice.pdf",
"url": "https://www.partner.com/file?id=12345"
},
"unitPrice": {
"amount": 12590,
"currency": "CZK"
},
"unitVat": {
"amount": 12590,
"currency": "CZK",
"vatRate": 15
},
"quantity": 1
}
],
"merchantId": "ABCD1234"
},
"type": "PAY_IN_THREE",
"agreementTermsAndConditions": true,
"gatewayRedirectUrl": "http://myredirectURL.com",
"recurrence": {
"id": "abcd1234",
"state": "APPROVING"
}
}
Application was created
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Array [
]
- DeliveryCarrierPredefined
- DeliveryCarrierCustom
Array [
]
Array [
]
Unique identifier in Skip Pay
Possible values: [PROCESSING, READY, REJECTED, CANCELLED]
Application state.
Possible values: [PROCESSING_REDIRECT_NEEDED, PROCESSING_PREAPPROVED, PROCESSING_VALIDATION_IN_PROGRESS, REJECTED, CANCELLED_NOT_PAID, READY_TO_SHIP, READY_SHIPPED, READY_DELIVERED, READY_PAID, CANCELLED_RETURNED]
Describes internal state of application, e.g. when state is PROCESSING - reason why application remains in processing state
customer
object
required
Customer data
Possible values: <= 60 characters
Academical degree, in front of the name
Possible values: <= 60 characters
Academical degree, behind name
Possible values: <= 254 characters
E-mail address of customer
addresses
object[]
Addresses. All types are allowed.
Possible values: <= 100 characters
Name on address
Country. (see ISO 3166 alpha-2)
Possible values: <= 100 characters
City
Possible values: <= 100 characters
Street/city part
Possible values: <= 100 characters
Street number
Possible values: <= 30 characters
Postal code
Possible values: [PERMANENT, CONTACT, DELIVERY, BILLING]
Type of the address. Only some of the types are allowed in each context.
Possible values: <= 20 characters
Tax identification number (ICO)
Possible values: <= 20 characters
VAT identification number
extraData
object
required
Historical count of customer transactions made in partner's e-shop
Historical count of customer cashless transactions made in partner's e-shop
Date of customer's latest (newest) transaction on partner e-shop.
Date of customer's earliest (oldest) transaction on partner e-shop.
Possible values: >= 1
Total time spent on partners website (in seconds)
Possible values: >= 1
Total time spent on partners website in review and comments sections (in seconds)
Possible values: >= 1
Total count of removed items form shopping basket during current shopping
Possible values: >= 1
Number of viewed pages with products
Possible values: <= 10 characters
List of custom tags (ie. information, that customer is club member, vip customer, etc.)
Possible values: <= 60 characters
Customer first (given) name. Must be paired with lastName. Required if fullName is empty.
Possible values: <= 60 characters
Customer last (family) name. Must be paired with firstName. Required if fullName is empty.
Possible values: <= 240 characters
Customer full name, including academical degrees and salutation. Required only if firstName or lastName are empty.
Possible values: <= 13 characters
Phone number with country code (including leading +).
Possible values: [UNKNOWN, FIRST_ORDER, FULL, BLOCKED]
Customer type.
order
object
required
Order information, needed to create an application.
Possible values: <= 100 characters
Order number (internal for e-shop)
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.
totalVat
object[]
required
Total VAT amounts split by their VAT rates.
Amount in minor units (12590 represents 125,90 CZK) ISO 4217
Amount currency. ISO 4217 (only CZK and EUR values are allowed)
VAT rate as positive number (ie. 15 represents 15% rate). 0 is allowed.
addresses
object[]
Addresses. Only BILLING and DELIVERY types are allowed.
Possible values: <= 100 characters
Name on address
Country. (see ISO 3166 alpha-2)
Possible values: <= 100 characters
City
Possible values: <= 100 characters
Street/city part
Possible values: <= 100 characters
Street number
Possible values: <= 30 characters
Postal code
Possible values: [PERMANENT, CONTACT, DELIVERY, BILLING]
Type of the address. Only some of the types are allowed in each context.
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
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]
Possible values: <= 250
For carriers not found in the enumeration of carrierId, specify the value as text.
Possible values: [ESHOP, BRANCH, FRANCHISE, TELEPHONE, INTERNAL]
Default value: ESHOP
Sales channel, indicates how or where the order is created. (ie. via e-mail, eshop or at a branch)
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).
Possible values: [PROCESSING, SENT, DELIVERED, RETURNED, CANCELLED]
Order state.
Date and time of delivery
Possible values: <= 64 characters
Delivery tracking number
Date and time of order shipping
documents
object[]
Attached documents (invoices etc.)
Possible values: [INVOICE, PROFORMA_INVOICE, CREDIT_NOTE, OTHER]
Type of the document
file
object
required
Possible values: <= 100 characters
File name.
File URL (URL is accessible only 1 hour from its generation for security reasons)
File description
extraData
object
Variable symbol of this document (proforma, invoice, ...). This string must contain only numbers, maximum length is 10 characters (digits). Leading zeros are ignored.
items
object[]
required
Order items
Possible values: <= 200 characters
Internal code for item (internal to e-shop). Used to better identify the item for future changes
Possible values: <= 64 characters
EAN code.
Possible values: <= 255 characters
Item name
Possible values: [PHYSICAL, DISCOUNT, SHIPPING_FEE, SALES_TAX, DIGITAL, GIFT_CARD, STORE_CREDIT, FEE, INSURANCE]
Item type
Possible values: <= 250 characters
Item variant
Possible values: <= 250 characters
Producer name
List of item categories
totalVat
object
required
Possible values: <= 200 characters
URL of the item in e-shop
Possible values: [PROCESSING, SENT, DELIVERED, RETURNED, CANCELLED]
Order state.
Date when item was sent. Only when the whole order was NOT sent at once.
Date when item was delivered. Only when the whole order was NOT sent at once.
Possible values: <= 64 characters
Tracking number for the item. Only when the whole order was NOT sent at once.
image
object
Possible values: <= 100 characters
File name.
File URL.
unitVat
object
required
Possible values: >= 1
(positive float/decimal up to 3 decimal places) Item quantity.
Merchant identification
Possible values: [DEFERRED_PAYMENT, PAY_IN_THREE]
Financing type
Terms and conditions agreement
Gateway redirect URL. Redirect user to this URL if state is PROCESSING and stateReason is PROCESSING_REDIRECT_NEEDED.
recurrence
object
Unique identifier in Skip Pay
Possible values: [APPROVING, READY, CANCELLED, EXPIRED]
Recurrence state
{
"id": "11200a0ee1",
"state": "PROCESSING",
"stateReason": "PROCESSING_REDIRECT_NEEDED",
"customer": {
"titleBefore": "Ing.",
"titleAfter": "CSc.",
"email": "john.newborn@country.com",
"addresses": [
{
"name": "John Doe",
"country": "CZ",
"city": "Prague",
"streetAddress": "Letenská",
"streetNumber": "22",
"zip": "140 00",
"addressType": "PERMANENT"
}
],
"tin": "12333321",
"vatin": "CZ8402154456",
"extraData": {
"transactionsNumber": 10,
"cashlessTransactionsNumber": 5,
"transactionsSum": {
"amount": 12590,
"currency": "CZK"
},
"cashlessTransactionsSum": {
"amount": 12590,
"currency": "CZK"
},
"latestTransactionDate": "2024-05-15",
"earliestTransactionDate": "2015-10-12",
"pageTotalTime": 250,
"pageReviewsTime": 100,
"cartItemsRemoved": 2,
"itemsViewed": 10,
"tags": [
"string"
]
},
"firstName": "John",
"lastName": "Newborn",
"fullName": "Ing. John Newborn, Csc.",
"phone": "+420123456789",
"PrecheckResultResponseSerializer": "UNKNOWN"
},
"order": {
"number": "AA234",
"variableSymbols": [
"string"
],
"totalPrice": {
"amount": 12590,
"currency": "CZK"
},
"totalVat": [
{
"amount": 12590,
"currency": "CZK",
"vatRate": 15
}
],
"addresses": [
{
"name": "John Doe",
"country": "CZ",
"city": "Prague",
"streetAddress": "Letenská",
"streetNumber": "22",
"zip": "140 00",
"addressType": "PERMANENT"
}
],
"deliveryType": "DELIVERY_CARRIER",
"deliveryCarrier": {
"carrierId": "DPD"
},
"channel": "BRANCH",
"reservationDate": "2017-07-15T00:00:00+02:00",
"state": "PROCESSING",
"deliveryDate": "2017-01-17",
"deliveryTrackingNumber": "EX12221",
"sentDate": "2017-01-12",
"documents": [
{
"type": "INVOICE",
"file": {
"filename": "invoice.pdf",
"url": "https://www.partner.com/file?id=12345"
},
"description": "This is an invoice",
"extraData": {
"variableSymbol": "1234567890"
}
}
],
"items": [
{
"code": "EXC4677-1a",
"ean": "888462064002",
"name": "iPhone 6s 32GB SpaceGray",
"type": "PHYSICAL",
"variant": "32GB SpaceGray",
"description": "Mobile phone with 32GB of RAM",
"producer": "Apple",
"categories": [
"string"
],
"totalPrice": {
"amount": 12590,
"currency": "CZK"
},
"totalVat": {
"amount": 12590,
"currency": "CZK",
"vatRate": 15
},
"productUrl": "https://www.example.com",
"state": "PROCESSING",
"sentDate": "2017-01-10",
"deliveryDate": "2017-01-12",
"deliveryTrackingNumber": "EX21121",
"image": {
"filename": "invoice.pdf",
"url": "https://www.partner.com/file?id=12345"
},
"unitPrice": {
"amount": 12590,
"currency": "CZK"
},
"unitVat": {
"amount": 12590,
"currency": "CZK",
"vatRate": 15
},
"quantity": 1
}
],
"merchantId": "ABCD1234"
},
"type": "PAY_IN_THREE",
"agreementTermsAndConditions": true,
"gatewayRedirectUrl": "http://myredirectURL.com",
"recurrence": {
"id": "abcd1234",
"state": "APPROVING"
}
}
There was an error processing request
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
object[]
required
Array with errors
Unique internal error code
Human readable error description (non-localized)
Possible values: [ERROR, WARN, INFO]
JSON path of request attribute that caused the error (if applicable)
Internal ticket ID, used for error backtracking
{
"errors": [
{
"code": "ERR_1000_SOME_ERROR_CODE",
"message": "Some error/validation message description",
"severity": "ERROR",
"attribute": "personalBirthNumber",
"ticketId": "UAT1:AMS:20160516-091658.450:45e4"
}
]
}