Authorize a payment

POST

/v:version/payments/authorize

POST

/v:version/payments/authorize

1 curl -X POST https://api.solvimon.com/v1/payments/authorize \
2      -H "X-API-KEY: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "payment_acceptor_id": "payacc_987654321",
6   "customer_id": "cust_123456789",
7   "payment_gateway_variant": "ADYEN"
8 }'

1 {
2   "status": "SUCCESS",
3   "payment_method": {
4     "reference": "REF123456789",
5     "object_type": "payment_method",
6     "id": "pm_01F8XYZ1234567890",
7     "created_at": "2024-04-20T10:15:30Z",
8     "status": "SETUP",
9     "type": "CARD",
10     "card": {
11       "brand": "VISA",
12       "name": "John Doe",
13       "expiry_date": {
14         "expiry_month": 12,
15         "expiry_year": 2026
16       },
17       "last_four_digits": "4242",
18       "country": "US"
19     },
20     "online_banking": {
21       "variant": "SEPA",
22       "owner_name": "John Doe",
23       "iban": "DE89370400440532013000",
24       "bic": "COBADEFFXXX",
25       "country": "DE"
26     },
27     "buy_now_pay_later": {
28       "variant": "Klarna"
29     },
30     "direct_debit": {
31       "variant": "SEPA",
32       "owner_name": "John Doe",
33       "iban": "DE89370400440532013000",
34       "bic": "COBADEFFXXX",
35       "country": "DE"
36     },
37     "digital_wallet": {
38       "variant": "ApplePay"
39     },
40     "customer_id": "cust_123456789",
41     "integration_id": "int_987654321",
42     "integration_reference": "int_ref_20240420",
43     "integration_details": {
44       "payment_gateway_variant": "ADYEN",
45       "id": "intdet_123456789",
46       "reference": "int_ref_20240420",
47       "adyen": {
48         "recurring_detail_reference": "rec_det_987654321"
49       },
50       "stripe": {
51         "payment_method_id": "pm_stripe_123456789"
52       }
53     },
54     "billing_address": {
55       "line1": "123 Main St",
56       "line2": "Apt 4B",
57       "city": "Amsterdam",
58       "postal_code": "1012 WX",
59       "state": "North Holland",
60       "country": "NL"
61     },
62     "is_default": true
63   },
64   "payment": {
65     "external_reference": "extref_20240420",
66     "result": "AUTHORIZED",
67     "object_type": "payment",
68     "id": "pay_20240420101530",
69     "created_at": "2024-04-20T10:15:30Z",
70     "timestamp": "2024-04-20T10:15:30Z",
71     "customer_id": "cust_123456789",
72     "customer": {
73       "reference": "CUSTREF2024",
74       "type": "ORGANIZATION",
75       "email": "contact@acme-corp.com",
76       "roles": [
77         "DEFAULT"
78       ],
79       "object_type": "customer",
80       "id": "cust_123456789",
81       "created_at": "2023-12-01T08:00:00Z",
82       "parent_customer_id": "cust_parent_001",
83       "parent_customer_ids": [
84         "cust_parent_001",
85         "cust_grandparent_001"
86       ],
87       "status": "ACTIVE",
88       "timezone": "Europe/Amsterdam",
89       "notification_preferences": [
90         {
91           "type": "INVOICE",
92           "channels": [
93             {
94               "type": "EMAIL",
95               "enabled": true
96             }
97           ]
98         }
99       ],
100       "locale": "en_NL",
101       "individual": {
102         "name": {
103           "first_name": "John",
104           "last_name": "Doe",
105           "infix": ""
106         },
107         "residential_address": {
108           "line1": "123 Main St",
109           "line2": "Apt 4B",
110           "city": "Amsterdam",
111           "postal_code": "1012 WX",
112           "state": "North Holland",
113           "country": "NL"
114         }
115       },
116       "organization": {
117         "legal_name": "Acme Corporation",
118         "tax_id": "NL123456789B01",
119         "tax_ids": [
120           {
121             "id": "NL123456789B01",
122             "type": "VAT"
123           }
124         ],
125         "registration_number": "HR123456",
126         "tax_exempt": false,
127         "tax_exempt_note": "",
128         "registered_address": {
129           "line1": "456 Corporate Blvd",
130           "line2": "",
131           "city": "Amsterdam",
132           "postal_code": "1017 ZN",
133           "state": "North Holland",
134           "country": "NL"
135         }
136       },
137       "custom_fields": [
138         {
139           "id": "cf_001",
140           "reference": "preferred_contact",
141           "value": "email",
142           "values": [
143             "email",
144             "phone"
145           ],
146           "integration_details": {
147             "payment_gateway_variant": "ADYEN",
148             "id": "intdet_123456789",
149             "reference": "int_ref_20240420",
150             "adyen": {
151               "recurring_detail_reference": "rec_det_987654321"
152             },
153             "stripe": {
154               "payment_method_id": "pm_stripe_123456789"
155             }
156           }
157         }
158       ],
159       "processing_only": false,
160       "pricing_plan_subscription_selector": {
161         "data": [
162           {
163             "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
164             "value": "NL"
165           }
166         ],
167         "rules": [
168           {
169             "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
170             "type": "EQUALS"
171           }
172         ],
173         "filters": [
174           {
175             "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
176             "type": "EQUALS",
177             "value": "NL"
178           }
179         ],
180         "fallback": "LATEST"
181       },
182       "linked_integrations": [
183         {
184           "id": "link_001",
185           "link_details": [
186             {
187               "url": "https://integration.acme-corp.com",
188               "custom_field_name": "integration_url"
189             }
190           ]
191         }
192       ]
193     },
194     "invoice_id": "inv_20240420_001",
195     "payment_acceptor_id": "payacc_987654321",
196     "payment_acceptor_reference": "PA_REF_20240420",
197     "payment_method_id": "pm_01F8XYZ1234567890",
198     "payment_method_details": {
199       "type": "CARD",
200       "card": {
201         "brand": "VISA",
202         "name": "John Doe",
203         "expiry_date": {
204           "expiry_month": 12,
205           "expiry_year": 2026
206         },
207         "last_four_digits": "4242",
208         "country": "US"
209       },
210       "online_banking": {
211         "variant": "SEPA",
212         "owner_name": "John Doe",
213         "iban": "DE89370400440532013000",
214         "bic": "COBADEFFXXX",
215         "country": "DE"
216       },
217       "buy_now_pay_later": {
218         "variant": "Klarna"
219       },
220       "direct_debit": {
221         "variant": "SEPA",
222         "owner_name": "John Doe",
223         "iban": "DE89370400440532013000",
224         "bic": "COBADEFFXXX",
225         "country": "DE"
226       },
227       "digital_wallet": {
228         "variant": "ApplePay"
229       },
230       "unknown": {
231         "variant": "unknown_variant"
232       }
233     },
234     "integration_payment_method_reference": "intpmref_20240420",
235     "amount": {
236       "quantity": "150.00",
237       "currency": "AED"
238     },
239     "result_details": {
240       "code": "00",
241       "reason": "Approved",
242       "external_code": "AUTH_00",
243       "external_reason": "Authorization successful"
244     },
245     "dunning_action_details": {
246       "attempt": 1,
247       "external_reference": "dunning_ext_ref_001",
248       "next_attempt_scheduled": true
249     },
250     "updated_at": "2024-04-20T10:20:00Z",
251     "context": {
252       "related_resource_ids": [
253         {
254           "type": "PLATFORM",
255           "id": "platform_001"
256         }
257       ],
258       "type": "INVOICE",
259       "metadata": {},
260       "init_pricing_plan_subscription": {
261         "template_pricing_plan_subscription_id": "tpl_sub_001",
262         "pricing_plan_subscription_id": "sub_001",
263         "billing_entity_id": "bill_ent_001",
264         "customer_details": {
265           "reference": "CUSTREF2024",
266           "type": "ORGANIZATION",
267           "email": "contact@acme-corp.com",
268           "roles": [
269             "DEFAULT"
270           ],
271           "object_type": "customer",
272           "id": "cust_123456789",
273           "created_at": "2023-12-01T08:00:00Z",
274           "parent_customer_id": "cust_parent_001",
275           "parent_customer_ids": [
276             "cust_parent_001",
277             "cust_grandparent_001"
278           ],
279           "status": "ACTIVE",
280           "timezone": "Europe/Amsterdam",
281           "notification_preferences": [
282             {
283               "type": "INVOICE",
284               "channels": [
285                 {
286                   "type": "EMAIL",
287                   "enabled": true
288                 }
289               ]
290             }
291           ],
292           "locale": "en_NL",
293           "individual": {
294             "name": {
295               "first_name": "John",
296               "last_name": "Doe",
297               "infix": ""
298             },
299             "residential_address": {
300               "line1": "123 Main St",
301               "line2": "Apt 4B",
302               "city": "Amsterdam",
303               "postal_code": "1012 WX",
304               "state": "North Holland",
305               "country": "NL"
306             }
307           },
308           "organization": {
309             "legal_name": "Acme Corporation",
310             "tax_id": "NL123456789B01",
311             "tax_ids": [
312               {
313                 "id": "NL123456789B01",
314                 "type": "VAT"
315               }
316             ],
317             "registration_number": "HR123456",
318             "tax_exempt": false,
319             "tax_exempt_note": "",
320             "registered_address": {
321               "line1": "456 Corporate Blvd",
322               "line2": "",
323               "city": "Amsterdam",
324               "postal_code": "1017 ZN",
325               "state": "North Holland",
326               "country": "NL"
327             }
328           },
329           "custom_fields": [
330             {
331               "id": "cf_001",
332               "reference": "preferred_contact",
333               "value": "email",
334               "values": [
335                 "email",
336                 "phone"
337               ],
338               "integration_details": {
339                 "payment_gateway_variant": "ADYEN",
340                 "id": "intdet_123456789",
341                 "reference": "int_ref_20240420",
342                 "adyen": {
343                   "recurring_detail_reference": "rec_det_987654321"
344                 },
345                 "stripe": {
346                   "payment_method_id": "pm_stripe_123456789"
347                 }
348               }
349             }
350           ],
351           "processing_only": false,
352           "pricing_plan_subscription_selector": {
353             "data": [
354               {
355                 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
356                 "value": "NL"
357               }
358             ],
359             "rules": [
360               {
361                 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
362                 "type": "EQUALS"
363               }
364             ],
365             "filters": [
366               {
367                 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
368                 "type": "EQUALS",
369                 "value": "NL"
370               }
371             ],
372             "fallback": "LATEST"
373           },
374           "linked_integrations": [
375             {
376               "id": "link_001",
377               "link_details": [
378                 {
379                   "url": "https://integration.acme-corp.com",
380                   "custom_field_name": "integration_url"
381                 }
382               ]
383             }
384           ]
385         },
386         "pricing_plan_schedule_customizations": [
387           {
388             "pricing_plan_schedule_id": "sched_001",
389             "seats_values": [
390               {
391                 "pricing_item_config_id": "config_001",
392                 "number": "10",
393                 "amount": {
394                   "quantity": "1000.00",
395                   "currency": "AED"
396                 },
397                 "start_at": "2024-01-15T09:30:00Z",
398                 "end_at": "2024-12-31T23:59:59Z"
399               }
400             ],
401             "enabled_pricings": [
402               {
403                 "pricing_id": "pricing_001",
404                 "start_at": "2024-01-15T09:30:00Z",
405                 "end_at": "2025-01-15T09:30:00Z"
406               }
407             ],
408             "promotion_codes": [
409               "PROMO2024"
410             ],
411             "pricing_currency": "AED",
412             "billing_period": {
413               "type": "DAY",
414               "value": 1
415             }
416           }
417         ],
418         "enabled_pricings": [
419           {
420             "pricing_id": "pricing_001",
421             "start_at": "2024-01-15T09:30:00Z",
422             "end_at": "2025-01-15T09:30:00Z"
423           }
424         ]
425       },
426       "create_payment_method": {
427         "payment_method_id": "pm_01F8XYZ1234567890"
428       },
429       "payment_request": {
430         "payment_request_id": "pr_20240420_001"
431       }
432     }
433   },
434   "action": {
435     "url": "https://paymentgateway.com/authorize",
436     "method": "POST",
437     "payment_gateway_variant": "ADYEN",
438     "data": {},
439     "adyen": {
440       "result_code": "Authorised",
441       "action_type": "redirect",
442       "payment_data": "Ab02b4c0!BQABAgC...",
443       "payment_method_type": "scheme",
444       "sdk_data": {}
445     },
446     "stripe": {
447       "status": "requires_action",
448       "next_action": {
449         "type": "redirect_to_url",
450         "redirect_to_url": {
451           "return_url": "https://merchant.com/return",
452           "url": "https://hooks.stripe.com/3d_secure/authenticate"
453         }
454       }
455     }
456   }
457 }

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_idstringRequired

Resource ID of type CUSTOMER

payment_gateway_variantenumRequired

Allowed values:

payment_method_idstring or nullOptional

stripeobjectOptional

adyenobjectOptional

amountobjectOptional

referencestring or nullOptional

contextobjectOptional

return_urlstring or nullOptional

Response

statusenum

Allowed values:

payment_methodobject

paymentobject

actionobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

Authentication

Path parameters

Headers

Request

Response

Errors