API Reference

Create a support ticket

posthttps://api.circle.com/v1/cpn/supportTickets

Reference
Playground

Create transaction-related issues (for example, settlement delays, missing information, or refunds). These tickets are stored centrally in the CPN platform and routed to the appropriate party for resolution.

Body parameters

idempotencyKey

string

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.

string

Required

Contact email for follow-up.

description

string

Required

Detailed message for the support ticket.

issueType

string

Required

Type of the support ticket

Allowed valuesPAYMENT_SETTLEMENT_DELAYPAYMENT_SENT_TO_WRONG_RECIPIENTPAYMENT_AMOUNT_INCORRECTREQUEST_FOR_INFORMATION_OFIREQUEST_FOR_INFORMATION_SENDERREQUEST_FOR_INFORMATION_RECEIVERFUNDING_AMOUNT_DISCREPANCYREVERSE_FUNDSEXISTING_TICKETOTHER

paymentId

string

Required

System-generated unique identifier of the resource.

ccEmails

array of strings

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

Response

201SupportTicketResponse

Response Body

object

data

object

Required

Response schema for a support ticket

Show 9 properties

string

Required

System-generated unique identifier of the resource.

paymentId

string

Required

System-generated unique identifier of the resource.

issueType

string

Required

Type of the support ticket

description

string

Required

Detailed message for the support ticket.

caseRefId

string

Required

External case reference.

ticketRefId

string

System-generated unique identifier of the resource.

string

Required

Contact email for follow-up.

ccEmails

array of strings

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

createDate

string

Required

Date and time when the resource was created

400BadRequestResponse

Response Body

object

code

integer

Required

Code that corresponds to the error.

message

string

Required

Human-readable message that describes the error.

errors

array of objects

Array of detailed error descriptions

Show 3 properties

error

string

Required

Type of descriptive error

Allowed valuesMISSING_OR_INVALID_FIELD

location

string

The key or path where the error occurred

message

string

Required

Detailed description of the error

401NotAuthorizedResponse

Response Body

object

code

integer

Required

Code that corresponds to the error.

message

string

Required

Human-readable message that describes the error.

errors

array of objects

Array of detailed error descriptions

Show 3 properties

error

string

Required

Type of descriptive error

Allowed valuesMISSING_OR_INVALID_FIELD

location

string

The key or path where the error occurred

message

string

Required

Detailed description of the error

403ForbiddenResponse

Response Body

object

code

integer

Required

Code that corresponds to the error.

message

string

Required

Human-readable message that describes the error.

errors

array of objects

Array of detailed error descriptions

Show 3 properties

error

string

Required

Type of descriptive error

Allowed valuesMISSING_OR_INVALID_FIELD

location

string

The key or path where the error occurred

message

string

Required

Detailed description of the error

404NotFoundResponse

Response Body

object

code

integer

Required

Code that corresponds to the error.

message

string

Required

Human-readable message that describes the error.

errors

array of objects

Array of detailed error descriptions

Show 3 properties

error

string

Required

Type of descriptive error

Allowed valuesMISSING_OR_INVALID_FIELD

location

string

The key or path where the error occurred

message

string

Required

Detailed description of the error

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
4    "paymentId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
5    "issueType": "PAYMENT_SETTLEMENT_DELAY",
6    "description": "",
7    "caseRefId": "",
8    "ticketRefId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
9    "email": "[email protected]",
10    "ccEmails": [
11      "[email protected]",
12      "[email protected]"
13    ],
14    "createDate": "2023-01-01T12:04:05Z"
15  }
16}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy