Tickets

GetTicketsByAccount returns tickets for a specific account with pagination and filtering

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/tickets/v1/accounts/{accountId}

Scoped to a single account_id. Use GetTickets for the platform-wide admin view across every account

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

accountIdstringRequired

account_id is the unique identifier of the account whose tickets are requested

Query parameters

pageinteger · int32Optional

page is an optional query parameter to set the page

limitinteger · int32Optional

limit is an optional query parameter to set the max number of results

displayStatusstringOptional

display_status is an optional filter to return only tickets with the given display status

statestringOptional

state is an optional filter to return only tickets with the given state

typestringOptional

type is an optional filter to return only tickets of the given type

sortBystringOptional

sort_by is an optional field to sort the results

sortOrderstringOptional

sort_order is an optional field to set the sort direction

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/tickets/v1/accounts/{accountId}

HTTPcURLJavaScriptPython

GET /tickets/v1/accounts/{accountId} HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "pagination": {
    "currentPage": 1,
    "limit": 1,
    "totalItems": 1,
    "totalPages": 1
  },
  "tickets": [
    {
      "accountId": "text",
      "amount": "text",
      "amountUsd": "text",
      "createdAt": "2026-08-10T23:01:57.767Z",
      "deadline": "2026-08-10T23:01:57.767Z",
      "displayStatus": "text",
      "id": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "productFee": "text",
      "quote": {
        "quotePayload": {
          "accountId": "text",
          "assetIn": {
            "amount": "text",
            "code": "text",
            "type": "text"
          },
          "assetOut": {
            "amount": "text",
            "code": "text",
            "type": "text"
          },
          "exp": "text",
          "expirationDate": "2026-08-10T23:01:57.767Z",
          "externalId": "text",
          "id": "text",
          "meta": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "price": "text",
          "productFee": {
            "amount": "text",
            "code": "text",
            "type": "text"
          },
          "providerFee": {
            "amount": "text",
            "code": "text",
            "type": "text"
          },
          "targetId": "text",
          "targetType": "text"
        },
        "signature": "text"
      },
      "state": "text",
      "targetId": "text",
      "targetType": "text",
      "template": {},
      "type": "text",
      "updatedAt": "2026-08-10T23:01:57.767Z",
      "userChainAddress": "text",
      "withdrawDestinationId": "text"
    }
  ]
}

CreateOffRampTicket creates a new off-ramp ticket

post

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/tickets/v1/offramp

Kicks off the off-ramp flow for the given quote. Response includes the transactions the user must sign to fund it

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Body

application/json

accountIdstringRequired

productsProviderIdstringRequired

templateobject · Template information as JSONOptional

userChainAddressstringRequired

withdrawDestinationIdstringOptional

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

post/tickets/v1/offramp

HTTPcURLJavaScriptPython

POST /tickets/v1/offramp HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 646

{
  "accountId": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "productsProviderId": "text",
  "quote": {
    "quotePayload": {
      "accountId": "text",
      "assetIn": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "assetOut": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "exp": "text",
      "expirationDate": "2026-08-10T23:01:57.767Z",
      "externalId": "text",
      "id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "price": "text",
      "productFee": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "providerFee": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "targetId": "text",
      "targetType": "text"
    },
    "signature": "text"
  },
  "template": {},
  "userChainAddress": "text",
  "withdrawDestinationId": "text"
}

{
  "ticket": {
    "accountId": "text",
    "amount": "text",
    "amountUsd": "text",
    "createdAt": "2026-08-10T23:01:57.767Z",
    "deadline": "2026-08-10T23:01:57.767Z",
    "displayStatus": "text",
    "id": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "productFee": "text",
    "quote": {
      "quotePayload": {
        "accountId": "text",
        "assetIn": {
          "amount": "text",
          "code": "text",
          "type": "text"
        },
        "assetOut": {
          "amount": "text",
          "code": "text",
          "type": "text"
        },
        "exp": "text",
        "expirationDate": "2026-08-10T23:01:57.767Z",
        "externalId": "text",
        "id": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "price": "text",
        "productFee": {
          "amount": "text",
          "code": "text",
          "type": "text"
        },
        "providerFee": {
          "amount": "text",
          "code": "text",
          "type": "text"
        },
        "targetId": "text",
        "targetType": "text"
      },
      "signature": "text"
    },
    "state": "text",
    "targetId": "text",
    "targetType": "text",
    "template": {},
    "type": "text",
    "updatedAt": "2026-08-10T23:01:57.767Z",
    "userChainAddress": "text",
    "withdrawDestinationId": "text"
  },
  "transactions": [
    {
      "evm": {
        "chainId": "text",
        "data": "text",
        "from": "text",
        "metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "to": "text",
        "type": "text",
        "value": "text"
      }
    }
  ]
}

CreateSwapTicket creates a new swap ticket with the given parameters

post

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/tickets/v1/swap

Kicks off the swap flow for an instrument's quote. Response includes the transactions the user must sign to fund it

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Body

application/json

accountIdstringRequired

instrumentIdstringRequired

templateobject · Template information as JSONOptional

userChainAddressstringRequired

withdrawDestinationIdstringOptional

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

post/tickets/v1/swap

HTTPcURLJavaScriptPython

POST /tickets/v1/swap HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 640

{
  "accountId": "text",
  "instrumentId": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "quote": {
    "quotePayload": {
      "accountId": "text",
      "assetIn": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "assetOut": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "exp": "text",
      "expirationDate": "2026-08-10T23:01:57.767Z",
      "externalId": "text",
      "id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "price": "text",
      "productFee": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "providerFee": {
        "amount": "text",
        "code": "text",
        "type": "text"
      },
      "targetId": "text",
      "targetType": "text"
    },
    "signature": "text"
  },
  "template": {},
  "userChainAddress": "text",
  "withdrawDestinationId": "text"
}

{
  "ticket": {
    "accountId": "text",
    "amount": "text",
    "amountUsd": "text",
    "createdAt": "2026-08-10T23:01:57.767Z",
    "deadline": "2026-08-10T23:01:57.767Z",
    "displayStatus": "text",
    "id": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "productFee": "text",
    "quote": {
      "quotePayload": {
        "accountId": "text",
        "assetIn": {
          "amount": "text",
          "code": "text",
          "type": "text"
        },
        "assetOut": {
          "amount": "text",
          "code": "text",
          "type": "text"
        },
        "exp": "text",
        "expirationDate": "2026-08-10T23:01:57.767Z",
        "externalId": "text",
        "id": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "price": "text",
        "productFee": {
          "amount": "text",
          "code": "text",
          "type": "text"
        },
        "providerFee": {
          "amount": "text",
          "code": "text",
          "type": "text"
        },
        "targetId": "text",
        "targetType": "text"
      },
      "signature": "text"
    },
    "state": "text",
    "targetId": "text",
    "targetType": "text",
    "template": {},
    "type": "text",
    "updatedAt": "2026-08-10T23:01:57.767Z",
    "userChainAddress": "text",
    "withdrawDestinationId": "text"
  },
  "transactions": [
    {
      "evm": {
        "chainId": "text",
        "data": "text",
        "from": "text",
        "metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "to": "text",
        "type": "text",
        "value": "text"
      }
    }
  ]
}

GetTicket returns a ticket by its ID

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/tickets/v1/{ticketId}

Ticket data only. Use GetTicketDetails for the context, flows and provider information as well

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

ticketIdstringRequired

Unique identifier for the ticket

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/tickets/v1/{ticketId}

HTTPcURLJavaScriptPython

GET /tickets/v1/{ticketId} HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "ticket": {
    "accountId": "text",
    "amount": "text",
    "amountUsd": "text",
    "createdAt": "2026-08-10T23:01:57.767Z",
    "deadline": "2026-08-10T23:01:57.767Z",
    "displayStatus": "text",
    "id": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "productFee": "text",
    "quote": {
      "quotePayload": {
        "accountId": "text",
        "assetIn": {
          "amount": "text",
          "code": "text",
          "type": "text"
        },
        "assetOut": {
          "amount": "text",
          "code": "text",
          "type": "text"
        },
        "exp": "text",
        "expirationDate": "2026-08-10T23:01:57.767Z",
        "externalId": "text",
        "id": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "price": "text",
        "productFee": {
          "amount": "text",
          "code": "text",
          "type": "text"
        },
        "providerFee": {
          "amount": "text",
          "code": "text",
          "type": "text"
        },
        "targetId": "text",
        "targetType": "text"
      },
      "signature": "text"
    },
    "state": "text",
    "targetId": "text",
    "targetType": "text",
    "template": {},
    "type": "text",
    "updatedAt": "2026-08-10T23:01:57.767Z",
    "userChainAddress": "text",
    "withdrawDestinationId": "text"
  }
}

TicketGetPendingUserAction returns the pending user actions for a ticket

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/tickets/v1/{ticketId}/pending_user_actions

Returns either a transaction the user still needs to sign/submit or a URL they need to visit, depending on the ticket's current state

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

ticketIdstringRequired

Unique identifier for the ticket

Responses

200

A successful response.

application/json

typestringOptional

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/tickets/v1/{ticketId}/pending_user_actions

HTTPcURLJavaScriptPython

GET /tickets/v1/{ticketId}/pending_user_actions HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "transactionPayload": {
    "transactions": [
      {
        "evm": {
          "chainId": "text",
          "data": "text",
          "from": "text",
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "to": "text",
          "type": "text",
          "value": "text"
        }
      }
    ]
  },
  "type": "text",
  "urlPayload": {
    "expiresAt": "text",
    "url": "text"
  }
}

GetUserTransactions returns the list of available user transactions for a ticket based on its current state

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/tickets/v1/{ticketId}/user_txs

Transactions the end user still needs to sign and submit themselves For admin-side transactions see GetAdminTransactions

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

ticketIdstringRequired

The ID of the ticket

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/tickets/v1/{ticketId}/user_txs

HTTPcURLJavaScriptPython

GET /tickets/v1/{ticketId}/user_txs HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "transactions": {
    "ANY_ADDITIONAL_PROPERTY": {
      "transactions": [
        {
          "evm": {
            "chainId": "text",
            "data": "text",
            "from": "text",
            "metadata": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "to": "text",
            "type": "text",
            "value": "text"
          }
        }
      ]
    }
  }
}