Skip to main content
POST
Create a support ticket

Authorizations

Authorization
string
header
required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Body

application/json

Request schema for creating a support ticket

paymentId
string<uuid>
required

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

issueType
enum<string>
required

Type of the support ticket

Available options:
PAYMENT_SETTLEMENT_DELAY,
PAYMENT_SENT_TO_WRONG_RECIPIENT,
PAYMENT_AMOUNT_INCORRECT,
REVERSE_FUNDS,
OTHER
Example:

"PAYMENT_SETTLEMENT_DELAY"

description
string
required

Detailed message for the support ticket.

email
string<email>
required

Contact email for follow-up.

Example:

"help@ofi.com"

idempotencyKey
string<uuid>
required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. To create a UUIDv4 go to uuidgenerator.net. If the same key is reused, it will be treated as the same request and the original response will be returned.

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

ccEmails
string<email>[]

Optional CC email address for follow-up conversations on this support ticket.

Example:

Response

Support ticket created successfully.

data
object
required

Response schema for a support ticket