Changes for page ../account

Last modified by David Persson on 2023/08/25 14:25
From empty
To version 49.1
edited by Rasmus Enekvist
on 2023/05/04 13:09
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +../account
Parent
... ... @@ -1,0 +1,1 @@
1 +Main.credit-account.api.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +xwiki:XWiki.rae
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Tags
... ... @@ -1,0 +1,1 @@
1 +px-custom-page-content
Content
... ... @@ -1,0 +1,994 @@
1 +(% class="jumbotron" %)
2 +(((
3 +(% class="container" %)
4 +(((
5 +Integrate to **PayEx Account API **
6 +)))
7 +)))
8 +
9 +=== Changelog ===
10 +
11 +
12 +(% id="HRoutesegments" %)
13 +== Introduction ==
14 +
15 +(% class="lead" %)
16 +This api is used to retrieve information and to change properties related to the customer's account.
17 +
18 +[[image:Account.API diagram.jpeg||alt="Account.API.png"]]
19 +
20 +
21 +Each resource in the API corresponds to its own route. All routes are structured according to a specific standard, explained below
22 +
23 +The below route is an example of a route towards resource3Id, to operate on this resource you must also include the ids of its parentresources in the route.
24 +//api.payex.com/ledger/**{Subdomain}**/v1/**{LedgerNumber}**/resource1/**{resource1Id}**/resource2/**{resource2Id}**/resource3/**{resource3Id}**//
25 +
26 +(% class="table-bordered table-striped" %)
27 +|=(% style="width: 604px;" %)Route segment|=(% style="width: 2790px;" %)Description
28 +|(% style="width:604px" %)Subdomain|(% style="width:2790px" %)In this part of the API it will be account
29 +|(% style="width:604px" %)LedgerNumber|(% style="width:2790px" %)The ledger identifier/number at PayEx
30 +|(% style="width:604px" %)resource1Id|(% style="width:2790px" %)Identifier of resource1
31 +|(% style="width:604px" %)resource2Id|(% style="width:2790px" %)identifier of resource2, subresource to resource1
32 +|(% style="width:604px" %)resource3Id|(% style="width:2790px" %)identifier of resource3, subresource to resource2
33 +
34 +(% class="wikigeneratedid" %)
35 +Routes that occurs in examples of this documentation will use the following identifiers
36 +
37 +(% class="table-bordered table-striped" %)
38 +|=(% style="width: 488px;" %)Resource|=(% style="width: 2271px;" %)Identifier
39 +|(% style="width:488px" %)LedgerNumber|(% style="width:2271px" %)XXX
40 +|(% style="width:488px" %)Accounts|(% style="width:2271px" %)NNN
41 +|(% style="width:488px" %)Bills|(% style="width:2271px" %)reminder-123
42 +bill-456
43 +|(% style="width:488px" %)Cards|(% style="width:2271px" %)954c8699-b38f-47a2-b568-668b8837dad8
44 +274c8699-b38f-47a2-b568-668b8837dat7
45 +
46 +== Accounts ==
47 +
48 +The **accounts** resource is located under **ledger/account/v1/ **api**. **The accounts- and its sub-resources are used to create, read and modify information related to a account.
49 +The accounts resource provides an overview of the end customer's account, it contains information such as current balance, credit limit etc. The resource also contains URIs for additional sub-resources such as bills, cards, recurring payments, etc.
50 +
51 +The following operations is supported
52 +
53 +* Change the account credit limit
54 +* Add extra cards
55 +* Request cancellation of account
56 +* Turn on/off charity donation
57 +* Set behaviour of recurring payments
58 +
59 +==== Get a list of accounts ====
60 +
61 +==== ====
62 +
63 +These querystring parameters are optional. preferably select one or the other, If both accountNo and customerNo is provided in querystring accountNo have to belong to the customerNo
64 +
65 +{{code language="http" title="**Request**"}}
66 +GET /ledger/account/v1/XXX/accounts?accountNo=123&customerNo=456 HTTP/1.1
67 +Host: -
68 +Authorization: Bearer <Token>
69 +Content-Type: application/json
70 +{{/code}}
71 +
72 +
73 +{{code language="http" title="**Response**"}}
74 +HTTP/1.1 200 OK
75 +Content-Type: application/json
76 +{
77 + "items": [
78 + {
79 + "@id": "/ledger/account/v1/XXX/accounts/NNN",
80 + "accountNo": "1234567",
81 + "startDate": "2018-05-21",
82 + "description": null,
83 + "accountProfileType": "accountType1 | accountType2 | accountType3 etc.",
84 + "accountAlias" : "accountAlias1 | accountAlias2 etc.",
85 + "customerNo" : "123789654",
86 + "status" : "Open | PendingClose | Closed",
87 + "creditLimit": 2000.00,
88 + "totalBalance" : -1900.00,
89 + "reservedAmount": 50.00,
90 + "availableAmount": 3850.00,
91 + "maxPaymentAmount": 51900.00,
92 + "openBill" : "/ledger/account/v1/XXX/accounts/NNN/bills/reminder-456",
93 + "charityDonation": true,
94 + "interestRate": {
95 + "debtInterest" : 10.00,
96 + "penaltyInterest": 15.00
97 + },
98 + "bankPayment": {
99 + "bankAccountNo": "123",
100 + "bankAccountType": "BGSE",
101 + "bic": "123456",
102 + "iban": "SE12345678945631",
103 + "paymentReference": "54867165675646"
104 + },
105 + "activePaymentOrders": "/ledger/account/v1/XXX/accounts/NNN/active-payment-orders",
106 + "recurringPaymentConfiguration": "/ledger/account/v1/XXX/accounts/NNN/recurring-payment-configuration",
107 + "cards": "/ledger/account/v1/XXX/accounts/123456/cards",
108 + "transactions": "/ledger/account/v1/XXX/accounts/NNN/transactions",
109 + "currency": "sek",
110 + "bills": "/ledger/account/v1/XXX/accounts/NNN/bills",
111 + "customer": "/ledger/customers/v1/XXX/customer/123456",
112 + "operation" : [
113 + {
114 + "rel" : "add-card-info",
115 + "method" : "post",
116 + "href" : "/ledger/account/v1/XXX/accounts/NNN/cards"
117 + },
118 + {
119 + "rel" : "request-close-account",
120 + "method" : "post",
121 + "href" : "/ledger/account/v1/XXX/accounts/NNN/request-close-account"
122 + },
123 + {
124 + "rel" : "apply-for-raised-credit-limit",
125 + "method" : "post",
126 + "href" : "/ledger/account-onboardings/v1/XXX/accounts/NNN/apply-for-raised-credit-limit"
127 + },
128 + {
129 + "rel" : "partial-update",
130 + "method" : "patch",
131 + "href" : "/ledger/account-onboardings/v1/XXX/accounts/NNN"
132 + }
133 + ]
134 + }
135 + ],
136 + "navigation": {
137 + "@id": "/ledger/account/v1/XXX/accounts",
138 + "first": "/ledger/account/v1/XXX/accounts?skip=0",
139 + "previous": "/ledger/account/v1/XXX/accounts?skip=0"
140 + }
141 +}
142 +{{/code}}
143 +
144 +==== Get a specific account ====
145 +
146 +==== ====
147 +
148 +{{code language="http" title="**Request**"}}
149 +GET /ledger/account/v1/XXX/accounts/NNN HTTP/1.1
150 +Host: -
151 +Authorization: Bearer <Token>
152 +Content-Type: application/json
153 +{{/code}}
154 +
155 +
156 +{{code language="http" title="**Response**"}}
157 +HTTP/1.1 200 OK
158 +Content-Type: application/json
159 +
160 +{
161 + "@id": "/ledger/account/v1/XXX/accounts/NNN",
162 + "accountNo": "1234567",
163 + "startDate": "2018-05-21",
164 + "description": null,
165 + "accountProfileType": "accountType1 | accountType2 | accountType3 etc.",
166 + "accountAlias" : "accountAlias1 | accountAlias2 etc.",
167 + "customerNo" : "123789654",
168 + "status" : "Open | PendingClose | Closed",
169 + "creditLimit": 2000.00,
170 + "totalBalance" : -1900.0,
171 + "reservedAmount": 50.0,
172 + "availableAmount": 3850.0,
173 + "maxPaymentAmount": 51900.0,
174 + "openBill" : "/ledger/account/v1/XXX/accounts/NNN/bills/reminder-456",
175 + "charityDonation": true,
176 + "interestRate": {
177 + "debtInterest" : 10.00,
178 + "penaltyInterest": 15.00
179 + },
180 + "bankPayment": {
181 + "bankAccountNo": "123",
182 + "bankAccountType": "BGSE",
183 + "bic": "123456",
184 + "iban": "SE12345678945631",
185 + "paymentReference": "54867165675646"
186 + },
187 + "activePaymentOrders": "/ledger/account/v1/XXX/accounts/NNN/active-payment-orders",
188 + "recurringPaymentConfiguration": "/ledger/account/v1/XXX/accounts/NNN/recurring-payment-configuration",
189 + "cards": "/ledger/account/v1/XXX/accounts/123456/cards",
190 + "transactions": "/ledger/account/v1/XXX/accounts/NNN/transactions",
191 + "currency": "sek",
192 + "bills": "/ledger/account/v1/XXX/accounts/NNN/bills",
193 + "customer": "/ledger/customers/v1/XXX/customer/123456",
194 + "operation" : [
195 + {
196 + "rel" : "add-card-info",
197 + "method" : "post",
198 + "href" : "/ledger/account/v1/XXX/accounts/NNN/cards"
199 + },
200 + {
201 + "rel" : "request-close-account",
202 + "method" : "post",
203 + "href" : "/ledger/account/v1/XXX/accounts/NNN/request-close-account"
204 + },
205 + {
206 + "rel" : "apply-for-raised-credit-limit",
207 + "method" : "post",
208 + "href" : "/ledger/account-onboardings/v1/XXX/accounts/NNN/apply-for-raised-credit-limit"
209 + },
210 + {
211 + "rel" : "partial-update",
212 + "method" : "patch",
213 + "href" : "/ledger/account-onboardings/v1/XXX/accounts/NNN"
214 + }
215 + ]
216 +}
217 +{{/code}}
218 +
219 +==== Change charitydonation ====
220 +
221 +{{code language="http" title="**Request**"}}
222 +PATCH /ledger/account/v1/XXX/accounts/NNN HTTP/1.1
223 +Host: -
224 +Authorization: Bearer <Token>
225 +Content-Type: application/json
226 +
227 +{
228 + "charityDonation": false
229 +}
230 +{{/code}}
231 +
232 +
233 +{{code language="http" title="**Response**"}}
234 +HTTP/1.1 204 NO CONTENT
235 +Content-Type: application/json
236 +
237 +{{/code}}
238 +
239 +==== Lower the creditlimit ====
240 +
241 +The creditlimit can only be lowered through this patch API call. Increasing of the creditlimit requires signing and has not been implemented yet.
242 +
243 +{{code language="http" title="**Request**"}}
244 +PATCH /ledger/account/v1/XXX/accounts/NNN HTTP/1.1
245 +Host: -
246 +Authorization: Bearer <Token>
247 +Content-Type: application/json
248 +
249 +{
250 + "creditLimit": 2000.00
251 +}
252 +{{/code}}
253 +
254 +
255 +{{code language="http" title="**Response**"}}
256 +HTTP/1.1 204 NO CONTENT
257 +Content-Type: application/json
258 +
259 +{{/code}}
260 +
261 +==== Account resource properties ====
262 +
263 +(% class="table-bordered table-striped" %)
264 +|=(% style="width: 215px;" %)Property|=(% style="width: 114px;" %)Data type|=(% style="width: 161px;" %)Format|=(% style="width: 61px;" %)Modify (patch)|=(% style="width: 877px;" %)Description
265 +|(% style="width:215px" %)@id |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: |(% style="width:61px" %) |(% style="width:877px" %)Uri of the specific account
266 +|(% style="width:215px" %)accountNo |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 50|(% style="width:61px" %) |(% style="width:877px" %)The identifier of the account
267 +|(% style="width:215px" %)startDate |(% style="width:114px" %)date|(% style="width:161px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:61px" %) |(% style="width:877px" %)Date when the account was started
268 +|(% style="width:215px" %)description |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 200|(% style="width:61px" %) |(% style="width:877px" %)A description of the type of account
269 +|(% style="width:215px" %)accountProfileType |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 50|(% style="width:61px" %) |(% style="width:877px" %)The defined code of the accounttype, //Examples: kontodebet, kontokredit, kontofaktura//
270 +|(% style="width:215px" %)accountAlias |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 50|(% style="width:61px" %) |(% style="width:877px" %)A descriptive name for the account type, //Examples: kontokredit1, matkonto1//
271 +|(% style="width:215px" %)customerNo |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 50|(% style="width:61px" %) |(% style="width:877px" %)Identifier of the customer (account owner)
272 +|(% style="width:215px" %)status |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 25|(% style="width:61px" %) |(% style="width:877px" %)Status of the account(((
273 +* **PendingClose**: the customer has requested the account to be closed, the account will be closed when possible.
274 +* **Open**: the account is open and active
275 +* **Closed**: the account has been closed
276 +)))
277 +|(% style="width:215px" %)creditLimit |(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="background-color:palegreen; width:61px" %) |(% style="width:877px" %)The creditlimit of the account, support patch operation but only lower. This value can only be 0 or positive.
278 +|(% style="width:215px" %)totalBalance|(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)Total current sum of all balances (including capital / interest / fees, etc.). This value can be either positive or negative. Negative means it is a surplus and positive means it is a debt.
279 +|(% style="width:215px" %)reservedAmount |(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)Sum of all outstanding reservations (which are valid and not captured). This value can only be positive.
280 +|(% style="width:215px" %)availableAmount |(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)Available credit (cannot be calculated from the above amounts as fees can be included there, which does not affect available credit). This value can only be positive.
281 +|(% style="width:215px" %)maxPaymentAmount|(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)The largest amount possible to deposit on the account at this moment.
282 +|(% style="width:215px" %)openBill|(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
283 +|(% style="width:215px" %)charityDonation |(% style="width:114px" %)bool|(% style="width:161px" %) |(% style="background-color:palegreen; width:61px" %) |(% style="width:877px" %)If donations should be made from the account
284 +|(% style="width:215px" %)interestRate.debtInterest|(% style="width:114px" %)decimal|(% style="width:161px" %)Percentage|(% style="width:61px" %) |(% style="width:877px" %)yearly debt interestrate
285 +|(% style="width:215px" %)interestRate.penaltyInterest|(% style="width:114px" %)decimal|(% style="width:161px" %)Percentage|(% style="width:61px" %) |(% style="width:877px" %)yearly penalty interestrate
286 +|(% style="width:215px" %)bankPayment|(% style="width:114px" %)object|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)Details on how to make a bank payment to the account
287 +|(% style="width:215px" %) bankAccountNo|(% style="width:114px" %)string|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)Bank account number for payments against the current account
288 +|(% style="width:215px" %) bankAccountType|(% style="width:114px" %)string|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)(((
289 +Type of bank account
290 +
291 +* BGSE
292 +* PGSE
293 +* BKNO
294 +)))
295 +|(% style="width:215px" %) bic|(% style="width:114px" %)string|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)BIC/SWIFT (Business Identifier Code)
296 +|(% style="width:215px" %) iban|(% style="width:114px" %)string|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)IBAN (International Bank Account Number)
297 +|(% style="width:215px" %) paymentReference|(% style="width:114px" %)string|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)Payment reference of the current account
298 +|(% style="width:215px" %)recurringPaymentConsent|(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
299 +|(% style="width:215px" %)cards |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
300 +|(% style="width:215px" %)transactions |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
301 +|(% style="width:215px" %)currency |(% style="width:114px" %)string|(% style="width:161px" %)[[ISO 4217>>https://sv.wikipedia.org/wiki/ISO_4217]]|(% style="width:61px" %) |(% style="width:877px" %)
302 +|(% style="width:215px" %)bills |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
303 +|(% style="width:215px" %)customer |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
304 +|(% style="width:337px" %)activePaymentOrder.paymentMethod|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 15|(% style="width:61px" %)(((
305 +
306 +)))|(% style="width:877px" %)(((
307 +PaymentTypes:
308 +
309 +* AUTOGIRO
310 +)))
311 +|(% style="width:337px" %)activePaymentOrder.executionDate|(% style="width:205px" %)date|(% style="width:208px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:61px" %) |(% style="width:877px" %)Date when the paymentorder will be executed (when end-customer will be debited)
312 +|(% style="width:337px" %)activePaymentOrder.amount|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:61px" %) |(% style="width:877px" %)Amount that will be charged, this amount may be adjusted when the payment order is executed, if the "amount to pay" on the bill has decreased
313 +|(% style="width:215px" %) |(% style="width:114px" %) |(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)
314 +
315 +----
316 +
317 +==== Register-psp-payment ====
318 +
319 +Method: POST
320 +Execution of this operation will result in an attempt to deposit the amount on the given account.
321 +
322 +(% class="box infomessage" %)
323 +(((
324 +Access to this operation is not normally granted, unless otherwise agreed.
325 +)))
326 +
327 +{{code language="http" title="**Request**"}}
328 +POST /ledger/account/v1/XXX/accounts/NNN/register-psp-payment HTTP/1.1
329 +Host: -
330 +Authorization: Bearer <Token>
331 +Content-Type: application/json
332 +
333 +{
334 + "Amount": 2000.00,
335 + "PaymentDate": "2021-01-01",
336 + "sourcePspPaymentTransactionId": "123456789"
337 +}
338 +{{/code}}
339 +
340 +
341 +{{code language="http" title="**Response**"}}
342 +HTTP/1.1 204 NO CONTENT
343 +Content-Type: application/json
344 +
345 +{{/code}}
346 +
347 +===== Register-psp-payment resource properties =====
348 +
349 +(% class="table-bordered table-striped" %)
350 +|=(% style="width: 161px;" %)Property|=(% style="width: 121px;" %)Data type|=(% style="width: 195px;" %)Format|=(% style="width: 1309px;" %)Description
351 +|(% style="width:161px" %)Amount|(% style="width:121px" %)Decimal|(% style="width:195px" %) |(% style="width:1309px" %)Amount to deposit on account, max value is found on the account resource in the property "MaxPaymentAmount".
352 +|(% style="width:161px" %)PaymentDate|(% style="width:121px" %)Date|(% style="width:195px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:1309px" %)Date of the actual payment
353 +|(% style="width:161px" %)sourcePspPaymentTransactionId|(% style="width:121px" %)String|(% style="width:195px" %)Maxlength: 50|(% style="width:1309px" %)Unique identifier for the payment
354 +
355 +----
356 +
357 +== Bills ==
358 +
359 +The bills resources contains all the documents produced in the accounts billing cycle.
360 +
361 +
362 +==== List all bills of an account ====
363 +
364 +
365 +{{code language="http" title="**Request**"}}
366 +GET /ledger/account/v1/XXX/accounts/NNN/bills HTTP/1.1
367 +Host: -
368 +Authorization: Bearer <Token>
369 +Content-Type: application/json
370 +
371 +{{/code}}
372 +
373 +
374 +{{code language="http" title="**Response**"}}
375 +HTTP/1.1 200 OK
376 +Content-Type: application/json
377 +
378 +{
379 + "@id": "/ledger/account/v1/501/accounts/NNN/bills?status=open",
380 + "items" : [
381 + {
382 + "@id": "/ledger/account/v1/XXX/accounts/NNN/bills/reminder-123645",
383 + "dueDate": "2018-12-05",
384 + "billDate": "2018-11-15",
385 + "billNo": "124645",
386 + "billAmount": 240.00,
387 + "billType" : "reminder",
388 + "status": "open",
389 + "externalBillId": "27",
390 + "activePaymentDetails": {
391 + "minimumAmountToBePayed": 240.00,
392 + "bankAccountNo": "123",
393 + "bankAccountType": "BGSE",
394 + "bic": "123456",
395 + "iban": "SE12345678945631",
396 + "paymentReference": "5465164654663",
397 + "paymentOrdersExists": true,
398 + },
399 + "document": "/ledger/account/v1/XXX/accounts/NNN/bills/reminder-124645/document"
400 + },
401 + {
402 + "@id": "/ledger/account/v1/XXX/accounts/NNN/bills/reminder-123645",
403 + "dueDate": "2018-12-05",
404 + "billDate": "2018-11-15",
405 + "billNo": "124645",
406 + "billAmount": 240.00,
407 + "billType" : "bill",
408 + "status": "closed",
409 + "externalBillId": "37",
410 + "activePaymentDetails": null,
411 + "document": "/ledger/account/v1/XXX/accounts/NNN/bills/reminder-124645/document"
412 + },
413 + {
414 + "@id": "/ledger/account/v1/XXX/accounts/NNN/bills/bill-123645",
415 + "dueDate": "2018-12-05",
416 + "billDate": "2018-11-15",
417 + "billNo": "124645",
418 + "billAmount": 240.00,
419 + "billType" : "bill",
420 + "status": "closed",
421 + "externalBillId": "47",
422 + "activePaymentDetails": null,
423 + "document": "/ledger/account/v1/XXX/accounts/NNN/bills/reminder-124645/document"
424 + }
425 + ]
426 +}
427 +{{/code}}
428 +
429 +==== ====
430 +
431 +==== Get specific bill ====
432 +
433 +
434 +{{code language="http" title="**Request**"}}
435 +GET /ledger/account/v1/XXX/accounts/NNN/bills/456 HTTP/1.1
436 +Host: -
437 +Authorization: Bearer <Token>
438 +Content-Type: application/json
439 +
440 +{{/code}}
441 +
442 +
443 +{{code language="http" title="**Response**"}}
444 +HTTP/1.1 200 OK
445 +Content-Type: application/json
446 +
447 +{
448 + "@id": "/ledger/account/v1/XXX/accounts/NNN/bills/reminder-123645",
449 + "dueDate": "2018-12-05",
450 + "billDate": "2018-11-15",
451 + "billNo": "124645",
452 + "billAmount": 240.00,
453 + "billType" : "reminder",
454 + "status": "open",
455 + "externalBillId": "42",
456 + "activePaymentDetails": {
457 + "minimumAmountToBePayed": 240.00,
458 + "bankAccountNo": "123",
459 + "bankAccountType": "BGSE",
460 + "bic": "123456",
461 + "iban": "SE12345678945631",
462 + "paymentReference": "5465164654663",
463 + "paymentOrdersExists": true,
464 + },
465 + "document": "/ledger/account/v1/XXX/accounts/NNN/bills/reminder-124645/document"
466 +}
467 +{{/code}}
468 +
469 +==== Bill resource properties ====
470 +
471 +(% class="table-bordered table-striped" %)
472 +|=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 621px;" %)Description
473 +|(% style="width:337px" %)@id|(% style="width:205px" %)string|(% style="width:208px" %)Uri|(% style="width:621px" %)
474 +|(% style="width:337px" %)dueDate|(% style="width:205px" %)date|(% style="width:208px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:621px" %)
475 +|(% style="width:337px" %)billDate|(% style="width:205px" %)date|(% style="width:208px" %) |(% style="width:621px" %)Date when bill was created
476 +|(% style="width:337px" %)billNo|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 50|(% style="width:621px" %)The identifier of the bill
477 +|(% style="width:337px" %)billAmount|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:621px" %)the amount that is stated on the actual bill/document
478 +|(% style="width:337px" %)billType|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 25|(% style="width:621px" %)(((
479 +BillTypes:
480 +
481 +* Bill
482 +* Reminder1
483 +* Reminder2
484 +* Collection
485 +)))
486 +|(% style="width:337px" %)status|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:621px" %)(((
487 +"open" / "closed"
488 +)))
489 +|(% style="width:337px" %)externalBillId|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:621px" %)Optional external reference
490 +|(% style="width:337px" %)activePaymentDetails|(% style="width:205px" %)object|(% style="width:208px" %) |(% style="width:621px" %)only set if status of bill is "open"
491 +|(% style="width:337px" %)activePaymentDetails.minimumAmountToBePayed|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:621px" %)The least amount to pay on the bill
492 +|(% style="width:337px" %)activePaymentDetails.bankAccountNo|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 15|(% style="width:621px" %)bankaccount for payment
493 +|(% style="width:337px" %)activePaymentDetails.bankAccountType|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 10|(% style="width:621px" %)BankAccountTypes:(((
494 +* BKSE (swedish bankaccount)
495 +* PKSE (swedish plusgiro)
496 +* BGSE (swedish bankgiro)
497 +* PGSE (swedish plusgiro OCR)
498 +)))
499 +|(% style="width:337px" %)activePaymentDetails.bic|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 11|(% style="width:621px" %)Bank Identifier Code (BIC)
500 +|(% style="width:337px" %)activePaymentDetails.iban|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 34|(% style="width:621px" %)International Bank Account Number (IBAN)
501 +|(% style="width:337px" %)activePaymentDetails.paymentReference|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 50|(% style="width:621px" %)reference to specify on the payment
502 +|(% style="width:337px" %)activePaymentDetails.paymentOrdersExists|(% style="width:205px" %)bool|(% style="width:208px" %) |(% style="width:621px" %)if there is an active payment order to be executed related to this bill for "recurring payments".
503 +//More detailed information about the payment order can be found on the accounts resource//
504 +|(% style="width:337px" %)document|(% style="width:205px" %)string|(% style="width:208px" %)Url|(% style="width:621px" %)Url to download pdf document
505 +
506 +== Cards ==
507 +
508 +==== Add card to account ====
509 +
510 +Execute http post towards this resource to add a new card to the specified account
511 +
512 +{{code language="http" title="**Request**"}}
513 +POST /ledger/account/v1/XXX/accounts/NNN/cards HTTP/1.1
514 +Host: -
515 +Authorization: Bearer <Token>
516 +Content-Type: application/json
517 +
518 +{
519 + "token": "954c8699-b38f-47a2-b568-668b8837dad8",
520 + "PanTrunc": "85479*********648",
521 + "deleted" : false,
522 + "mainCard": true,
523 + "cardHolder" : {
524 + "number" : "123465",
525 + "name": "test testsson",
526 + "nationalConsumerIdentifier": {
527 + "value": "19101010-1010",
528 + "countryCode": "SE"
529 + }
530 + }
531 +}
532 +{{/code}}
533 +
534 +==== Add replacement card ====
535 +
536 +This operation is used to replace an existing card, and is therefore executed on the card to be replaced. The contract of the postbody is the same as POST towards the cards resource.
537 +
538 +{{code language="http" title="**Request**"}}
539 +POST /ledger/account/v1/XXX/accounts/NNN/cards/954c8699-b38f-47a2-b568-668b8837dad8/add-replacement-card HTTP/1.1
540 +Host: -
541 +Authorization: Bearer <Token>
542 +Content-Type: application/json
543 +
544 +{
545 + "token": "954c8699-b38f-47a2-b568-668b8837dad8",
546 + "PanTrunc": "85479*********648",
547 + "deleted" : false,
548 + "mainCard": true,
549 + "cardHolder" : {
550 + "number" : "123465",
551 + "name": "test testsson",
552 + "nationalConsumerIdentifier": {
553 + "value": "19101010-1010",
554 + "countryCode": "SE"
555 + }
556 + }
557 +}
558 +{{/code}}
559 +
560 +==== List cards on an account ====
561 +
562 +{{code language="http" title="**Request**"}}
563 +GET /ledger/account/v1/XXX/accounts/NNN/cards HTTP/1.1
564 +Host: -
565 +Authorization: Bearer <Token>
566 +Content-Type: application/json
567 +
568 +
569 +{{/code}}
570 +
571 +
572 +{{code language="http" title="**Response**"}}
573 +HTTP/1.1 200 OK
574 +Content-Type: application/json
575 +
576 +{
577 + "operations": null,
578 + "items": [
579 + {
580 + "token": "954c8699-b38f-47a2-b568-668b8837dad8",
581 + "PanTrunc": "85479*********648",
582 + "deleted" : false,
583 + "mainCard": true,
584 + "cardHolder" : {
585 + "number" : "123465",
586 + "name": "test testsson",
587 + "nationalConsumerIdentifier": {
588 + "value": "19101010-1010",
589 + "countryCode": "SE"
590 + }
591 + },
592 + "@id": "/ledger/account/v1/XXX/accounts/NNN/cards/741"
593 + },
594 + {
595 + "token": "274c8699-b38f-47a2-b568-668b8837dat7",
596 + "PanTrunc": "78979*********321",
597 + "deleted" : false,
598 + "mainCard": false,
599 + "cardHolder" : {
600 + "number" : "987654",
601 + "name": "test testsson",
602 + "nationalConsumerIdentifier": {
603 + "value": "19101010-1010",
604 + "countryCode": "SE"
605 + }
606 + },
607 + "@id": "/ledger/account/v1/XXX/accounts/NNN/cards/274c8699-b38f-47a2-b568-668b8837dat7"
608 + }
609 + ],
610 + "@id": "/ledger/account/v1/XXX/accounts/NNN/cards",
611 + "view": {
612 + "@id": "/ledger/account/v1/XXX/accounts/NNN/cards?$top=2&$skip=0",
613 + "next": "/ledger/account/v1/XXX/accounts/NNN/cards?$top=2&$skip=2"
614 + }
615 +}
616 +{{/code}}
617 +
618 +==== Get a specific card ====
619 +
620 +
621 +{{code language="http" title="**Request**"}}
622 +GET /ledger/account/v1/XXX/accounts/NNN/cards/954c8699-b38f-47a2-b568-668b8837dad8 HTTP/1.1
623 +Host: -
624 +Authorization: Bearer <Token>
625 +Content-Type: application/json
626 +
627 +
628 +{{/code}}
629 +
630 +{{code language="http" title="**Response**"}}
631 +HTTP/1.1 200 OK
632 +Content-Type: application/json
633 +
634 +{
635 + "token": "954c8699-b38f-47a2-b568-668b8837dad8",
636 + "PanTrunc": "85479*********648",
637 + "deleted" : false,
638 + "mainCard": true,
639 + "cardHolder" : {
640 + "number" : "123465",
641 + "name": "test testsson",
642 + "nationalConsumerIdentifier": {
643 + "value": "19101010-1010",
644 + "countryCode": "SE"
645 + }
646 + },
647 + "@id": "/ledger/account/v1/XXX/accounts/NNN/cards/954c8699-b38f-47a2-b568-668b8837dad8",
648 + "parentHREF": "/ledger/account/v1/XXX/accounts/NNN",
649 + "operation" : [
650 + {
651 + "rel" : "partial-update",
652 + "method" : "patch",
653 + "href" : "/ledger/account/v1/XXX/accounts/NNN/cards/954c8699-b38f-47a2-b568-668b8837dad8"
654 + },
655 + {
656 + "rel": "add-replacement-card",
657 + "href": "/ledger/account/v1/XXX/accounts/NNN/cards/5823a2d9-34d2-4bc4-8b6d-1e27f4511363/add-replacement-card",
658 + "method": "POST"
659 + }
660 + ]
661 +}
662 +{{/code}}
663 +
664 +==== Card resource properties ====
665 +
666 +(% class="table-bordered table-striped" %)
667 +|=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 62px;" %)Modify (patch)|=(% style="width: 1401px;" %)Description
668 +|(% style="width:337px" %)token|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:62px" %) |(% style="width:1401px" %)token identifier of the card
669 +|(% style="width:337px" %)panTrunc|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:62px" %) |(% style="width:1401px" %)truncated PAN
670 +|(% style="width:337px" %)deleted|(% style="width:205px" %)bool|(% style="width:208px" %) |(% style="background-color:palegreen; width:62px" %) |(% style="width:1401px" %)indicates wheter the card has been deleted
671 +|(% style="width:337px" %)mainCard|(% style="width:205px" %)bool|(% style="width:208px" %) |(% style="width:62px" %) |(% style="width:1401px" %)indicated whether this card is the main card of the account (cardholder is always owner of account)
672 +|(% style="width:337px" %)cardHolder.number|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:62px" %) |(% style="width:1401px" %)Cardholder customernumber
673 +|(% style="width:337px" %)cardHolder.name|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:62px" %) |(% style="width:1401px" %)Cardholder fullname
674 +|(% style="width:337px" %)cardHolder.nationalConsumerIdentifier.value|(% style="width:205px" %)string|(% style="width:208px" %)YYYYMMDD-NNNC|(% style="width:62px" %) |(% style="width:1401px" %)
675 +|(% style="width:337px" %)cardHolder.nationalConsumerIdentifier.countryCode|(% style="width:205px" %)string|(% style="width:208px" %)[[ISO 3166-1 alpha-2>>url:https://sv.wikipedia.org/wiki/ISO_3166]]|(% style="width:62px" %) |(% style="width:1401px" %)
676 +
677 +== Transactions ==
678 +
679 +==== List transactions on an account ====
680 +
681 +You can filter transactions by date in two different ways. Either filtering can be done by date range or by listing transactions by month.
682 +
683 +**Date range example**
684 +
685 +{{code language="http" title="**Request**"}}
686 +GET /ledger/account/v1/XXX/accounts/NNN/transactions?fromDate=2020-02-10&todate=2020-06-01 HTTP/1.1
687 +Host: -
688 +Authorization: Bearer <Token>
689 +Content-Type: application/json
690 +
691 +
692 +{{/code}}
693 +
694 +**Monthly example**
695 +
696 +{{code language="http" title="**Request**"}}
697 +GET /ledger/account/v1/XXX/accounts/NNN/transactions?month=2020-04 HTTP/1.1
698 +Host: -
699 +Authorization: Bearer <Token>
700 +Content-Type: application/json
701 +
702 +
703 +{{/code}}
704 +
705 +**Standard (default last 30 days) **
706 +
707 +{{code language="http" title="**Request**"}}
708 +GET /ledger/account/v1/XXX/accounts/NNN/transactions HTTP/1.1
709 +Host: -
710 +Authorization: Bearer <Token>
711 +Content-Type: application/json
712 +
713 +
714 +{{/code}}
715 +
716 +
717 +{{code language="http" title="**Response**"}}
718 +HTTP/1.1 200 OK
719 +Content-Type: application/json
720 +
721 +{
722 + "operations": null,
723 + "items": [
724 + {
725 + "type": "payment",
726 + "description": "",
727 + "amount": 200.00,
728 + "initiatedFromPointOfSale": false,
729 + "date": "2019-10-09"
730 + },
731 + {
732 + "type": "purchase",
733 + "description": "testbutiken, köpref. 12345689",
734 + "amount": 200.00,
735 + "initiatedFromPointOfSale": true,
736 + "date": "2019-10-09"
737 + },
738 + {
739 + "type": "credit",
740 + "description": "",
741 + "amount": 200.00,
742 + "initiatedFromPointOfSale": true,
743 + "date": "2019-10-09"
744 + }
745 + ],
746 + "@id": "/ledger/account/v1/XXX/accounts/NNN/transactions"
747 +}
748 +{{/code}}
749 +
750 +==== Transaction resource properties ====
751 +
752 +(% class="table-bordered table-striped" %)
753 +|=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 621px;" %)Description
754 +|(% style="width:337px" %)type|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:621px" %)(((
755 +Type of transaction
756 +
757 +* Payment
758 +* Purchase
759 +* Credit
760 +* AdministrationFee
761 +* BillingFee
762 +* CollectionFee
763 +* Deduction
764 +* Disbursement
765 +* DisbursementReturned
766 +* Interest
767 +* LateFee
768 +* ReminderFee
769 +* MigratedBalance// (Amount of the initially migrated balance on the account)//
770 +)))
771 +|(% style="width:337px" %)description|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:621px" %)Description of the transaction, for purchases it usually includes "point of sale" and "receipt reference"
772 +|(% style="width:337px" %)amount|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:621px" %)This value can be either positive or negative. Negative means decreasing debt or increasing surplus. Positive transactions increases debt or decreases surplus.
773 +|(% style="width:337px" %)initiatedFromPointOfSale|(% style="width:205px" %)bool|(% style="width:208px" %) |(% style="width:621px" %)Indicates whether the transaction was initiated from point of sale, or else it is a "ledger" transaction that was initiated internally in the ledgersystem.
774 +|(% style="width:337px" %)date|(% style="width:205px" %)date|(% style="width:208px" %) |(% style="width:621px" %)Date when the transaction was initiated (Authorization date)
775 +
776 +== Reservations ==
777 +
778 +==== List reservations in an account ====
779 +
780 +{{code language="http" title="**Request**"}}
781 +GET /ledger/account/v1/XXX/accounts/NNN/reservations HTTP/1.1
782 +Host: -
783 +Authorization: Bearer <Token>
784 +Content-Type: application/json
785 +
786 +
787 +{{/code}}
788 +
789 +
790 +{{code language="http" title="**Response**"}}
791 +HTTP/1.1 201 Created
792 +Content-Type: application/json
793 +
794 +{
795 + "operations": null,
796 + "items": [
797 + {
798 + "amount": 200.00,
799 + "description" : "",
800 + "date": "2019-10-05",
801 + },
802 + {
803 + "amount": 450.00,
804 + "description" : "",
805 + "date": "2019-10-02",
806 + },
807 + ],
808 + "@id": "/ledger/account/v1/XXX/accounts/NNN/reservations",
809 +}
810 +{{/code}}
811 +
812 +==== Reservation resource properties ====
813 +
814 +(% class="table-bordered table-striped" %)
815 +|=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 621px;" %)Description
816 +|(% style="width:337px" %)amount|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:621px" %)
817 +|(% style="width:337px" %)description|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:621px" %)Description of the reservation, normally "point of sale".
818 +|(% style="width:337px" %)date|(% style="width:205px" %)date|(% style="width:208px" %) |(% style="width:621px" %)Date when the reservation occured
819 +
820 +== Recurring-payment-configuration ==
821 +
822 +(% class="wikigeneratedid" %)
823 +This resource contain information/settings related to how recurring payments should behave on this account.
824 +
825 +====
826 +Get settings on an account ====
827 +
828 +
829 +{{code language="http" title="**Request**"}}
830 +GET /ledger/account/v1/XXX/accounts/NNN/recurring-payment-configuration/ HTTP/1.1
831 +Host: -
832 +Authorization: Bearer <Token>
833 +Content-Type: application/json
834 +{{/code}}
835 +
836 +
837 +{{code language="http" title="**Response**"}}
838 +HTTP/1.1 200 OK
839 +Content-Type: application/json
840 +
841 +{
842 + "@id" : "/ledger/account/v1/XXX/accounts/NNN/recurring-payment-configurations",
843 + "paymentMethod" : "autogiro",
844 + "paymentScope" : "fixedRecurring",
845 + "fixedAmount" : 1500.00,
846 + "parentHREF": "/ledger/account/v1/XXX/accounts/NNN",
847 + "operation" : [
848 + {
849 + "rel" : "partially-update-recurring-payment-consent",
850 + "method" : "patch",
851 + "href" : "/ledger/account/v1/XXX/accounts/NNN/recurring-payment-consent"
852 + }
853 + ]
854 +}
855 +{{/code}}
856 +
857 +==== Create settings on an account ====
858 +
859 +(% class="wikigeneratedid" %)
860 +Execute http **POST **towards this resource to create recurring payments configuration for specified account.
861 +
862 +{{code language="http" title="**Request**"}}
863 +POST /ledger/account/v1/XXX/accounts/NNN/recurring-payment-configuration HTTP/1.1
864 +Host: -
865 +Authorization: Bearer <Token>
866 +Content-Type: application/json
867 +
868 +{
869 + "paymentMethod" : "autogiro",
870 + "paymentScope" : "billedAmount",
871 + "fixedAmount" : 0.00
872 +}
873 +{{/code}}
874 +
875 +====
876 +Update settings on an account ====
877 +
878 +(% class="wikigeneratedid" %)
879 +Execute http **PATCH** towards this resource to update the recurring payment configuration
880 +
881 +{{code language="http" title="**Request**"}}
882 +PATCH /ledger/account/v1/XXX/accounts/NNN/recurring-payment-configuration HTTP/1.1
883 +Host: -
884 +Authorization: Bearer <Token>
885 +Content-Type: application/json
886 +
887 +{
888 + "paymentScope" : "billedAmount",
889 + "fixedAmount" : 0.00
890 +}
891 +{{/code}}
892 +
893 +==== Delete settings on an account ====
894 +
895 +(% class="wikigeneratedid" %)
896 +Execute http **DELETE **to delete the recurring payment settings for the specified account. By deleting the settings, the account will not use the consent registered on the customer for recurring payments.
897 +
898 +{{code language="http" title="**Request**"}}
899 +DELETE /ledger/account/v1/XXX/accounts/NNN/recurring-payment-configuration HTTP/1.1
900 +Host: -
901 +Authorization: Bearer <Token>
902 +Content-Type: application/json
903 +
904 +{}
905 +{{/code}}
906 +
907 +==== Recurring-payment-configuration resource properties ====
908 +
909 +(% class="table-bordered table-striped" %)
910 +|=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 58px;" %)Modify (patch)|=(% style="width: 1176px;" %)Description
911 +|(% style="width:337px" %)paymentMethod|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="background-color:palegreen; width:58px" %) |(% style="width:1176px" %)paymentMethods:(((
912 +* autogiro
913 +)))
914 +|(% style="width:337px" %)paymentScope|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="background-color:palegreen; width:58px" %) |(% style="width:1176px" %)(((
915 +paymentScopes:
916 +
917 +* fixedRecurring (Fixed amount to debit monthly)
918 +* totalDebt (Total account debt / used credit will be debited each month)
919 +* billedAmount (Only the //"minimum amount to pay"// will be debited each month)
920 +)))
921 +|(% style="width:337px" %)fixedAmount|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="background-color:palegreen; width:58px" %) |(% style="width:1176px" %)amount to monthly debit end-customers bankaccount (Only valid if recurringPaymentScope is set to "fixedRecurring")
922 +
923 +== Active-payment-orders ==
924 +
925 +(% class="wikigeneratedid" %)
926 +This resource corresponds to an active / scheduled payment order placed against the specific account, the end-customer will be debited at the given executeDate.
927 +
928 +====
929 +Get active payment orders for an account ====
930 +
931 +
932 +{{code language="http" title="**Request**"}}
933 +GET /ledger/account/v1/XXX/accounts/NNN/active-payment-orders/ HTTP/1.1
934 +Host: -
935 +Authorization: Bearer <Token>
936 +Content-Type: application/json
937 +{{/code}}
938 +
939 +
940 +{{code language="http" title="**Response**"}}
941 +HTTP/1.1 200 OK
942 +Content-Type: application/json
943 +
944 +{
945 + "operations": null,
946 + "items": [
947 + {
948 + "paymentMethod": "autogiro",
949 + "executeDate": "2020-02-15",
950 + "amount": 200.00
951 + }
952 + ],
953 + "view": {
954 + "@id": "/ledger/account/v1/XXX/accounts/NNN/active-payment-orders?$top=2&$skip=0",
955 + "next": "/ledger/account/v1/XXX/accounts/NNN/active-payment-orders?$top=2&$skip=2"
956 + }
957 +}
958 +{{/code}}
959 +
960 +==== ====
961 +
962 +==== Active-payment-orders resource properties ====
963 +
964 +(% class="table-bordered table-striped" %)
965 +|=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 58px;" %)Modify (patch)|=(% style="width: 1176px;" %)Description
966 +|(% style="width:337px" %)paymentMethod|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:58px" %) |(% style="width:1176px" %)paymentMethods:(((
967 +* autogiro
968 +)))
969 +|(% style="width:337px" %)executeDate|(% style="width:205px" %)Date|(% style="width:208px" %) |(% style="width:58px" %) |(% style="width:1176px" %)(((
970 +The date when the payment order will be executed
971 +)))
972 +|(% style="width:337px" %)amount|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:58px" %) |(% style="width:1176px" %)The amount to debit the owner of the consent
973 +
974 +=== ===
975 +
976 +{{display reference="developer:Main.Invoicing.ledger-api-general-docs.api-section-problems.WebHome"/}}
977 +
978 +=== Problem types ===
979 +
980 +(% class="box infomessage" %)
981 +(((
982 +Note, each problem typecode is preceded by "ledger/account/v1/problems/" in this API, e.g. the error "validation" in the table below will appear as typecode "ledger/account/v1/problems/validation".
983 +)))
984 +
985 +(% class="table-bordered table-striped" %)
986 +|=(% style="width: 537px;" %)Problem type (code)|=(% style="width: 172px;" %)Httpstatus|=(% style="width: 796px;" %)Description
987 +|(% style="width:537px" %)validation|(% style="width:172px" %)400|(% style="width:796px" %)occurs if any of the inputvalidation fails, it is described in the problem which parameter that failed the validation
988 +|(% style="width:537px" %)forbidden|(% style="width:172px" %)403|(% style="width:796px" %)occurs if access to method is not allowed.
989 +|(% style="width:537px" %)customer-not-found|(% style="width:172px" %)404|(% style="width:796px" %)can occur if customernumber is part of the querystring towards account resource
990 +|(% style="width:537px" %)card-not-found|(% style="width:172px" %)404|(% style="width:796px" %)
991 +|(% style="width:537px" %)duplicate-card-token|(% style="width:172px" %)409|(% style="width:796px" %)
992 +|(% style="width:537px" %)card-update-failed|(% style="width:172px" %)422|(% style="width:796px" %)
993 +|(% style="width:537px" %)account-not-found|(% style="width:172px" %)404|(% style="width:796px" %)
994 +|(% style="width:537px" %)invalid-reg-no|(% style="width:172px" %)400|(% style="width:796px" %)
Account.API diagram.jpeg
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.rae
Size
... ... @@ -1,0 +1,1 @@
1 +0 bytes
Content