Refund a payment

POST

/v:version/payments/:resourceId/refund

POST

/v:version/payments/:resourceId/refund

1 curl -X POST https://api.solvimon.com/v1/payments//refund \
2      -H "X-API-KEY: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "external_reference": "string",
3   "result": "AUTHORIZED",
4   "object_type": "string",
5   "id": "string",
6   "created_at": "string",
7   "timestamp": "2024-01-15T09:30:00Z",
8   "customer_id": "string",
9   "customer": {
10     "reference": "string",
11     "type": "ORGANIZATION",
12     "email": "string",
13     "roles": [
14       "DEFAULT"
15     ],
16     "object_type": "string",
17     "id": "string",
18     "created_at": "string",
19     "parent_customer_id": "string",
20     "parent_customer_ids": [
21       "string"
22     ],
23     "status": "DRAFT",
24     "timezone": "string",
25     "notification_preferences": [
26       {
27         "type": "INVOICE",
28         "channels": [
29           {
30             "type": "EMAIL",
31             "enabled": true
32           }
33         ]
34       }
35     ],
36     "locale": "string",
37     "individual": {
38       "name": {
39         "first_name": "string",
40         "last_name": "string",
41         "infix": "string"
42       },
43       "residential_address": {
44         "line1": "string",
45         "line2": "string",
46         "city": "string",
47         "postal_code": "string",
48         "state": "string",
49         "country": "AD"
50       }
51     },
52     "organization": {
53       "legal_name": "string",
54       "tax_id": "string",
55       "tax_ids": [
56         {
57           "id": "string",
58           "type": "GENERIC_TAX_ID",
59           "tax_id_validation_result": {
60             "id": "string",
61             "validation_date": "string",
62             "source": "string",
63             "valid": "VALID",
64             "message": "string"
65           }
66         }
67       ],
68       "registration_number": "string",
69       "tax_exempt": true,
70       "tax_exempt_note": "string",
71       "registered_address": {
72         "line1": "string",
73         "line2": "string",
74         "city": "string",
75         "postal_code": "string",
76         "state": "string",
77         "country": "AD"
78       },
79       "tax_registrations": [
80         {
81           "id": "string",
82           "description": "string",
83           "tax_id": "string",
84           "tax_ids": [
85             {
86               "id": "string",
87               "type": "GENERIC_TAX_ID",
88               "tax_id_validation_result": {
89                 "id": "string",
90                 "validation_date": "string",
91                 "source": "string",
92                 "valid": "VALID",
93                 "message": "string"
94               }
95             }
96           ],
97           "registration_number": "string",
98           "registered_address": {
99             "line1": "string",
100             "line2": "string",
101             "city": "string",
102             "postal_code": "string",
103             "state": "string",
104             "country": "AD"
105           }
106         }
107       ]
108     },
109     "custom_fields": [
110       {
111         "id": "string",
112         "reference": "string",
113         "value": "string",
114         "values": [
115           "string"
116         ],
117         "integration_details": {
118           "payment_gateway_variant": "ADYEN",
119           "id": "string",
120           "reference": "string",
121           "adyen": {
122             "recurring_detail_reference": "string"
123           },
124           "stripe": {
125             "payment_method_id": "string"
126           }
127         }
128       }
129     ],
130     "processing_only": true,
131     "pricing_plan_subscription_selector": {
132       "data": [
133         {
134           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
135           "value": "string"
136         }
137       ],
138       "rules": [
139         {
140           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
141           "type": "EQUALS"
142         }
143       ],
144       "filters": [
145         {
146           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
147           "type": "EQUALS",
148           "value": "string"
149         }
150       ],
151       "fallback": "LATEST"
152     },
153     "linked_integrations": [
154       {
155         "id": "string",
156         "link_details": [
157           {
158             "url": "string",
159             "custom_field_name": "string"
160           }
161         ]
162       }
163     ]
164   },
165   "invoice_id": "string",
166   "payment_acceptor_id": "string",
167   "payment_acceptor_reference": "string",
168   "payment_method_id": "string",
169   "payment_method_details": {
170     "type": "CARD",
171     "card": {
172       "brand": "string",
173       "name": "string",
174       "expiry_date": {
175         "expiry_month": 1,
176         "expiry_year": 1
177       },
178       "last_four_digits": "string",
179       "country": "string"
180     },
181     "online_banking": {
182       "variant": "string",
183       "owner_name": "string",
184       "iban": "string",
185       "bic": "string",
186       "country": "AD"
187     },
188     "buy_now_pay_later": {
189       "variant": "string"
190     },
191     "direct_debit": {
192       "variant": "string",
193       "owner_name": "string",
194       "iban": "string",
195       "bic": "string",
196       "country": "AD"
197     },
198     "digital_wallet": {
199       "variant": "string"
200     },
201     "unknown": {
202       "variant": "string"
203     }
204   },
205   "integration_payment_method_reference": "string",
206   "amount": {
207     "quantity": "string",
208     "currency": "AED"
209   },
210   "result_details": {
211     "code": "string",
212     "reason": "string",
213     "external_code": "string",
214     "external_reason": "string"
215   },
216   "dunning_action_details": {
217     "attempt": 1,
218     "external_reference": "string",
219     "next_attempt_scheduled": true
220   },
221   "updated_at": "string",
222   "context": {
223     "related_resource_ids": [
224       {
225         "type": "PLATFORM",
226         "id": "string"
227       }
228     ],
229     "type": "INVOICE",
230     "metadata": {},
231     "init_pricing_plan_subscription": {
232       "template_pricing_plan_subscription_id": "string",
233       "pricing_plan_subscription_id": "string",
234       "billing_entity_id": "string",
235       "customer_details": {
236         "reference": "string",
237         "type": "ORGANIZATION",
238         "email": "string",
239         "roles": [
240           "DEFAULT"
241         ],
242         "object_type": "string",
243         "id": "string",
244         "created_at": "string",
245         "parent_customer_id": "string",
246         "parent_customer_ids": [
247           "string"
248         ],
249         "status": "DRAFT",
250         "timezone": "string",
251         "notification_preferences": [
252           {
253             "type": "INVOICE",
254             "channels": [
255               {
256                 "type": "EMAIL",
257                 "enabled": true
258               }
259             ]
260           }
261         ],
262         "locale": "string",
263         "individual": {
264           "name": {
265             "first_name": "string",
266             "last_name": "string",
267             "infix": "string"
268           },
269           "residential_address": {
270             "line1": "string",
271             "line2": "string",
272             "city": "string",
273             "postal_code": "string",
274             "state": "string",
275             "country": "AD"
276           }
277         },
278         "organization": {
279           "legal_name": "string",
280           "tax_id": "string",
281           "tax_ids": [
282             {
283               "id": "string",
284               "type": "GENERIC_TAX_ID",
285               "tax_id_validation_result": {
286                 "id": "string",
287                 "validation_date": "string",
288                 "source": "string",
289                 "valid": "VALID",
290                 "message": "string"
291               }
292             }
293           ],
294           "registration_number": "string",
295           "tax_exempt": true,
296           "tax_exempt_note": "string",
297           "registered_address": {
298             "line1": "string",
299             "line2": "string",
300             "city": "string",
301             "postal_code": "string",
302             "state": "string",
303             "country": "AD"
304           },
305           "tax_registrations": [
306             {
307               "id": "string",
308               "description": "string",
309               "tax_id": "string",
310               "tax_ids": [
311                 {
312                   "id": "string",
313                   "type": "GENERIC_TAX_ID",
314                   "tax_id_validation_result": {
315                     "id": "string",
316                     "validation_date": "string",
317                     "source": "string",
318                     "valid": "VALID",
319                     "message": "string"
320                   }
321                 }
322               ],
323               "registration_number": "string",
324               "registered_address": {
325                 "line1": "string",
326                 "line2": "string",
327                 "city": "string",
328                 "postal_code": "string",
329                 "state": "string",
330                 "country": "AD"
331               }
332             }
333           ]
334         },
335         "custom_fields": [
336           {
337             "id": "string",
338             "reference": "string",
339             "value": "string",
340             "values": [
341               "string"
342             ],
343             "integration_details": {
344               "payment_gateway_variant": "ADYEN",
345               "id": "string",
346               "reference": "string",
347               "adyen": {
348                 "recurring_detail_reference": "string"
349               },
350               "stripe": {
351                 "payment_method_id": "string"
352               }
353             }
354           }
355         ],
356         "processing_only": true,
357         "pricing_plan_subscription_selector": {
358           "data": [
359             {
360               "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
361               "value": "string"
362             }
363           ],
364           "rules": [
365             {
366               "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
367               "type": "EQUALS"
368             }
369           ],
370           "filters": [
371             {
372               "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
373               "type": "EQUALS",
374               "value": "string"
375             }
376           ],
377           "fallback": "LATEST"
378         },
379         "linked_integrations": [
380           {
381             "id": "string",
382             "link_details": [
383               {
384                 "url": "string",
385                 "custom_field_name": "string"
386               }
387             ]
388           }
389         ]
390       },
391       "pricing_plan_schedule_customizations": [
392         {
393           "pricing_plan_schedule_id": "string",
394           "seats_values": [
395             {
396               "pricing_item_config_id": "string",
397               "number": "string",
398               "amount": {
399                 "quantity": "string",
400                 "currency": "AED"
401               },
402               "start_at": "2024-01-15T09:30:00Z",
403               "end_at": "string"
404             }
405           ],
406           "enabled_pricings": [
407             {
408               "pricing_id": "string",
409               "start_at": "2024-01-15T09:30:00Z",
410               "end_at": "2024-01-15T09:30:00Z"
411             }
412           ],
413           "promotion_codes": [
414             "string"
415           ],
416           "pricing_currency": "AED",
417           "billing_period": {
418             "type": "DAY",
419             "value": 1
420           }
421         }
422       ],
423       "enabled_pricings": [
424         {
425           "pricing_id": "string",
426           "start_at": "2024-01-15T09:30:00Z",
427           "end_at": "2024-01-15T09:30:00Z"
428         }
429       ]
430     },
431     "create_payment_method": {
432       "payment_method_id": "string"
433     },
434     "payment_request": {
435       "payment_request_id": "string"
436     }
437   }
438 }

Requires the PAYMENT.REFUND permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource for which the action is posted.

Request

This endpoint expects an object.

amountobjectOptional

Response

external_referencestringformat: "^[a-zA-Z0-9]*"0-256 characters

resultenum

object_typestring or nullRead-only

idstring or nullRead-only

created_atstring or nullRead-only

timestampdatetime or null

customer_idstring or null

customerobject or null

invoice_idstring or null

Resource ID of type INVOICE

payment_acceptor_idstring or null

Resource ID of type PAYMENT_ACCEPTOR

payment_acceptor_referencestring or null

payment_method_idstring or null

Resource ID of type PAYMENT_METHOD

payment_method_detailsobject

integration_payment_method_referencestring or null

amountobject

result_detailsobject

dunning_action_detailsobject

updated_atstring or nullRead-only

contextobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors