Tokenize a payment method

POST

/v:version/payment-methods/tokenize

POST

/v:version/payment-methods/tokenize

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

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

Requires the PAYMENT_METHOD.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

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:

stripeobjectOptional

adyenobjectOptional

contextobjectOptional

pricing_plan_subscription_idstring or nullOptional

Resource ID of type PRICING_PLAN_SUBSCRIPTION

return_urlstring or nullOptional

Response

statusenum

Allowed values:

payment_methodobject

paymentobject

actionobject

Errors

401

Unauthorized Error

403

Forbidden Error

Authentication

Path parameters

Headers

Request

Response

Errors