> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ripio.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve Support Ticket
> Returns the current status of a support ticket previously created via [Create Support Ticket](/ramps-api/support-tickets/create-support-ticket). The ticket reference (`issueKey`) becomes available once the ticket reaches the `CREATED` status.
To be notified automatically when a ticket is resolved, subscribe to the [Support Ticket webhook events](/ramps-api/webhooks/support-ticket-events). You can also check a specific ticket on demand with this endpoint.
**This endpoint must be enabled for your account by the Ripio team.** While support tickets are disabled, requests return `403` with the error code `20061`.
The recommended way to learn a ticket's outcome is to subscribe to the [Support Ticket webhook events](/ramps-api/webhooks/support-ticket-events), which notify your application automatically as soon as a ticket reaches the `CREATED` or `FAILED` status. You can also check a specific ticket's status on demand with this endpoint.
Support tickets are an **opt-in feature that must be enabled for your account by the Ripio team**. While the feature is disabled, this endpoint returns `403 Forbidden` with the error code `20061` (`SupportTicketsNotEnabledException`). Contact the Ripio team to have it enabled.
## Checking a ticket's status
Use this endpoint to look up the current status of a ticket created via [Create Support Ticket](/ramps-api/support-tickets/create-support-ticket), passing the `ticketId` returned there.
The `status` field follows this lifecycle:
| `status` | Meaning |
| --------- | ------------------------------------------------------------------------------------------ |
| `PENDING` | The ticket was accepted and is still being processed. `issueKey` is `null`. |
| `CREATED` | The ticket was successfully registered with Ripio's support team. `issueKey` is populated. |
| `FAILED` | The ticket could not be registered. `issueKey` is `null`. |
## OpenAPI
````yaml ramps-api/openapi.json GET /api/v1/supportTickets/{ticketId}/
openapi: 3.1.0
info:
title: Ripio Ramp API
version: v1
description: >-
API for Ripio ramp services, enabling partners to integrate On-Ramp,
Off-Ramp, customer management, KYC processes, and other financial
functionalities. This API is RESTful, uses JSON for requests and responses,
and standard HTTP status codes. This document is based on the
'onramp-api.pdf' provided and aims to be compliant with OpenAPI
Specification v3.1.0. The PDF indicates that the API documentation is a
draft and subject to change.
servers:
- url: https://skala-sandbox.ripio.com
description: Sandbox environment
- url: https://skala.ripio.com
description: Production environment
security:
- BearerToken: []
tags:
- name: Authentication
description: Operations related to API authentication and authorization.
- name: Support Tickets
description: >-
Operations for raising and tracking customer support tickets with Ripio's
support team. This feature must be enabled for your account by the Ripio
team.
- name: Customers
description: Operations related to customer management.
- name: KYC
description: Operations related to Know Your Customer processes.
- name: Fiat Accounts
description: Operations related to managing fiat accounts and their requirements.
- name: Quotes
description: Operations related to obtaining and managing conversion quotes.
- name: On-Ramp
description: Operations related to fiat-to-crypto (on-ramp) processes.
- name: Off-Ramp
description: Operations related to crypto-to-fiat (off-ramp) processes.
- name: Transactions
description: Operations related to listing and managing all transaction types.
- name: Networks
description: >-
Operations related to retrieving available deposit and withdrawal
networks.
- name: Rates
description: Operations related to retrieving market rates.
- name: Sandbox
description: Operations specific to the sandbox environment for testing purposes.
- name: Webhooks
description: Webhook event notifications from Ripio Ramp API.
- name: Sell and Pay
description: >-
Endpoints for managing Sell and Pay transactions, which allow customers to
convert cryptocurrency to fiat currency and pay merchants via QR codes
paths:
/api/v1/supportTickets/{ticketId}/:
get:
tags:
- Support Tickets
summary: Retrieve Support Ticket
description: >-
Returns the current status of a support ticket previously created via
[Create Support
Ticket](/ramps-api/support-tickets/create-support-ticket). The ticket
reference (`issueKey`) becomes available once the ticket reaches the
`CREATED` status.
To be notified automatically when a ticket is resolved, subscribe to the
[Support Ticket webhook
events](/ramps-api/webhooks/support-ticket-events). You can also check a
specific ticket on demand with this endpoint.
**This endpoint must be enabled for your account by the Ripio team.**
While support tickets are disabled, requests return `403` with the error
code `20061`.
operationId: retrieveSupportTicket
parameters:
- name: ticketId
in: path
required: true
description: The `ticketId` returned by the Create Support Ticket endpoint.
schema:
type: string
format: uuid
responses:
'200':
description: Current state of the support ticket.
content:
application/json:
schema:
$ref: '#/components/schemas/SupportTicketResponse'
example:
ticketId: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
status: CREATED
issueKey: SUP-1234
'401':
description: Unauthorized - Invalid or missing access token.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
code: 40001
type: NotAuthenticated
detail:
message: Authentication credentials were not provided.
code: not_authenticated
status: 401
'403':
description: >-
Forbidden - support tickets are not enabled for your account.
Contact the Ripio team to enable this feature.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
code: 20061
type: SupportTicketsNotEnabledException
detail:
message: Support tickets are not enabled for this account.
status: 403
'404':
description: >-
Not Found - no support ticket with the given `ticketId` exists for
your account.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
code: 40017
type: SupportTicketNotFoundException
detail:
message: Support ticket not found.
status: 404
components:
schemas:
SupportTicketResponse:
type: object
required:
- ticketId
- status
- issueKey
properties:
ticketId:
type: string
format: uuid
description: >-
Ripio's identifier for the support ticket. Use it to correlate the
Support Ticket webhook events, or to look up the ticket's status on
demand via the Retrieve Support Ticket endpoint.
status:
type: string
enum:
- PENDING
- CREATED
- FAILED
description: >-
Lifecycle status of the ticket. `PENDING`: accepted and being
processed (no reference yet). `CREATED`: successfully registered in
Ripio's support system; `issueKey` is populated. `FAILED`: the
ticket could not be registered.
issueKey:
type:
- string
- 'null'
description: >-
Human-readable reference of the ticket in Ripio's support system
(e.g. `SUP-1234`). `null` until the ticket reaches the `CREATED`
status.
ErrorResponse:
type: object
properties:
code:
type: integer
description: Application-specific error code.
type:
type: string
description: Type of error or exception.
detail:
type: object
properties:
message:
type: string
description: Detailed error message.
additionalProperties: true
status:
type: integer
description: HTTP status code.
required:
- code
- type
- detail
- status
securitySchemes:
BearerToken:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
Access token obtained via
[/oauth2/token/](/ramps-api/authentication/acquire-access-token). Use as
`Authorization: Bearer `.
````