Skip to main content
POST
/
v1
/
cpn
/
supportTickets
Create a support ticket
curl --request POST \
  --url https://api.circle.com/v1/cpn/supportTickets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "paymentId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
  "issueType": "PAYMENT_SETTLEMENT_DELAY",
  "description": "<string>",
  "email": "help@ofi.com",
  "idempotencyKey": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "ccEmails": [
    "ccsupport01@example.com",
    "ccsupport02@example.com"
  ]
}'
{
  "data": {
    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "paymentId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "issueType": "PAYMENT_SETTLEMENT_DELAY",
    "description": "<string>",
    "caseRefId": "<string>",
    "ticketRefId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "email": "help@ofi.com",
    "ccEmails": [
      "ccsupport01@example.com",
      "ccsupport02@example.com"
    ],
    "createDate": "2023-01-01T12:04:05Z"
  }
}

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,
REQUEST_FOR_INFORMATION_OFI,
REQUEST_FOR_INFORMATION_SENDER,
REQUEST_FOR_INFORMATION_RECEIVER,
FUNDING_AMOUNT_DISCREPANCY,
REVERSE_FUNDS,
EXISTING_TICKET,
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:
[
  "ccsupport01@example.com",
  "ccsupport02@example.com"
]

Response

Support ticket created successfully.

​
data
object
required

Response schema for a support ticket

⌘I