API Reference

Refund a payment intent

posthttps://api-sandbox.circle.com/v1/paymentIntents/{id}/refund

Reference
Playground

Path parameters

uuid

Required

Universally unique identifier (UUID v4) of a resource.

Body parameters

toAmount

object

Required

The destination amount of the refund, it must be in the original payment currency.

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code.

Allowed valuesUSDETHBTC

amount

object

Required

The source amount of the refund, it can be in either the original payment currency or the settlement currency.

Show 1 properties

currency

string

Required

Currency code.

Allowed valuesUSDETHBTC

destination

object

Required

The destination of a crypto refund.

Show 3 properties

address

string

Required

The blockchain address.

addressTag

string

The secondary identifier for a blockchain address. An example of this is the memo field on the Stellar network, which can be text, id, or hash format.

chain

string

Required

A blockchain that a given currency is available on.

Allowed valuesALGOAPTOSARBAVAXBASEBTCCELOETHHBARLINEANEARNOBLEOPPAHPOLYSOLSUIUNIXLMZKS

idempotencyKey

string

Required

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

Response

201CreateCryptoRefundResponse

Response Body

object

data

object

Status information of the related payment.

Show 16 properties

string

Required

Unique system generated identifier for the entity.

type

string

Required

Type of the payment object.

Allowed valuespaymentrefund

merchantId

string

Required

Unique system generated identifier for the merchant.

merchantWalletId

string

Unique system generated identifier for the wallet of the merchant.

amount

object

Required

Show 2 properties

amount

string

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code.

Allowed valuesUSDETHBTC

status

string

Required

Enumerated status of the payment. pending means the payment is waiting to be processed. confirmed means the payment has been approved by the bank and the merchant can treat it as successful, but settlement funds are not yet available to the merchant. paid means settlement funds have been received and are available to the merchant. failed means something went wrong (most commonly that the payment was denied). action_required means that additional steps are required to process this payment; refer to requiredAction for more details. Terminal states are paid and failed.

Allowed valuespendingconfirmedpaidfailedaction_required

fees

object

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code.

Allowed valuesUSD

networkFees

object

Show 3 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code for the amount.

Allowed valuesUSDEURBTCETH

feePayer

string

The party that pays the network fee based on merchant configuration.

Allowed valuesendUsermerchant

paymentIntentId

string

settlementAmount

object

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Currency code.

Allowed valuesUSD

fromAddresses

object

Show 2 properties

chain

string

A blockchain that a given currency is available on.

Allowed valuesALGOAPTOSARBAVAXBASEBTCCELOETHHBARLINEANEARNOBLEOPPAHPOLYSOLSUIUNIXLMZKS

addresses

array of strings

depositAddress

object

Show 3 properties

chain

string

A blockchain that a given currency is available on.

Allowed valuesALGOAPTOSARBAVAXBASEBTCCELOETHHBARLINEANEARNOBLEOPPAHPOLYSOLSUIUNIXLMZKS

address

string

addressTag

string

The secondary identifier for a blockchain address. An example of this is the memo field on the Stellar network, which can be text, id, or hash format.

transactionHash

string

createDate

string

ISO-8601 UTC date/time format.

updateDate

string

ISO-8601 UTC date/time format.

riskEvaluation

object

Results of risk evaluation. Only present if the payment is denied by Circle's risk service.

Show 2 properties

decision

string

Enumerated decision of the account.

Allowed valuesapproveddeniedreview

reason

string

Risk reason for the definitive decision outcome.

400BadRequest

401NotAuthorized

404NotFound

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
4    "type": "payment",
5    "merchantId": "fc988ed5-c129-4f70-a064-e5beb7eb8e32",
6    "merchantWalletId": "212000",
7    "amount": {
8      "amount": "3.14",
9      "currency": "USD"
10    },
11    "status": "pending",
12    "fees": {
13      "amount": "3.14",
14      "currency": "USD"
15    },
16    "networkFees": {
17      "amount": "3.14",
18      "currency": "USD",
19      "feePayer": "endUser"
20    },
21    "paymentIntentId": "6e4d4047-db14-4c09-b238-1215aee50d03",
22    "settlementAmount": {
23      "amount": "3.14",
24      "currency": "USD"
25    },
26    "fromAddresses": {
27      "chain": "ALGO",
28      "addresses": [
29        "0x8381470ED67C3802402dbbFa0058E8871F017A6F"
30      ]
31    },
32    "depositAddress": {
33      "chain": "ALGO",
34      "address": "0x97de855690955e0da79ce5c1b6804847e7070c7f",
35      "addressTag": "123456789"
36    },
37    "transactionHash": "0x7351585460bd657f320b9afa02a52c26d89272d0d10cc29913eb8b28e64fd906",
38    "createDate": "2020-04-10T02:13:30.000Z",
39    "updateDate": "2020-04-10T02:13:30.000Z",
40    "riskEvaluation": {
41      "decision": "approved",
42      "reason": "3000"
43    }
44  }
45}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy