checkout session

Get Checkout sessions

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

identityIdstringOptional

Owner Identity Id

Example: 1234a

accountNumberstringOptional

Destination Account Number

Example: 1234

statusstringOptional

Checkout session status

Example: ATTEMPT

startDatestringOptional

(dd/mm/yyyy) Start date filters created Date min

Example: 01/04/2025

endDatestringOptional

(dd/mm/yyyy) End date filters created Date max

Example: 08/04/2025

sortstringOptional

Sorts the results by param:asc | param:desc

Example: createdAt:desc

limitstringOptional

Specifies the maximum number of items to return in a single request.

Example: 50

offsetstringOptional

Skips the input value from the current view

Example: 0

Header parameters

conomyhq-api-versionstringOptional

v1: empty ; v2: 24-04-2025

Default: none, is the first API versionExample: 24-04-2025

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Responses

200Success

application/json

400Error

application/json

500Error

application/json

get

/checkout-sessions

GET /checkout-sessions HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

{
  "pagination": {
    "count": 1,
    "next": 1,
    "previous": 1,
    "total": 1
  },
  "results": [
    {
      "id": "text",
      "paymentLinkId": "text",
      "checkoutToken": "text",
      "paymentConfigs": [
        {
          "currency": "text",
          "product": "text",
          "exchangeRate": "text",
          "paymentMethods": [
            {
              "id": "text",
              "type": "text",
              "enabled": true,
              "requiredFields": [
                "text"
              ],
              "purchaseAmount": "text"
            }
          ]
        }
      ],
      "createdAt": "2025-12-07T04:53:12.758Z",
      "status": "ATTEMPT",
      "items": [
        {
          "preTaxAmount": "text",
          "totalAmount": "text",
          "description": "text",
          "tax": {
            "name": "text",
            "type": "FIXED",
            "value": "text",
            "amount": "text"
          }
        }
      ],
      "currency": "text",
      "preTaxAmount": "text",
      "totalAmount": "text",
      "url": "text",
      "paymentMethodsAllowed": [
        "CARD"
      ],
      "customer": {
        "firstName": "text",
        "email": "text",
        "lastName": "text",
        "phoneNumber": "text",
        "phoneNumberPrefix": "text",
        "documentType": "text",
        "documentNumber": "text",
        "address": {
          "administrativeAreaLevel1": "text",
          "administrativeAreaLevel2": "text",
          "administrativeAreaLevel3": "text",
          "street": "text",
          "streetNumber": "text",
          "optionalAddress": "text",
          "country": "text",
          "zipcode": "text"
        }
      },
      "redirectUrl": "text",
      "destinations": [
        {
          "name": "text",
          "type": null,
          "externalId": "text",
          "amount": "text",
          "metadata": {
            "image": "text",
            "description": "text",
            "category": "text"
          },
          "account": {
            "type": "CHECKING",
            "currency": "text",
            "accountNumber": "text",
            "accountHolder": "text"
          }
        }
      ],
      "customerRequirements": [
        "firstName"
      ],
      "expiresAt": "2025-12-07T04:53:12.758Z",
      "owner": {
        "identityId": "text",
        "name": "text",
        "lastname": "text",
        "nickname": "text",
        "documentNumber": "text",
        "entityType": "text"
      }
    }
  ]
}

Get checkout session

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

checkout_session_idstringRequired

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Responses

200Success

application/json

400Error

application/json

500Error

application/json

get

/checkout-sessions/{checkout_session_id}

