API Reference

Get refund details

gethttps://api.circle.com/v1/cpn/payments/{paymentId}/refunds/{refundId}

Reference
Playground

Retrieves the full refund object associated with a specific payment. This can be used by OFIs to reconcile refund status and verify refund completion.

Path parameters

refundId

uuid

Required

The ID of the refund.

paymentId

uuid

Required

The payment id created previously.

Response

200

Response Body

object

data

object

Required

Show 8 properties

string

Required

System-generated unique identifier of the resource.

paymentId

string

Required

System-generated unique identifier of the resource.

status

string

Required

Refund status.

Allowed valuesCREATEDCOMPLETEDFAILED

amount

object

Represents an amount of cryptocurrency, including both the numerical amount and the specific cryptocurrency type.

Show 2 properties

amount

string

currency

string

Supported cryptocurrencies

Allowed valuesUSDC

transactionHash

string

Transaction hash if refund has been sent onchain (nullable when status is CREATED).

refundAddress

string

Required

Blockchain address the refund is sent to.

blockchain

string

Required

Supported blockchain networks

Allowed valuesSOLMATICETHSOL-DEVNETMATIC-AMOYETH-SEPOLIA

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    "status": "CREATED",
6    "amount": {
7      "amount": "110.27",
8      "currency": "USDC"
9    },
10    "transactionHash": "",
11    "refundAddress": "",
12    "blockchain": "ETH-SEPOLIA",
13    "createDate": "2023-01-01T12:04:05Z"
14  }
15}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy