API docs by Redocly

Aptic API Gateway - Checkout (v1.0)

Download OpenAPI specification:Download

Aptic AB: api@aptic.net URL: https://www.aptic.net Terms of Service

Checkout related API for Aptic solutions

Checkout

Activate a reservation

Authorizations:
(oauth2apikey)
Request Body schema:
object (SenderType)

The Sender object is used to identify the sender of the call.

object (ReservationLookupType)

Identify an reservation

object (CustomerType)

Customer data

object (OrderType)

Order data

externalReference
string or null

External reference number.

limit
number or null <double>

Limit of customer.

object (StoreType)

Information about a store

Array of objects or null (DataProvisionType)

Data provisions, GDPR consents

seller
string or null

Seller

object (ClaimantType)

Information about an external claimant.

Responses

Request samples

Content type
{
  • "sender": {
    },
  • "reservationLookup": {
    },
  • "customer": {
    },
  • "order": {
    },
  • "externalReference": "string",
  • "limit": 0,
  • "store": {
    },
  • "dataProvisions": [
    ],
  • "seller": "string",
  • "claimant": {
    }
}

Response samples

Content type
{
  • "result": {
    },
  • "invoiceNumber": "string",
  • "accountPaymentReference": "string",
  • "externalReference": "string"
}

Add items to an invoice. If the quantity or amounts are negative the line will be treated as a credit of the line.

Authorizations:
(oauth2apikey)
Request Body schema:
object (SenderType)

The Sender object is used to identify the sender of the call.

object (ActivationLookupType)

The ActivationLookupType is used to identify an activation/invoice

currencyCode
string or null

Currency code, ISO 4217, 3 capital letters. Example: USD; EUR, SEK, NOK, DKK.

Array of objects or null (OrderLineType)

Order lines to add or subtract

Responses

Request samples

Content type
{
  • "sender": {
    },
  • "activationLookup": {
    },
  • "currencyCode": "string",
  • "additionalOrderLines": [
    ]
}

Response samples

Content type
{
  • "resultCode": 0,
  • "internalErrorDescription": "string",
  • "userFriendlyMessage": "string"
}

Alter/update a reservation

Authorizations:
(oauth2apikey)
Request Body schema:
object (SenderType)

The Sender object is used to identify the sender of the call.

object (ReservationLookupType)

Identify an reservation

object (AlterCustomerType)

Customer information

object (OrderType)

Order data

orderNumber
string or null

Order number

object (AdditionalCustomerApprovalType)

Customer approval data, usual from some kind of signing process

object (StoreType)

Information about a store

Array of objects or null (DataProvisionType)

Data provisions, GDPR consents

seller
string or null

Seller

object (ClaimantType)

Information about an external claimant.

Responses

Request samples

Content type
{
  • "sender": {
    },
  • "reservationLookup": {
    },
  • "customer": {
    },
  • "order": {
    },
  • "orderNumber": "string",
  • "additionalCustomerApproval": {
    },
  • "store": {
    },
  • "dataProvisions": [
    ],
  • "seller": "string",
  • "claimant": {
    }
}

Response samples

Content type
{
  • "result": {
    },
  • "reservationNumber": 0,
  • "additionalCustomerApprovalCode": "string",
  • "reservationStatus": 0,
  • "limit": 0
}

Cancel a reservation that has not been activated.

Authorizations:
(oauth2apikey)
Request Body schema:
object (SenderType)

The Sender object is used to identify the sender of the call.

object (ReservationLookupType)

Identify an reservation

Array of objects or null (OrderLineCancelType)

Cancel just specific order lines, not the whole reservation. If null the whole order will be canceled.

Responses

Request samples

Content type
{
  • "sender": {
    },
  • "reservationLookup": {
    },
  • "cancelOrderLines": [
    ]
}

Response samples

Content type
{
  • "resultCode": 0,
  • "internalErrorDescription": "string",
  • "userFriendlyMessage": "string"
}

Gets payment reference number for an activation/invoice.

Authorizations:
(oauth2apikey)
Request Body schema:
object (SenderType)

The Sender object is used to identify the sender of the call.

object (ActivationLookupType)

The ActivationLookupType is used to identify an activation/invoice

Responses

Request samples

Content type
{
  • "sender": {
    },
  • "activationLookup": {
    }
}

Response samples

Content type
{
  • "result": {
    },
  • "paymentReference": "string"
}

Returns address information about a customer, the address might be obtained from an external source such as a credit information provider.

Authorizations:
(oauth2apikey)
Request Body schema:
object (SenderType)

The Sender object is used to identify the sender of the call.

object (CustomerLookupType)

Identify a customer

juridicalType
integer <int32> (CheckoutCustomerJuridicalType)
Enum: 0 1 2

Juridical type of the customer

Physical = 0, Company = 1, PersonalFirm = 2

Array of objects or null (DataProvisionType)

Data provisions, like consents

Responses

Request samples

Content type
{
  • "sender": {
    },
  • "customerLookup": {
    },
  • "juridicalType": 0,
  • "dataProvisions": [
    ]
}

Response samples

Content type
{
  • "result": {
    },
  • "name": {
    },
  • "addresses": [
    ],
  • "idnumber": "string",
  • "email": "string",
  • "limit": 0
}

Returns all available payment products for this merchant.

Authorizations:
(oauth2apikey)
Request Body schema:
object (SenderType)

The Sender object is used to identify the sender of the call.

Responses

Request samples

Content type
{
  • "sender": {
    }
}

Response samples

Content type
{
  • "result": {
    },
  • "paymentProducts": [
    ]
}

Get details of a specific payment product based on the customer and purchase amount.

Authorizations:
(oauth2apikey)
Request Body schema:
object (SenderType)

The Sender object is used to identify the sender of the call.

currencyCode
string or null

Purchase currency code, ISO 4217, 3 capital letters. Example: USD; EUR, SEK, NOK, DKK.

amount
number <double>

Purchase amount.

object (CustomerLookupType)

Identify a customer

paymentProductCode
string or null

Code of payment product to get information about.

Array of objects or null (DataProvisionType)

Data provisions, like consents

Responses

Request samples

Content type
{
  • "sender": {
    },
  • "currencyCode": "string",
  • "amount": 0,
  • "customerLookup": {
    },
  • "paymentProductCode": "string",
  • "dataProvisions": [
    ]
}

Response samples

Content type
{
  • "result": {
    },
  • "paymentProductCode": "string",
  • "paymentProductDescription": "string",
  • "paymentProductCategory": "INVOICE, ACCOUNT, PARTPAYMENT, CAMPAIGN, BUYNOWPAYLATER",
  • "paymentProductCategoryDescription": "Invoice, Account, Part payment, Campaign, Buy now pay later",
  • "currencyCode": "EUR, USD, SEK, NOK, DKK",
  • "registrationFee": 0,
  • "settlementFee": 0,
  • "invoiceFee": 0,
  • "interestRate": 0,
  • "partPaymentCalculation": 0,
  • "numberOfPayments": 0,
  • "firstPaymentDueDate": "2019-08-24T14:15:22Z",
  • "lastPaymentDueDate": "2019-08-24T14:15:22Z",
  • "annualPercentageRate": 0,
  • "paymentCondition": 0,
  • "totalCreditCost": 0,
  • "partPaymentMonthlyCost": 0,
  • "additionalCustomerApprovalCode": "string",
  • "totalAmount": 0,
  • "payments": [
    ],
  • "paymentProductType": "string",
  • "paymentProductTypeDescription": "string",
  • "paymentProductTermsAndConditions": "string",
  • "dataProvisions": [
    ]
}

GetPaymentProducts returns a list of available payment products, it's possible to customize the list based on which customer the call is made on behalf of. It's possible to customize the list depending on who the customer is and the amount that the customer want to make purchase for.

Authorizations:
(oauth2apikey)
Request Body schema:

Request body

object (SenderType)

The Sender object is used to identify the sender of the call.

currencyCode
string or null

Purchase currency code, ISO 4217, 3 capital letters. Example: USD; EUR, SEK, NOK, DKK.

amount
number <double>

Purchase amount.

object (CustomerLookupType)

Identify a customer

Array of objects or null (DataProvisionType)

Data provisions, like consents

Responses

Request samples

Content type
{
  • "sender": {
    },
  • "currencyCode": "string",
  • "amount": 0,
  • "customerLookup": {
    },
  • "dataProvisions": [
    ]
}

Response samples

Content type
{
  • "result": {
    },
  • "paymentProducts": [
    ]
}

Make a reservation

Authorizations:
(oauth2apikey)
Request Body schema:
object (SenderType)

The Sender object is used to identify the sender of the call.

object (CustomerLookupType)

Identify a customer

object (CustomerType)

Customer data

object (OrderType)

Order data

object (AdditionalCustomerApprovalType)

Customer approval data, usual from some kind of signing process

directActivation
boolean or null

If true the reservation will be activated immediately.

onHold
boolean or null

If true the reservation will be put on hold.

limit
number or null <double>

The customers credit limit.

object (StoreType)

Information about a store

Array of objects or null (DataProvisionType)

Data provisions, GDPR consents

automaticActivationDate
string or null <date-time>

Automatic activation date, if set the reservation will be stored in CreditConnect and activated automatic on that specific date.

seller
string or null

Seller

object (ClaimantType)

Information about an external claimant.

Responses

Request samples

Content type
{
  • "sender": {
    },
  • "customerLookup": {
    },
  • "customer": {
    },
  • "order": {
    },
  • "additionalCustomerApproval": {
    },
  • "directActivation": true,
  • "onHold": true,
  • "limit": 0,
  • "store": {
    },
  • "dataProvisions": [
    ],
  • "automaticActivationDate": "2019-08-24T14:15:22Z",
  • "seller": "string",
  • "claimant": {
    }
}

Response samples

Content type
{
  • "result": {
    },
  • "reservationNumber": 0,
  • "additionalCustomerApprovalCode": "string",
  • "reservationStatus": 0,
  • "limit": 0
}

Write state data, used by web shops to keep track of states. CreditConnect will not use this information, the information will be purged after a wile, depending on settings for how long to keep the information.

Authorizations:
(oauth2apikey)
Request Body schema:
object (SenderType)

The Sender object is used to identify the sender of the call.

object (WriteStateRequestType)

State data

Responses

Request samples

Content type
{
  • "sender": {
    },
  • "request": {
    }
}

Response samples

Content type
{
  • "result": {
    }
}

Read state data, used by web shops to keep track of states. CreditConnect will not use this information, the information will be purged after a wile, depending on settings for how long to keep the information.

Authorizations:
(oauth2apikey)
Request Body schema:
object (SenderType)

The Sender object is used to identify the sender of the call.

object (ReadStateRequestType)

State lookup

Responses

Request samples

Content type
{
  • "sender": {
    },
  • "request": {
    }
}

Response samples

Content type
{
  • "result": {
    },
  • "state": {
    }
}

Read many states at the same time in bulk, used by web shops to keep track of states. CreditConnect will not use this information, the information will be purged after a wile, depending on settings for how long to keep the information.

Authorizations:
(oauth2apikey)
Request Body schema:
object (SenderType)

The Sender object is used to identify the sender of the call.

object (ReadStatesRequestType)

Responses

Request samples

Content type
{
  • "sender": {
    },
  • "request": {
    }
}

Response samples

Content type
{
  • "result": {
    },
  • "totalCount": 0,
  • "states": [
    ]
}

Delete states, used by web shops to keep track of states. CreditConnect will not use this information, the information will be purged after a wile, depending on settings for how long to keep the information.

Authorizations:
(oauth2apikey)
Request Body schema:
object (SenderType)

The Sender object is used to identify the sender of the call.

object (DeleteStateRequestType)

Responses

Request samples

Content type
{
  • "sender": {
    },
  • "stateData": {
    }
}

Response samples

Content type
{
  • "result": {
    }
}

Returns customer information, this call is currently not maintained. Use with caution. Let us know if you need to use it.

Authorizations:
(oauth2apikey)
Request Body schema:
object (SenderType)

The Sender object is used to identify the sender of the call.

object (CustomerInformationLookupType)
juridical
integer <int32> (CheckoutCustomerJuridicalType)
Enum: 0 1 2

Juridical type of the customer

Physical = 0, Company = 1, PersonalFirm = 2

Responses

Request samples

Content type
{
  • "sender": {
    },
  • "customerLookup": {
    },
  • "juridical": 0
}

Response samples

Content type
{
  • "result": {
    },
  • "customerData": {
    }
}

Return items

Authorizations:
(oauth2apikey)
Request Body schema:
object (SenderType)

The Sender object is used to identify the sender of the call.

object (ActivationLookupType)

The ActivationLookupType is used to identify an activation/invoice

object (ReturnDataType)

Return data

Responses

Request samples

Content type
{
  • "sender": {
    },
  • "activationLookup": {
    },
  • "returnData": {
    }
}

Response samples

Content type
{
  • "result": {
    }
}

Returns information about the current user.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{
  • "result": {
    },
  • "user": {
    }
}

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }