Create a payment

POST

/v:version/payments

POST

/v:version/payments

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

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

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

Headers

x-platform-idstringOptional

Platform ID.

Request

This endpoint expects an object.

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

resultenumRequired

timestampdatetime or nullOptional

customer_idstring or nullOptional

customerobject or nullOptional

invoice_idstring or nullOptional

Resource ID of type INVOICE

payment_acceptor_idstring or nullOptional

Resource ID of type PAYMENT_ACCEPTOR

payment_acceptor_referencestring or nullOptional

payment_method_idstring or nullOptional

Resource ID of type PAYMENT_METHOD

payment_method_detailsobjectOptional

integration_payment_method_referencestring or nullOptional

amountobjectOptional

result_detailsobjectOptional

dunning_action_detailsobjectOptional

contextobjectOptional

Response

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

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

amountobject

resultenum

result_detailsobject

dunning_action_detailsobject

updated_atstring or nullRead-only

contextobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error