We refreshed our doc site!
Bookmarked links may have changed
Read release notes
Refund a payment intent
POSThttps://api.circle.com/v1/paymentIntents/{id}/refund
Path parameters
id
uuid
Required
Universally unique identifier (UUID v4) of a resource.
Body parameters
destination
object
Required
The destination of a crypto refund.
idempotencyKey
uuid
Required
Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.
Response
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 },
30 "depositAddress": {
31 "chain": "ALGO",
32 "address": "0x97de855690955e0da79ce5c1b6804847e7070c7f",
33 "addressTag": "123456789"
34 },
35 "transactionHash": "0x7351585460bd657f320b9afa02a52c26d89272d0d10cc29913eb8b28e64fd906",
36 "createDate": "2020-04-10T02:13:30.000Z",
37 "updateDate": "2020-04-10T02:13:30.000Z",
38 "riskEvaluation": {
39 "decision": "approved",
40 "reason": "3000"
41 }
42 }
43}Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.
