• Authentication
• Sessions
  • getList all Checkout Sessions
  • postCreate a Checkout Session
  • getRetrieve a Session by ID

Documentation Powered by Redocly

iCliGo Checkout (v1)

Download OpenAPI specification:Download

API Support: development@icligo.com

Checkout is a low-code payment integration that creates a customisable payment page so you can quickly collect online payments.

Authentication

In order to perform any request to iCliGo Checkout API you need send in the Authorization header your Bearer token.

Bearer Authentication

Security Scheme Type: HTTP

HTTP Authorization Scheme: bearer

Sessions

A Checkout Session represents your customer's session as they pay for one-time purchases through Checkout or Payment Links. We recommend creating a new Session each time your customer attempts to pay.

List all Checkout Sessions

Production

https://api.icligo.com/v1/checkout/sessions

Development

http://localhost:8080/v1/checkout/sessions

Your application can get all the Checkout Session created by your application

Authorizations:

Bearer Authentication

query Parameters

page	integer >= 0 Default: 0 Zero-based page index (0..N)
size	integer >= 1 Default: 20 The size of the page to be returned
sort	Array of strings Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

Response Schema: application/json

totalPages	integer <int32>
totalElements	integer <int64>
size	integer <int32>
	Array of objects (Session)
number	integer <int32>
	object (Sort)
	object (PageableObject)
numberOfElements	integer <int32>
first	boolean
last	boolean
empty	boolean

Response samples

• 200

Content type

application/json

{

• "totalPages": 0,
• "totalElements": 0,
• "size": 0,
• "content": [

  • {

    • "id": "cs_test_a1cCZgAIh3PyXR8NVCp2GsbuJNzJNxacqscEzIovU7cteVb6awdFbarfkQ",
    • "object": "checkout.session",
    • "reference_id": "ORD-0001",
    • "description": "Trip to Australia",
    • "amount": 100.15,
    • "currency": "EUR",
    • "confirm": false,
    • "customer": {

      • "id": "string",
      • "name": "string",
      • "email": "string"

      },
    • "metadata": {

      • "property1": { },
      • "property2": { }

      },
    • "success_url": "https://www.myapp.com/ORD-0001/success",
    • "cancel_url": "https://www.myapp.com/ORD-0001/cancel",
    • "locale": "pt",
    • "url": "https://checkout.icligo.com/cs_test_a1cCZgAIh3PyXR8NVCp2GsbuJNzJNxacqscEzIovU7cteVb6awdFbarfkQ",
    • "status": "open",
    • "payment_status": "authorized",
    • "amount_capturable": 0,
    • "amount_received": 0,
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z"

    }

  ],
• "number": 0,
• "sort": {

  • "empty": true,
  • "sorted": true,
  • "unsorted": true

  },
• "pageable": {

  • "offset": 0,
  • "sort": {

    • "empty": true,
    • "sorted": true,
    • "unsorted": true

    },
  • "paged": true,
  • "unpaged": true,
  • "pageNumber": 0,
  • "pageSize": 0

  },
• "numberOfElements": 0,
• "first": true,
• "last": true,
• "empty": true

}

Create a Checkout Session

Production

https://api.icligo.com/v1/checkout/sessions

Development

http://localhost:8080/v1/checkout/sessions

When customers are ready to complete their purchase, your application needs to create a new Checkout Session using this endpoint.
The created Checkout Session provides a URL for your application redirect the customer to iCliGo-hosted payment page.

Authorizations:

Bearer Authentication

Request Body schema: application/json

reference_id required	string Example: "ORD-0001" A unique string to reference the Checkout Session. This can be a order ID, or similar, and can be used to reconcile the Session with your internal systems.
description required	string Example: "Trip to Australia" An arbitrary string attached to the object. Useful for displaying to users.
amount required	number Example: 100.15 Amount to collect from the customer
currency required	string Example: "EUR" Three-letter ISO currency code. Must be a supported currency.
confirm required	boolean Example: false Set to true to attempt to capture this payment immediately. This parameter defaults to false.
required	object (Customer) The information of the customer.
	object Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
success_url required	string Example: "https://www.myapp.com/ORD-0001/success" The URL the customer will be directed to after the payment creation is successful.
cancel_url required	string Example: "https://www.myapp.com/ORD-0001/cancel" The URL the customer will be directed to if they decide to cancel payment and return to your website.
locale	string Example: "pt" The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser?s locale is used.

Responses

Response Schema: application/json

id	string Example: "cs_test_a1cCZgAIh3PyXR8NVCp2GsbuJNzJNxacqscEzIovU7cteVb6awdFbarfkQ" Unique identifier for the object.
object	string Default: "checkout.session" Type of object
reference_id required	string Example: "ORD-0001" A unique string to reference the Checkout Session. This can be a order ID, or similar, and can be used to reconcile the Session with your internal systems.
description required	string Example: "Trip to Australia" An arbitrary string attached to the object. Useful for displaying to users.
amount required	number Example: 100.15 Amount to collect from the customer
currency required	string Example: "EUR" Three-letter ISO currency code. Must be a supported currency.
confirm required	boolean Example: false Set to true to attempt to capture this payment immediately. This parameter defaults to false.
required	object (Customer) The information of the customer.
	object Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
success_url required	string Example: "https://www.myapp.com/ORD-0001/success" The URL the customer will be directed to after the payment creation is successful.
cancel_url required	string Example: "https://www.myapp.com/ORD-0001/cancel" The URL the customer will be directed to if they decide to cancel payment and return to your website.
locale	string Example: "pt" The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser?s locale is used.
url required	string Example: "https://checkout.icligo.com/cs_test_a1cCZgAIh3PyXR8NVCp2GsbuJNzJNxacqscEzIovU7cteVb6awdFbarfkQ" The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout.
status required	string Enum: "open" "complete" "expired" The status of the Checkout Session, one of open, complete, or expired.
payment_status required	string Enum: "authorized" "rejected" "paid" "unpaid" The payment status of the Checkout Session, one of authorized, rejected, paid, or unpaid. You can use this value to decide when to fulfill your customer?s order.
amount_capturable	number Amount that can be captured by this Checkout Session.
amount_received	number Amount that was collected by this Checkout Session.
created_at	string <date-time> Session creation date.
updated_at	string <date-time> Session last update date.

Request samples

• Payload

Content type

application/json

{

• "reference_id": "ORD-0001",
• "description": "Trip to Australia",
• "amount": 100.15,
• "currency": "EUR",
• "confirm": false,
• "customer": {

  • "id": "string",
  • "name": "string",
  • "email": "string"

  },
• "metadata": {

  • "property1": "string",
  • "property2": "string"

  },
• "success_url": "https://www.myapp.com/ORD-0001/success",
• "cancel_url": "https://www.myapp.com/ORD-0001/cancel",
• "locale": "pt"

}

Response samples

• 201

Content type

application/json

{

• "id": "cs_test_a1cCZgAIh3PyXR8NVCp2GsbuJNzJNxacqscEzIovU7cteVb6awdFbarfkQ",
• "object": "checkout.session",
• "reference_id": "ORD-0001",
• "description": "Trip to Australia",
• "amount": 100.15,
• "currency": "EUR",
• "confirm": false,
• "customer": {

  • "id": "string",
  • "name": "string",
  • "email": "string"

  },
• "metadata": {

  • "property1": { },
  • "property2": { }

  },
• "success_url": "https://www.myapp.com/ORD-0001/success",
• "cancel_url": "https://www.myapp.com/ORD-0001/cancel",
• "locale": "pt",
• "url": "https://checkout.icligo.com/cs_test_a1cCZgAIh3PyXR8NVCp2GsbuJNzJNxacqscEzIovU7cteVb6awdFbarfkQ",
• "status": "open",
• "payment_status": "authorized",
• "amount_capturable": 0,
• "amount_received": 0,
• "created_at": "2019-08-24T14:15:22Z",
• "updated_at": "2019-08-24T14:15:22Z"

}

Retrieve a Session by ID

Production

https://api.icligo.com/v1/checkout/sessions/{id}

Development

http://localhost:8080/v1/checkout/sessions/{id}

Your application can get a specific Session created by your application to see is current state

Authorizations:

Bearer Authentication

path Parameters

id required

string

Responses

Response Schema: application/json

id	string Example: "cs_test_a1cCZgAIh3PyXR8NVCp2GsbuJNzJNxacqscEzIovU7cteVb6awdFbarfkQ" Unique identifier for the object.
object	string Default: "checkout.session" Type of object
reference_id required	string Example: "ORD-0001" A unique string to reference the Checkout Session. This can be a order ID, or similar, and can be used to reconcile the Session with your internal systems.
description required	string Example: "Trip to Australia" An arbitrary string attached to the object. Useful for displaying to users.
amount required	number Example: 100.15 Amount to collect from the customer
currency required	string Example: "EUR" Three-letter ISO currency code. Must be a supported currency.
confirm required	boolean Example: false Set to true to attempt to capture this payment immediately. This parameter defaults to false.
required	object (Customer) The information of the customer.
	object Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
success_url required	string Example: "https://www.myapp.com/ORD-0001/success" The URL the customer will be directed to after the payment creation is successful.
cancel_url required	string Example: "https://www.myapp.com/ORD-0001/cancel" The URL the customer will be directed to if they decide to cancel payment and return to your website.
locale	string Example: "pt" The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser?s locale is used.
url required	string Example: "https://checkout.icligo.com/cs_test_a1cCZgAIh3PyXR8NVCp2GsbuJNzJNxacqscEzIovU7cteVb6awdFbarfkQ" The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout.
status required	string Enum: "open" "complete" "expired" The status of the Checkout Session, one of open, complete, or expired.
payment_status required	string Enum: "authorized" "rejected" "paid" "unpaid" The payment status of the Checkout Session, one of authorized, rejected, paid, or unpaid. You can use this value to decide when to fulfill your customer?s order.
amount_capturable	number Amount that can be captured by this Checkout Session.
amount_received	number Amount that was collected by this Checkout Session.
created_at	string <date-time> Session creation date.
updated_at	string <date-time> Session last update date.

Response samples

• 200

Content type

application/json

{

• "id": "cs_test_a1cCZgAIh3PyXR8NVCp2GsbuJNzJNxacqscEzIovU7cteVb6awdFbarfkQ",
• "object": "checkout.session",
• "reference_id": "ORD-0001",
• "description": "Trip to Australia",
• "amount": 100.15,
• "currency": "EUR",
• "confirm": false,
• "customer": {

  • "id": "string",
  • "name": "string",
  • "email": "string"

  },
• "metadata": {

  • "property1": { },
  • "property2": { }

  },
• "success_url": "https://www.myapp.com/ORD-0001/success",
• "cancel_url": "https://www.myapp.com/ORD-0001/cancel",
• "locale": "pt",
• "url": "https://checkout.icligo.com/cs_test_a1cCZgAIh3PyXR8NVCp2GsbuJNzJNxacqscEzIovU7cteVb6awdFbarfkQ",
• "status": "open",
• "payment_status": "authorized",
• "amount_capturable": 0,
• "amount_received": 0,
• "created_at": "2019-08-24T14:15:22Z",
• "updated_at": "2019-08-24T14:15:22Z"

}