Reverse a payment

POST

/v:version/payments/:resourceId/reverse

POST

/v:version/payments/:resourceId/reverse

$ curl -X POST https://api.solvimon.com/v1/payments//reverse \
>      -H "X-API-KEY: <apiKey>"

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

Requires the PAYMENT.REVERSE 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.

Headers

x-platform-idstringOptional

Platform ID.

Response

paymentobject

statusenum

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error