Checkout

Skrym checkout API reference

There are two different ways to integrate with Skrym's checkout APIs:

Recommended Approach

Our recommended approach for integrating with the Skrym Checkout API consists of three endpoints:

GetShippingOptions
ReserveShipment
ConfirmPayment

Skrym Checkout API: Recommended Flow

sequenceDiagram autonumber participant C as Checkout participant S as Skrym API participant U as User participant P as Payment Provider C->>+S: Call GetShippingOptions S-->>-C: Return Shipping Options Note over C,U: Shipping options displayed U->>+C: Select Shipping Option C->>+S: Call ReserveShipment S-->>-C: Confirm Reservation of shipping option Note over U,P: User completes payment P->>+C: Confirm Payment C->>+S: Call ConfirmPayment S-->>-C: Confirm Order payment

Interaction Sequence of the Checkout APIs

Each step is responsible for a different part of the process:

Get Shipping Options : Returns the available shipping options. Whenever a user enters the checkout or makes any change to the order or delivery location, this endpoint should be called to get the updated shipping options.
Reserve Delivery : Reserves the shipping option. This should be called when a user has made their final choice of shipping option.
Confirm Payment : Confirms the previously reserved shipping option and payment of the order. This should be called when the order is paid and ready for fulfillment.

Simplified Approach

A Simplified approach of integrating with the Skrym Checkout API consists of two endpoints:

GetShippingOptions
FinalizeShipment

Skrym Checkout API: Simplified Flow

sequenceDiagram autonumber participant C as Checkout participant S as Skrym API participant U as User participant P as Payment Provider C->>+S: Call GetShippingOptions S-->>-C: Return Shipping Options Note over C,U: Shipping options displayed U->>+C: Select Shipping Option Note over U,P: User completes payment P->>+C: Confirm Payment C->>+S: Call FinalizeShipment S-->>-C: Confirm Order payment and shipping option

Interaction Sequence of the Checkout APIs

Each step is responsible for a different part of the process:

Get Shipping Options : Returns the available shipping options. Whenever a user enters the checkout or makes any change to the order or delivery location, this endpoint should be called to get the updated shipping options.
Confirm ShippingOption and Payment : Confirms the selected shipping option and payment of the order. This should be called when the order is paid and ready for fulfillment.