Authorize a payment

POST

/v:version/payments/authorize

POST

/v:version/payments/authorize

$ curl -X POST https://api.solvimon.com/v1/payments/authorize \
>      -H "X-API-KEY: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "payment_acceptor_id": "string"
> }'

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

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

Request

This endpoint expects an object.

payment_acceptor_idstringRequired

Resource ID of type PAYMENT_ACCEPTOR

customer_idstringOptional

Resource ID of type CUSTOMER

payment_method_idstring or nullOptional

payment_gateway_variantenumOptional

stripeobjectOptional

adyenobjectOptional

amountobjectOptional

referencestring or nullOptional

contextobjectOptional

return_urlstring or nullOptional

Response

payment_methodobject

paymentobject

statusenum

actionobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

Authentication

Path parameters

Headers

Request

Response

Errors