GET /checkout-sessions/{checkout_session_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

{
  "id": "text",
  "paymentLinkId": "text",
  "checkoutToken": "text",
  "paymentConfigs": [
    {
      "currency": "text",
      "product": "text",
      "exchangeRate": "text",
      "paymentMethods": [
        {
          "id": "text",
          "type": "text",
          "enabled": true,
          "requiredFields": [
            "text"
          ],
          "purchaseAmount": "text"
        }
      ]
    }
  ],
  "createdAt": "2025-12-07T04:53:12.758Z",
  "status": "ATTEMPT",
  "items": [
    {
      "preTaxAmount": "text",
      "totalAmount": "text",
      "description": "text",
      "tax": {
        "name": "text",
        "type": "FIXED",
        "value": "text",
        "amount": "text"
      }
    }
  ],
  "currency": "text",
  "preTaxAmount": "text",
  "totalAmount": "text",
  "url": "text",
  "paymentMethodsAllowed": [
    "CARD"
  ],
  "customer": {
    "firstName": "text",
    "email": "text",
    "lastName": "text",
    "phoneNumber": "text",
    "phoneNumberPrefix": "text",
    "documentType": "text",
    "documentNumber": "text",
    "address": {
      "administrativeAreaLevel1": "text",
      "administrativeAreaLevel2": "text",
      "administrativeAreaLevel3": "text",
      "street": "text",
      "streetNumber": "text",
      "optionalAddress": "text",
      "country": "text",
      "zipcode": "text"
    }
  },
  "redirectUrl": "text",
  "destinations": [
    {
      "name": "text",
      "type": null,
      "externalId": "text",
      "amount": "text",
      "metadata": {
        "image": "text",
        "description": "text",
        "category": "text"
      },
      "account": {
        "type": "CHECKING",
        "currency": "text",
        "accountNumber": "text",
        "accountHolder": "text"
      }
    }
  ],
  "customerRequirements": [
    "firstName"
  ],
  "expiresAt": "2025-12-07T04:53:12.758Z",
  "owner": {
    "identityId": "text",
    "name": "text",
    "lastname": "text",
    "nickname": "text",
    "documentNumber": "text",
    "entityType": "text"
  }
}

Create checkout session

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Body

checkoutTokenstringRequired

Reference for checkout url

currencystringRequired

Currency for payment

durationinteger · min: 30Required

Amount of seconds for payment link to be inactivated after creation

successUrlstringOptional

The URL to which the end user will be redirected after successful payment completion.

failedUrlstringOptional

The URL to which the end user will be redirected after failed payment or cancellation.

Responses

201Success

application/json

400Error

application/json

500Error

application/json

post

/checkout-sessions

POST /checkout-sessions HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Content-Type: application/json
Accept: */*
Content-Length: 1044

{
  "checkoutToken": "text",
  "items": [
    {
      "preTaxAmount": "text",
      "totalAmount": "text",
      "description": "text",
      "tax": {
        "name": "text",
        "type": "FIXED",
        "value": "text",
        "amount": "text"
      }
    }
  ],
  "currency": "text",
  "paymentMethodsAllowed": [
    "CARD"
  ],
  "customer": {
    "firstName": "text",
    "email": "text",
    "lastName": "text",
    "phoneNumber": "text",
    "phoneNumberPrefix": "text",
    "documentType": "text",
    "documentNumber": "text",
    "address": {
      "administrativeAreaLevel1": "text",
      "administrativeAreaLevel2": "text",
      "administrativeAreaLevel3": "text",
      "street": "text",
      "streetNumber": "text",
      "optionalAddress": "text",
      "country": "text",
      "zipcode": "text"
    }
  },
  "destinations": [
    {
      "name": "text",
      "type": null,
      "externalId": "text",
      "amount": "text",
      "metadata": {
        "image": "text",
        "description": "text",
        "category": "text"
      },
      "account": {
        "type": "CHECKING",
        "currency": "text",
        "accountNumber": "text",
        "accountHolder": "text"
      }
    }
  ],
  "duration": 1,
  "customerRequirements": [
    "firstName"
  ],
  "owner": {
    "identityId": "text",
    "name": "text",
    "lastname": "text",
    "nickname": "text",
    "documentNumber": "text",
    "entityType": "text"
  },
  "successUrl": "text",
  "failedUrl": "text"
}

{
  "id": "text",
  "paymentLinkId": "text",
  "checkoutToken": "text",
  "paymentConfigs": [
    {
      "currency": "text",
      "product": "text",
      "exchangeRate": "text",
      "paymentMethods": [
        {
          "id": "text",
          "type": "text",
          "enabled": true,
          "requiredFields": [
            "text"
          ],
          "purchaseAmount": "text"
        }
      ]
    }
  ],
  "createdAt": "2025-12-07T04:53:12.758Z",
  "status": "ATTEMPT",
  "items": [
    {
      "preTaxAmount": "text",
      "totalAmount": "text",
      "description": "text",
      "tax": {
        "name": "text",
        "type": "FIXED",
        "value": "text",
        "amount": "text"
      }
    }
  ],
  "currency": "text",
  "preTaxAmount": "text",
  "totalAmount": "text",
  "url": "text",
  "paymentMethodsAllowed": [
    "CARD"
  ],
  "customer": {
    "firstName": "text",
    "email": "text",
    "lastName": "text",
    "phoneNumber": "text",
    "phoneNumberPrefix": "text",
    "documentType": "text",
    "documentNumber": "text",
    "address": {
      "administrativeAreaLevel1": "text",
      "administrativeAreaLevel2": "text",
      "administrativeAreaLevel3": "text",
      "street": "text",
      "streetNumber": "text",
      "optionalAddress": "text",
      "country": "text",
      "zipcode": "text"
    }
  },
  "redirectUrl": "text",
  "destinations": [
    {
      "name": "text",
      "type": null,
      "externalId": "text",
      "amount": "text",
      "metadata": {
        "image": "text",
        "description": "text",
        "category": "text"
      },
      "account": {
        "type": "CHECKING",
        "currency": "text",
        "accountNumber": "text",
        "accountHolder": "text"
      }
    }
  ],
  "customerRequirements": [
    "firstName"
  ],
  "expiresAt": "2025-12-07T04:53:12.758Z",
  "owner": {
    "identityId": "text",
    "name": "text",
    "lastname": "text",
    "nickname": "text",
    "documentNumber": "text",
    "entityType": "text"
  }
}

Delete checkout session

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

checkout_session_idstringRequired

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Responses

200Success

application/json

Responseobject

400Error

application/json

500Error

application/json

delete

/checkout-sessions/{checkout_session_id}

DELETE /checkout-sessions/{checkout_session_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

{}

PreviousPayment-links NextWebhooks

Last updated 2 months ago