Create a payment schedule

POST

/v:version/payment-schedules

POST

/v:version/payment-schedules

1 curl -X POST https://api.solvimon.com/v1/payment-schedules \
2      -H "X-API-KEY: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "customer_id": "string",
6   "reference": "string",
7   "payment_method_id": "string",
8   "billing_entity_id": "string",
9   "type": "INSTALLMENTS"
10 }'

1 {
2   "customer_id": "string",
3   "reference": "string",
4   "payment_method_id": "string",
5   "billing_entity_id": "string",
6   "type": "INSTALLMENTS",
7   "object_type": "string",
8   "id": "string",
9   "created_at": "string",
10   "updated_at": "string",
11   "status": "ACTIVE",
12   "customer": {
13     "reference": "string",
14     "type": "ORGANIZATION",
15     "email": "string",
16     "roles": [
17       "DEFAULT"
18     ],
19     "object_type": "string",
20     "id": "string",
21     "created_at": "string",
22     "parent_customer_id": "string",
23     "parent_customer_ids": [
24       "string"
25     ],
26     "status": "DRAFT",
27     "timezone": "string",
28     "notification_preferences": [
29       {
30         "type": "INVOICE",
31         "channels": [
32           {
33             "type": "EMAIL",
34             "enabled": true
35           }
36         ]
37       }
38     ],
39     "locale": "string",
40     "individual": {
41       "name": {
42         "first_name": "string",
43         "last_name": "string",
44         "infix": "string"
45       },
46       "residential_address": {
47         "line1": "string",
48         "line2": "string",
49         "city": "string",
50         "postal_code": "string",
51         "state": "string",
52         "country": "AD"
53       }
54     },
55     "organization": {
56       "legal_name": "string",
57       "tax_id": "string",
58       "tax_ids": [
59         {
60           "id": "string",
61           "type": "GENERIC_TAX_ID",
62           "tax_id_validation_result": {
63             "id": "string",
64             "validation_date": "string",
65             "source": "string",
66             "valid": "VALID",
67             "message": "string"
68           }
69         }
70       ],
71       "registration_number": "string",
72       "tax_exempt": true,
73       "tax_exempt_note": "string",
74       "registered_address": {
75         "line1": "string",
76         "line2": "string",
77         "city": "string",
78         "postal_code": "string",
79         "state": "string",
80         "country": "AD"
81       },
82       "tax_registrations": [
83         {
84           "id": "string",
85           "description": "string",
86           "tax_id": "string",
87           "tax_ids": [
88             {
89               "id": "string",
90               "type": "GENERIC_TAX_ID",
91               "tax_id_validation_result": {
92                 "id": "string",
93                 "validation_date": "string",
94                 "source": "string",
95                 "valid": "VALID",
96                 "message": "string"
97               }
98             }
99           ],
100           "registration_number": "string",
101           "registered_address": {
102             "line1": "string",
103             "line2": "string",
104             "city": "string",
105             "postal_code": "string",
106             "state": "string",
107             "country": "AD"
108           }
109         }
110       ]
111     },
112     "custom_fields": [
113       {
114         "id": "string",
115         "reference": "string",
116         "value": "string",
117         "values": [
118           "string"
119         ],
120         "integration_details": {
121           "payment_gateway_variant": "ADYEN",
122           "id": "string",
123           "reference": "string",
124           "adyen": {
125             "recurring_detail_reference": "string"
126           },
127           "stripe": {
128             "payment_method_id": "string"
129           }
130         }
131       }
132     ],
133     "processing_only": true,
134     "pricing_plan_subscription_selector": {
135       "data": [
136         {
137           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
138           "value": "string"
139         }
140       ],
141       "rules": [
142         {
143           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
144           "type": "EQUALS"
145         }
146       ],
147       "filters": [
148         {
149           "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
150           "type": "EQUALS",
151           "value": "string"
152         }
153       ],
154       "fallback": "LATEST"
155     },
156     "linked_integrations": [
157       {
158         "id": "string",
159         "link_details": [
160           {
161             "url": "string",
162             "custom_field_name": "string"
163           }
164         ]
165       }
166     ]
167   },
168   "description": "string",
169   "statement_descriptor": "string",
170   "payment_method": {
171     "reference": "string",
172     "object_type": "string",
173     "id": "string",
174     "created_at": "string",
175     "status": "SETUP",
176     "type": "CARD",
177     "card": {
178       "brand": "ACCEL",
179       "name": "string",
180       "expiry_date": {
181         "expiry_month": 1,
182         "expiry_year": 1
183       },
184       "last_four_digits": "string",
185       "country": "string"
186     },
187     "online_banking": {
188       "variant": "string",
189       "owner_name": "string",
190       "iban": "string",
191       "bic": "string",
192       "country": "AD"
193     },
194     "buy_now_pay_later": {
195       "variant": "string"
196     },
197     "direct_debit": {
198       "variant": "string",
199       "owner_name": "string",
200       "iban": "string",
201       "bic": "string",
202       "country": "AD"
203     },
204     "digital_wallet": {
205       "variant": "string"
206     },
207     "customer_id": "string",
208     "integration_id": "string",
209     "integration_reference": "string",
210     "integration_details": {
211       "payment_gateway_variant": "ADYEN",
212       "id": "string",
213       "reference": "string",
214       "adyen": {
215         "recurring_detail_reference": "string"
216       },
217       "stripe": {
218         "payment_method_id": "string"
219       }
220     },
221     "billing_address": {
222       "line1": "string",
223       "line2": "string",
224       "city": "string",
225       "postal_code": "string",
226       "state": "string",
227       "country": "AD"
228     },
229     "is_default": true
230   },
231   "dunning": {
232     "enabled": true
233   },
234   "payment_method_fallback": {
235     "enabled": true,
236     "payment_method_ids": [
237       "string"
238     ]
239   },
240   "installments": {
241     "variant": "INTERVAL",
242     "number_of_installments": 1,
243     "total_amount": {
244       "quantity": "string",
245       "currency": "AED"
246     },
247     "interval": {
248       "charges": [
249         {
250           "charge_at": "2024-01-15T09:30:00Z",
251           "amount": {
252             "quantity": "string",
253             "currency": "AED"
254           }
255         }
256       ],
257       "start_at": "2024-01-15T09:30:00Z",
258       "period": {
259         "type": "DAY",
260         "value": 1
261       }
262     },
263     "fixed": {
264       "charges": [
265         {
266           "charge_at": "2024-01-15T09:30:00Z",
267           "amount": {
268             "quantity": "string",
269             "currency": "AED"
270           }
271         }
272       ]
273     }
274   },
275   "recurring": {
276     "start_at": "2024-01-15T09:30:00Z",
277     "charge": {
278       "charge_at": "2024-01-15T09:30:00Z",
279       "amount": {
280         "quantity": "string",
281         "currency": "AED"
282       }
283     },
284     "end_at": "2024-01-15T09:30:00Z",
285     "period": {
286       "type": "DAY",
287       "value": 1
288     }
289   },
290   "one_off": {
291     "charge": {
292       "charge_at": "2024-01-15T09:30:00Z",
293       "amount": {
294         "quantity": "string",
295         "currency": "AED"
296       }
297     }
298   }
299 }

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

Allowed values:

customerobject or nullOptional

descriptionstring or nullOptional

statement_descriptorstring or nullOptional

payment_methodobject or nullOptional

dunningobjectOptional

payment_method_fallbackobjectOptional

installmentsobjectOptional

recurringobjectOptional

one_offobjectOptional

Response

customer_idstring

Resource ID of type CUSTOMER

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

payment_method_idstring

Resource ID of type PAYMENT_METHOD

billing_entity_idstring

Resource ID of type BILLING_ENTITY

typeenum

Allowed values:

object_typestring or nullRead-only

idstring or nullRead-only

created_atstring or nullRead-only

updated_atstring or nullRead-only

statusenum or nullRead-only

Allowed values:

customerobject or null

descriptionstring or null

statement_descriptorstring or null

payment_methodobject or null

dunningobject

payment_method_fallbackobject

installmentsobject

recurringobject

one_offobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors