Create a payment schedule

POST

/v:version/payment-schedules

POST

/v:version/payment-schedules

$ curl -X POST https://api.solvimon.com/v1/payment-schedules \
>      -H "X-API-KEY: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "customer_id": "string",
>   "reference": "string",
>   "payment_method_id": "string",
>   "billing_entity_id": "string",
>   "type": "INSTALLMENTS"
> }'

1 {
2   "object_type": "string",
3   "id": "string",
4   "created_at": "string",
5   "updated_at": "string",
6   "status": "ACTIVE",
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   "reference": "string",
171   "description": "string",
172   "statement_descriptor": "string",
173   "payment_method_id": "string",
174   "payment_method": {
175     "object_type": "string",
176     "id": "string",
177     "created_at": "string",
178     "updated_at": "string",
179     "reference": "string",
180     "status": "SETUP",
181     "type": "CARD",
182     "card": {
183       "brand": "ACCEL",
184       "name": "string",
185       "expiry_date": {
186         "expiry_month": 1,
187         "expiry_year": 1
188       },
189       "last_four_digits": "string",
190       "country": "string"
191     },
192     "online_banking": {
193       "variant": "string",
194       "owner_name": "string",
195       "iban": "string",
196       "bic": "string",
197       "country": "AD"
198     },
199     "buy_now_pay_later": {
200       "variant": "string"
201     },
202     "direct_debit": {
203       "variant": "string",
204       "owner_name": "string",
205       "iban": "string",
206       "bic": "string",
207       "country": "AD"
208     },
209     "digital_wallet": {
210       "variant": "string"
211     },
212     "customer_id": "string",
213     "integration_id": "string",
214     "integration_reference": "string",
215     "integration_details": {
216       "id": "string",
217       "reference": "string",
218       "payment_gateway_variant": "ADYEN",
219       "adyen": {
220         "recurring_detail_reference": "string"
221       },
222       "stripe": {
223         "payment_method_id": "string"
224       }
225     },
226     "billing_address": {
227       "line1": "string",
228       "line2": "string",
229       "city": "string",
230       "postal_code": "string",
231       "state": "string",
232       "country": "AD"
233     },
234     "is_default": true
235   },
236   "billing_entity_id": "string",
237   "dunning": {
238     "enabled": true
239   },
240   "payment_method_fallback": {
241     "enabled": true,
242     "payment_method_ids": [
243       "string"
244     ]
245   },
246   "type": "INSTALLMENTS",
247   "installments": {
248     "total_amount": {
249       "quantity": "string",
250       "currency": "AED"
251     },
252     "variant": "INTERVAL",
253     "number_of_installments": 1,
254     "interval": {
255       "start_at": "2024-01-15T09:30:00Z",
256       "period": {
257         "type": "DAY",
258         "value": 1
259       },
260       "charges": [
261         {
262           "charge_at": "2024-01-15T09:30:00Z",
263           "amount": {
264             "quantity": "string",
265             "currency": "AED"
266           }
267         }
268       ]
269     },
270     "fixed": {
271       "charges": [
272         {
273           "charge_at": "2024-01-15T09:30:00Z",
274           "amount": {
275             "quantity": "string",
276             "currency": "AED"
277           }
278         }
279       ]
280     }
281   },
282   "recurring": {
283     "charge": {
284       "charge_at": "2024-01-15T09:30:00Z",
285       "amount": {
286         "quantity": "string",
287         "currency": "AED"
288       }
289     },
290     "start_at": "2024-01-15T09:30:00Z",
291     "end_at": "2024-01-15T09:30:00Z",
292     "period": {
293       "type": "DAY",
294       "value": 1
295     }
296   },
297   "one_off": {
298     "charge": {
299       "charge_at": "2024-01-15T09:30:00Z",
300       "amount": {
301         "quantity": "string",
302         "currency": "AED"
303       }
304     }
305   },
306   "seller_details": {
307     "seller_customer_id": "string"
308   }
309 }

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

customer_idstringRequired

Resource ID of type CUSTOMER

referencestringRequiredformat: "^\S+$"0-256 characters

payment_method_idstringRequired

Resource ID of type PAYMENT_METHOD

billing_entity_idstringRequired

Resource ID of type BILLING_ENTITY

typeenumRequired

customerobject or nullOptional

descriptionstring or nullOptional

statement_descriptorstring or nullOptional

payment_methodobject or nullOptional

dunningobjectOptional

payment_method_fallbackobjectOptional

installmentsobjectOptional

recurringobjectOptional

one_offobjectOptional

seller_detailsobjectOptional

Response

object_typestring or nullOptionalRead-only

idstring or nullOptionalRead-only

created_atstring or nullOptionalRead-only

updated_atstring or nullOptionalRead-only

statusenum or nullOptionalRead-only

customer_idstringOptional

Resource ID of type CUSTOMER

customerobject or nullOptional

referencestringOptionalformat: "^\S+$"0-256 characters

descriptionstring or nullOptional

statement_descriptorstring or nullOptional

payment_method_idstringOptional

Resource ID of type PAYMENT_METHOD

payment_methodobject or nullOptional

billing_entity_idstringOptional

Resource ID of type BILLING_ENTITY

dunningobjectOptional

payment_method_fallbackobjectOptional

typeenumOptional

installmentsobjectOptional

recurringobjectOptional

one_offobjectOptional

seller_detailsobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors