Changes for page ../credit-account
Last modified by David Persson on 2022/08/11 10:52
From version 90.1
edited by David Persson
on 2020/02/06 16:43
on 2020/02/06 16:43
To version 91.1
edited by Helge Dahl
on 2020/02/06 17:56
on 2020/02/06 17:56
Change comment: Rollback to version 88.1
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -xwiki:XWiki.d ap1 +xwiki:XWiki.hde - Content
-
... ... @@ -19,6 +19,7 @@ 19 19 20 20 (% class="lead" %) 21 21 This api is used to retrieve information and to change properties related to the customer's credit account. 22 + 22 22 (% contenteditable="false" tabindex="-1" %)[[image:1579213343157-343.png||data-widget="image" height="325" width="346"]] 23 23 24 24 (% id="HRoutesegments" %) ... ... @@ -25,6 +25,7 @@ 25 25 == Introduction == 26 26 27 27 Each resource in the API corresponds to its own route. All routes are structured according to a specific standard, explained below 29 + 28 28 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. 29 29 //api.payex.com/ledger/**{Subdomain}**/v1/**{LedgerNumber}**/resource1/**{resource1Id}**/resource2/**{resource2Id}**/resource3/**{resource3Id}**// 30 30 ... ... @@ -52,6 +52,7 @@ 52 52 53 53 The **accounts** resource is located under **ledger/credit-account/v1/ **api**. **The accounts- and its sub-resources are used to create, read and modify information related to a credit-account. 54 54 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. 57 + 55 55 The following operations is supported 56 56 57 57 * Change the account credit limit ... ... @@ -62,19 +62,99 @@ 62 62 63 63 === Requesting details of a specific account === 64 64 68 + 65 65 (% contenteditable="false" tabindex="-1" %) 66 66 ((( 67 -{{code language="http" title="**Request**"}} 68 -GET /ledger/credit-account/v1/XXX/accounts/NNN HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json 69 -{{/code}} 71 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Request**~"|-|GET /ledger/credit-account/v1/XXX/accounts/NNN HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json" data-widget="xwiki-macro" %) 72 +((( 73 +(% class="box" %) 74 +((( 75 +**Request** 76 + 77 +(% class="code" %) 78 +((( 79 +(% style="color:#0000ff" %)GET(%%) (% style="color:#0000ff; font-weight:bold" %)**/ledger/credit-account/v1/XXX/accounts/NNN**(%%) (% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) 80 +(% style="color:#7d9029" %)Host(% style="color:#666666" %):(%%) - 81 +(% style="color:#7d9029" %)Authorization(% style="color:#666666" %):(%%) Bearer <Token> 82 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/json 70 70 ))) 84 +))) 85 +))) 86 +))) 71 71 88 + 72 72 (% contenteditable="false" tabindex="-1" %) 73 73 ((( 74 -{{code language="http" title="**Response**"}} 75 -HTTP/1.1 200 OK Content-Type: application/json { "@id": "/ledger/credit-account/v1/XXX/accounts/NNN", "accountNo": "1234567", "startDate": "2018-05-21", "description": null, "accountProfileType": "accountType1 | accountType2 | accountType3 etc.", "accountAlias" : "accountAlias1 | accountAlias2 etc.", "customerNo" : "123789654", "status" : "open | pending-close | closed", "creditLimit": 2000.00, "totalBalance" : -1900.0, "reservedAmount": 50.0, "availableAmount": 50.0, "openBill" : "/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-456", "charityDonation": true, "interestRate": { "debtInterest" : 10.00, "penaltyInterest": 15.00 }, "bankPayment": { "bankAccountNo": "123", "bankAccountType": "BGSE", "bic": "123456", "iban": "SE12345678945631", "paymentReference": "54867165675646" }, "activePaymentOrders": "/ledger/credit-account/v1/XXX/accounts/NNN/active-payment-orders", "recurringPaymentConsent": "/ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting", "cards": "/ledger/credit-account/v1/XXX/accounts/123456/cards", "transactions": "/ledger/credit-account/v1/XXX/accounts/NNN/transactions", "currency": "sek", "bills": "/ledger/credit-account/v1/XXX/accounts/NNN/bills", "customer": "/ledger/customers/v1/XXX/customer/123456", "operation" : [ { "rel" : "add-card-info", "method" : "post", "href" : "/ledger/credit-account/v1/XXX/accounts/NNN/cards" }, { "rel" : "request-close-account", "method" : "post", "href" : "/ledger/credit-account/v1/XXX/accounts/NNN/request-close-account" }, { "rel" : "apply-for-raised-credit-limit", "method" : "post", "href" : "/ledger/credit-account-onboardings/v1/XXX/accounts/NNN/apply-for-raised-credit-limit" }, { "rel" : "partial-update", "method" : "patch", "href" : "/ledger/credit-account-onboardings/v1/XXX/accounts/NNN" } ] } 76 -{{/code}} 91 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Response**~"|-|HTTP/1.1 200 OK Content-Type: application/json { ~"@id~": ~"/ledger/credit-account/v1/XXX/accounts/NNN~", ~"accountNo~": ~"1234567~", ~"startDate~": ~"2018-05-21~", ~"description~": null, ~"accountProfileType~": ~"accountType1 | accountType2 | accountType3 etc.~", ~"accountAlias~" : ~"accountAlias1 | accountAlias2 etc.~", ~"customerNo~" : ~"123789654~", ~"status~" : ~"open | pending-close | closed~", ~"creditLimit~": 2000.00, ~"totalBalance~" : -1900.0, ~"reservedAmount~": 50.0, ~"availableAmount~": 50.0, ~"openBill~" : ~"/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-456~", ~"charityDonation~": true, ~"interestRate~": { ~"debtInterest~" : 10.00, ~"penaltyInterest~": 15.00 }, ~"bankPayment~": { ~"bankAccountNo~": ~"123~", ~"bankAccountType~": ~"BGSE~", ~"bic~": ~"123456~", ~"iban~": ~"SE12345678945631~", ~"paymentReference~": ~"54867165675646~" }, ~"activePaymentOrders~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/active-payment-orders~", ~"recurringPaymentConsent~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting~", ~"cards~": ~"/ledger/credit-account/v1/XXX/accounts/123456/cards~", ~"transactions~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/transactions~", ~"currency~": ~"sek~", ~"bills~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/bills~", ~"customer~": ~"/ledger/customers/v1/XXX/customer/123456~", ~"operation~" : [ { ~"rel~" : ~"add-card-info~", ~"method~" : ~"post~", ~"href~" : ~"/ledger/credit-account/v1/XXX/accounts/NNN/cards~" }, { ~"rel~" : ~"request-close-account~", ~"method~" : ~"post~", ~"href~" : ~"/ledger/credit-account/v1/XXX/accounts/NNN/request-close-account~" }, { ~"rel~" : ~"apply-for-raised-credit-limit~", ~"method~" : ~"post~", ~"href~" : ~"/ledger/credit-account-onboardings/v1/XXX/accounts/NNN/apply-for-raised-credit-limit~" }, { ~"rel~" : ~"partial-update~", ~"method~" : ~"patch~", ~"href~" : ~"/ledger/credit-account-onboardings/v1/XXX/accounts/NNN~" } ] }" data-widget="xwiki-macro" %) 92 +((( 93 +(% class="box" %) 94 +((( 95 +**Response** 96 + 97 +(% class="code" %) 98 +((( 99 +(% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) (% style="color:#666666" %)200(%%) (% style="color:#d2413a; font-weight:bold" %)**OK**(%%) 100 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/json 101 +\\{ 102 + (% style="color:#008000; font-weight:bold" %)**"@id"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN"(%%), 103 + (% style="color:#008000; font-weight:bold" %)**"accountNo"**(%%): (% style="color:#ba2121" %)"1234567"(%%), 104 + (% style="color:#008000; font-weight:bold" %)**"startDate"**(%%): (% style="color:#ba2121" %)"2018-05-21"(%%), 105 + (% style="color:#008000; font-weight:bold" %)**"description"**(%%): (% style="color:#008000; font-weight:bold" %)**null**(%%), 106 + (% style="color:#008000; font-weight:bold" %)**"accountProfileType"**(%%): (% style="color:#ba2121" %)"accountType1 | accountType2 | accountType3 etc."(%%), 107 + (% style="color:#008000; font-weight:bold" %)**"accountAlias"**(%%) : (% style="color:#ba2121" %)"accountAlias1 | accountAlias2 etc."(%%), 108 + (% style="color:#008000; font-weight:bold" %)**"customerNo"**(%%) : (% style="color:#ba2121" %)"123789654"(%%), 109 + (% style="color:#008000; font-weight:bold" %)**"status"**(%%) : (% style="color:#ba2121" %)"open | pending-close | closed"(%%), 110 + (% style="color:#008000; font-weight:bold" %)**"creditLimit"**(%%): (% style="color:#666666" %)2000.00(%%), 111 + (% style="color:#008000; font-weight:bold" %)**"totalBalance"**(%%) : (% style="color:#666666" %)-1900.0(%%), 112 + (% style="color:#008000; font-weight:bold" %)**"reservedAmount"**(%%): (% style="color:#666666" %)50.0(%%), 113 + (% style="color:#008000; font-weight:bold" %)**"availableAmount"**(%%): (% style="color:#666666" %)50.0(%%), 114 + (% style="color:#008000; font-weight:bold" %)**"openBill"**(%%) : (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-456"(%%), 115 + (% style="color:#008000; font-weight:bold" %)**"charityDonation"**(%%): (% style="color:#008000; font-weight:bold" %)**true**(%%), 116 + (% style="color:#008000; font-weight:bold" %)**"interestRate"**(%%): { 117 + (% style="color:#008000; font-weight:bold" %)**"debtInterest"**(%%) : (% style="color:#666666" %)10.00(%%), 118 + (% style="color:#008000; font-weight:bold" %)**"penaltyInterest"**(%%): (% style="color:#666666" %)15.00(%%) 119 + }, 120 + (% style="color:#008000; font-weight:bold" %)**"bankPayment"**(%%): { 121 + (% style="color:#008000; font-weight:bold" %)**"bankAccountNo"**(%%): (% style="color:#ba2121" %)"123"(%%), 122 + (% style="color:#008000; font-weight:bold" %)**"bankAccountType"**(%%): (% style="color:#ba2121" %)"BGSE"(%%), 123 + (% style="color:#008000; font-weight:bold" %)**"bic"**(%%): (% style="color:#ba2121" %)"123456"(%%), 124 + (% style="color:#008000; font-weight:bold" %)**"iban"**(%%): (% style="color:#ba2121" %)"SE12345678945631"(%%), 125 + (% style="color:#008000; font-weight:bold" %)**"paymentReference"**(%%): (% style="color:#ba2121" %)"54867165675646"(%%) 126 + }, 127 + (% style="color:#008000; font-weight:bold" %)**"activePaymentOrders"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/active-payment-orders"(%%), 128 + (% style="color:#008000; font-weight:bold" %)**"recurringPaymentConsent"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting"(%%), 129 + (% style="color:#008000; font-weight:bold" %)**"cards"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/123456/cards"(%%), 130 + (% style="color:#008000; font-weight:bold" %)**"transactions"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/transactions"(%%), 131 + (% style="color:#008000; font-weight:bold" %)**"currency"**(%%): (% style="color:#ba2121" %)"sek"(%%), 132 + (% style="color:#008000; font-weight:bold" %)**"bills"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/bills"(%%), 133 + (% style="color:#008000; font-weight:bold" %)**"customer"**(%%): (% style="color:#ba2121" %)"/ledger/customers/v1/XXX/customer/123456"(%%), 134 + (% style="color:#008000; font-weight:bold" %)**"operation"**(%%) : [ 135 + { 136 + (% style="color:#008000; font-weight:bold" %)**"rel"**(%%) : (% style="color:#ba2121" %)"add-card-info"(%%), 137 + (% style="color:#008000; font-weight:bold" %)**"method"**(%%) : (% style="color:#ba2121" %)"post"(%%), 138 + (% style="color:#008000; font-weight:bold" %)**"href"**(%%) : (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/cards"(%%) 139 + }, 140 + { 141 + (% style="color:#008000; font-weight:bold" %)**"rel"**(%%) : (% style="color:#ba2121" %)"request-close-account"(%%), 142 + (% style="color:#008000; font-weight:bold" %)**"method"**(%%) : (% style="color:#ba2121" %)"post"(%%), 143 + (% style="color:#008000; font-weight:bold" %)**"href"**(%%) : (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/request-close-account"(%%) 144 + }, 145 + { 146 + (% style="color:#008000; font-weight:bold" %)**"rel"**(%%) : (% style="color:#ba2121" %)"apply-for-raised-credit-limit"(%%), 147 + (% style="color:#008000; font-weight:bold" %)**"method"**(%%) : (% style="color:#ba2121" %)"post"(%%), 148 + (% style="color:#008000; font-weight:bold" %)**"href"**(%%) : (% style="color:#ba2121" %)"/ledger/credit-account-onboardings/v1/XXX/accounts/NNN/apply-for-raised-credit-limit"(%%) 149 + }, 150 + { 151 + (% style="color:#008000; font-weight:bold" %)**"rel"**(%%) : (% style="color:#ba2121" %)"partial-update"(%%), 152 + (% style="color:#008000; font-weight:bold" %)**"method"**(%%) : (% style="color:#ba2121" %)"patch"(%%), 153 + (% style="color:#008000; font-weight:bold" %)**"href"**(%%) : (% style="color:#ba2121" %)"/ledger/credit-account-onboardings/v1/XXX/accounts/NNN"(%%) 154 + } 155 + ] 156 +} 77 77 ))) 158 +))) 159 +))) 160 +))) 78 78 79 79 **Resource properties** 80 80 ... ... @@ -122,39 +122,153 @@ 122 122 123 123 The bills resources contains all the documents produced in the accounts billing cycle. 124 124 208 + 125 125 ==== Requesting list of bills belonging to a specific account ==== 126 126 211 + 127 127 (% contenteditable="false" tabindex="-1" %) 128 128 ((( 129 -{{code language="http" title="**Request**"}} 130 -GET /ledger/credit-account/v1/XXX/accounts/NNN/bills HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json 131 -{{/code}} 214 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Request**~"|-|GET /ledger/credit-account/v1/XXX/accounts/NNN/bills HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json" data-widget="xwiki-macro" %) 215 +((( 216 +(% class="box" %) 217 +((( 218 +**Request** 219 + 220 +(% class="code" %) 221 +((( 222 +(% style="color:#0000ff" %)GET(%%) (% style="color:#0000ff; font-weight:bold" %)**/ledger/credit-account/v1/XXX/accounts/NNN/bills**(%%) (% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) 223 +(% style="color:#7d9029" %)Host(% style="color:#666666" %):(%%) - 224 +(% style="color:#7d9029" %)Authorization(% style="color:#666666" %):(%%) Bearer <Token> 225 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/json 132 132 ))) 227 +))) 228 +))) 229 +))) 133 133 231 + 134 134 (% contenteditable="false" tabindex="-1" %) 135 135 ((( 136 -{{code language="http" title="**Response**"}} 137 -HTTP/1.1 200 OK Content-Type: application/json { "@id": "/ledger/credit-account/v1/501/accounts/NNN/bills?status=open", "items" : [ { "@id": "/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-123645", "dueDate": "2018-12-05", "billDate": "2018-11-15", "billNo": "124645", "billAmount": 240.00, "billType" : "reminder", "status": "open", "activePaymentDetails": { "minimumAmountToBePayed": 240.00, "bankAccountNo": "123", "bankAccountType": "BGSE", "bic": "123456", "iban": "SE12345678945631", "paymentReference": "5465164654663", "paymentOrdersExists": true, }, "document": "/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-124645/document" }, { "@id": "/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-123645", "dueDate": "2018-12-05", "billDate": "2018-11-15", "billNo": "124645", "billAmount": 240.00, "billType" : "bill", "status": "closed", "activePaymentDetails": null, "document": "/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-124645/document" }, { "@id": "/ledger/credit-account/v1/XXX/accounts/NNN/bills/bill-123645", "dueDate": "2018-12-05", "billDate": "2018-11-15", "billNo": "124645", "billAmount": 240.00, "billType" : "bill", "status": "closed", "activePaymentDetails": null, "document": "/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-124645/document" } ] } 138 -{{/code}} 234 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Response**~"|-|HTTP/1.1 200 OK Content-Type: application/json { ~"@id~": ~"/ledger/credit-account/v1/501/accounts/NNN/bills?status=open~", ~"items~" : [ { ~"@id~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-123645~", ~"dueDate~": ~"2018-12-05~", ~"billDate~": ~"2018-11-15~", ~"billNo~": ~"124645~", ~"billAmount~": 240.00, ~"billType~" : ~"reminder~", ~"status~": ~"open~", ~"activePaymentDetails~": { ~"minimumAmountToBePayed~": 240.00, ~"bankAccountNo~": ~"123~", ~"bankAccountType~": ~"BGSE~", ~"bic~": ~"123456~", ~"iban~": ~"SE12345678945631~", ~"paymentReference~": ~"5465164654663~", ~"paymentOrdersExists~": true, }, ~"document~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-124645/document~" }, { ~"@id~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-123645~", ~"dueDate~": ~"2018-12-05~", ~"billDate~": ~"2018-11-15~", ~"billNo~": ~"124645~", ~"billAmount~": 240.00, ~"billType~" : ~"bill~", ~"status~": ~"closed~", ~"activePaymentDetails~": null, ~"document~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-124645/document~" }, { ~"@id~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/bills/bill-123645~", ~"dueDate~": ~"2018-12-05~", ~"billDate~": ~"2018-11-15~", ~"billNo~": ~"124645~", ~"billAmount~": 240.00, ~"billType~" : ~"bill~", ~"status~": ~"closed~", ~"activePaymentDetails~": null, ~"document~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-124645/document~" } ] }" data-widget="xwiki-macro" %) 235 +((( 236 +(% class="box" %) 237 +((( 238 +**Response** 239 + 240 +(% class="code" %) 241 +((( 242 +(% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) (% style="color:#666666" %)200(%%) (% style="color:#d2413a; font-weight:bold" %)**OK**(%%) 243 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/json 244 +\\{ 245 + (% style="color:#008000; font-weight:bold" %)**"@id"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/501/accounts/NNN/bills?status=open"(%%), 246 + (% style="color:#008000; font-weight:bold" %)**"items"**(%%) : [ 247 + { 248 + (% style="color:#008000; font-weight:bold" %)**"@id"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-123645"(%%), 249 + (% style="color:#008000; font-weight:bold" %)**"dueDate"**(%%): (% style="color:#ba2121" %)"2018-12-05"(%%), 250 + (% style="color:#008000; font-weight:bold" %)**"billDate"**(%%): (% style="color:#ba2121" %)"2018-11-15"(%%), 251 + (% style="color:#008000; font-weight:bold" %)**"billNo"**(%%): (% style="color:#ba2121" %)"124645"(%%), 252 + (% style="color:#008000; font-weight:bold" %)**"billAmount"**(%%): (% style="color:#666666" %)240.00(%%), 253 + (% style="color:#008000; font-weight:bold" %)**"billType"**(%%) : (% style="color:#ba2121" %)"reminder"(%%), 254 + (% style="color:#008000; font-weight:bold" %)**"status"**(%%): (% style="color:#ba2121" %)"open"(%%), 255 + (% style="color:#008000; font-weight:bold" %)**"activePaymentDetails"**(%%): { 256 + (% style="color:#008000; font-weight:bold" %)**"minimumAmountToBePayed"**(%%): (% style="color:#666666" %)240.00(%%), 257 + (% style="color:#008000; font-weight:bold" %)**"bankAccountNo"**(%%): (% style="color:#ba2121" %)"123"(%%), 258 + (% style="color:#008000; font-weight:bold" %)**"bankAccountType"**(%%): (% style="color:#ba2121" %)"BGSE"(%%), 259 + (% style="color:#008000; font-weight:bold" %)**"bic"**(%%): (% style="color:#ba2121" %)"123456"(%%), 260 + (% style="color:#008000; font-weight:bold" %)**"iban"**(%%): (% style="color:#ba2121" %)"SE12345678945631"(%%), 261 + (% style="color:#008000; font-weight:bold" %)**"paymentReference"**(%%): (% style="color:#ba2121" %)"5465164654663"(%%), 262 + (% style="color:#008000; font-weight:bold" %)**"paymentOrdersExists"**(%%): (% style="color:#008000; font-weight:bold" %)**true**(%%), 263 + }, 264 + (% style="color:#008000; font-weight:bold" %)**"document"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-124645/document"(%%) 265 + }, 266 + { 267 + (% style="color:#008000; font-weight:bold" %)**"@id"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-123645"(%%), 268 + (% style="color:#008000; font-weight:bold" %)**"dueDate"**(%%): (% style="color:#ba2121" %)"2018-12-05"(%%), 269 + (% style="color:#008000; font-weight:bold" %)**"billDate"**(%%): (% style="color:#ba2121" %)"2018-11-15"(%%), 270 + (% style="color:#008000; font-weight:bold" %)**"billNo"**(%%): (% style="color:#ba2121" %)"124645"(%%), 271 + (% style="color:#008000; font-weight:bold" %)**"billAmount"**(%%): (% style="color:#666666" %)240.00(%%), 272 + (% style="color:#008000; font-weight:bold" %)**"billType"**(%%) : (% style="color:#ba2121" %)"bill"(%%), 273 + (% style="color:#008000; font-weight:bold" %)**"status"**(%%): (% style="color:#ba2121" %)"closed"(%%), 274 + (% style="color:#008000; font-weight:bold" %)**"activePaymentDetails"**(%%): (% style="color:#008000; font-weight:bold" %)**null**(%%), 275 + (% style="color:#008000; font-weight:bold" %)**"document"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-124645/document"(%%) 276 + }, 277 + { 278 + (% style="color:#008000; font-weight:bold" %)**"@id"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/bills/bill-123645"(%%), 279 + (% style="color:#008000; font-weight:bold" %)**"dueDate"**(%%): (% style="color:#ba2121" %)"2018-12-05"(%%), 280 + (% style="color:#008000; font-weight:bold" %)**"billDate"**(%%): (% style="color:#ba2121" %)"2018-11-15"(%%), 281 + (% style="color:#008000; font-weight:bold" %)**"billNo"**(%%): (% style="color:#ba2121" %)"124645"(%%), 282 + (% style="color:#008000; font-weight:bold" %)**"billAmount"**(%%): (% style="color:#666666" %)240.00(%%), 283 + (% style="color:#008000; font-weight:bold" %)**"billType"**(%%) : (% style="color:#ba2121" %)"bill"(%%), 284 + (% style="color:#008000; font-weight:bold" %)**"status"**(%%): (% style="color:#ba2121" %)"closed"(%%), 285 + (% style="color:#008000; font-weight:bold" %)**"activePaymentDetails"**(%%): (% style="color:#008000; font-weight:bold" %)**null**(%%), 286 + (% style="color:#008000; font-weight:bold" %)**"document"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-124645/document"(%%) 287 + } 288 + ] 289 +} 139 139 ))) 291 +))) 292 +))) 293 +))) 140 140 141 141 ==== ==== 142 142 143 143 ==== Requesting details of a specific bill ==== 144 144 299 + 145 145 (% contenteditable="false" tabindex="-1" %) 146 146 ((( 147 -{{code language="http" title="**Request**"}} 148 -GET /ledger/credit-account/v1/XXX/accounts/NNN/bills/456 HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json 149 -{{/code}} 302 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Request**~"|-|GET /ledger/credit-account/v1/XXX/accounts/NNN/bills/456 HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json" data-widget="xwiki-macro" %) 303 +((( 304 +(% class="box" %) 305 +((( 306 +**Request** 307 + 308 +(% class="code" %) 309 +((( 310 +(% style="color:#0000ff" %)GET(%%) (% style="color:#0000ff; font-weight:bold" %)**/ledger/credit-account/v1/XXX/accounts/NNN/bills/456**(%%) (% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) 311 +(% style="color:#7d9029" %)Host(% style="color:#666666" %):(%%) - 312 +(% style="color:#7d9029" %)Authorization(% style="color:#666666" %):(%%) Bearer <Token> 313 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/json 150 150 ))) 315 +))) 316 +))) 317 +))) 151 151 319 + 152 152 (% contenteditable="false" tabindex="-1" %) 153 153 ((( 154 -{{code language="http" title="**Response**"}} 155 -HTTP/1.1 200 OK Content-Type: application/json { "@id": "/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-123645", "dueDate": "2018-12-05", "billDate": "2018-11-15", "billNo": "124645", "billAmount": 240.00, "billType" : "reminder", "status": "open", "activePaymentDetails": { "minimumAmountToBePayed": 240.00, "bankAccountNo": "123", "bankAccountType": "BGSE", "bic": "123456", "iban": "SE12345678945631", "paymentReference": "5465164654663", "paymentOrdersExists": true, }, "document": "/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-124645/document" } 156 -{{/code}} 322 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Response**~"|-|HTTP/1.1 200 OK Content-Type: application/json { ~"@id~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-123645~", ~"dueDate~": ~"2018-12-05~", ~"billDate~": ~"2018-11-15~", ~"billNo~": ~"124645~", ~"billAmount~": 240.00, ~"billType~" : ~"reminder~", ~"status~": ~"open~", ~"activePaymentDetails~": { ~"minimumAmountToBePayed~": 240.00, ~"bankAccountNo~": ~"123~", ~"bankAccountType~": ~"BGSE~", ~"bic~": ~"123456~", ~"iban~": ~"SE12345678945631~", ~"paymentReference~": ~"5465164654663~", ~"paymentOrdersExists~": true, }, ~"document~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-124645/document~" }" data-widget="xwiki-macro" %) 323 +((( 324 +(% class="box" %) 325 +((( 326 +**Response** 327 + 328 +(% class="code" %) 329 +((( 330 +(% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) (% style="color:#666666" %)200(%%) (% style="color:#d2413a; font-weight:bold" %)**OK**(%%) 331 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/json 332 +\\{ 333 + (% style="color:#008000; font-weight:bold" %)**"@id"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-123645"(%%), 334 + (% style="color:#008000; font-weight:bold" %)**"dueDate"**(%%): (% style="color:#ba2121" %)"2018-12-05"(%%), 335 + (% style="color:#008000; font-weight:bold" %)**"billDate"**(%%): (% style="color:#ba2121" %)"2018-11-15"(%%), 336 + (% style="color:#008000; font-weight:bold" %)**"billNo"**(%%): (% style="color:#ba2121" %)"124645"(%%), 337 + (% style="color:#008000; font-weight:bold" %)**"billAmount"**(%%): (% style="color:#666666" %)240.00(%%), 338 + (% style="color:#008000; font-weight:bold" %)**"billType"**(%%) : (% style="color:#ba2121" %)"reminder"(%%), 339 + (% style="color:#008000; font-weight:bold" %)**"status"**(%%): (% style="color:#ba2121" %)"open"(%%), 340 + (% style="color:#008000; font-weight:bold" %)**"activePaymentDetails"**(%%): { 341 + (% style="color:#008000; font-weight:bold" %)**"minimumAmountToBePayed"**(%%): (% style="color:#666666" %)240.00(%%), 342 + (% style="color:#008000; font-weight:bold" %)**"bankAccountNo"**(%%): (% style="color:#ba2121" %)"123"(%%), 343 + (% style="color:#008000; font-weight:bold" %)**"bankAccountType"**(%%): (% style="color:#ba2121" %)"BGSE"(%%), 344 + (% style="color:#008000; font-weight:bold" %)**"bic"**(%%): (% style="color:#ba2121" %)"123456"(%%), 345 + (% style="color:#008000; font-weight:bold" %)**"iban"**(%%): (% style="color:#ba2121" %)"SE12345678945631"(%%), 346 + (% style="color:#008000; font-weight:bold" %)**"paymentReference"**(%%): (% style="color:#ba2121" %)"5465164654663"(%%), 347 + (% style="color:#008000; font-weight:bold" %)**"paymentOrdersExists"**(%%): (% style="color:#008000; font-weight:bold" %)**true**(%%), 348 + }, 349 + (% style="color:#008000; font-weight:bold" %)**"document"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/bills/reminder-124645/document"(%%) 350 +} 157 157 ))) 352 +))) 353 +))) 354 +))) 158 158 159 159 == == 160 160 ... ... @@ -202,17 +202,54 @@ 202 202 203 203 (% contenteditable="false" tabindex="-1" %) 204 204 ((( 205 -{{code language="http" title="**Request**"}} 206 -GET /ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting/ HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json 207 -{{/code}} 402 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Request**~"|-|GET /ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting/ HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json" data-widget="xwiki-macro" %) 403 +((( 404 +(% class="box" %) 405 +((( 406 +**Request** 407 + 408 +(% class="code" %) 409 +((( 410 +(% style="color:#0000ff" %)GET(%%) (% style="color:#0000ff; font-weight:bold" %)**/ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting/**(%%) (% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) 411 +(% style="color:#7d9029" %)Host(% style="color:#666666" %):(%%) - 412 +(% style="color:#7d9029" %)Authorization(% style="color:#666666" %):(%%) Bearer <Token> 413 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/json 208 208 ))) 415 +))) 416 +))) 417 +))) 209 209 419 + 210 210 (% contenteditable="false" tabindex="-1" %) 211 211 ((( 212 -{{code language="http" title="**Response**"}} 213 -HTTP/1.1 200 OK Content-Type: application/json { "@id" : "/ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting", "recurringPaymentMethod" : "autogiro", "recurringPaymentScope" : "fixedRecurring", "fixedRecurringAmount" : 1500.00, "parentHREF": "/ledger/credit-account/v1/XXX/accounts/NNN", "operation" : [ { "rel" : "partially-update-recurring-payment-consent", "method" : "patch", "href" : "/ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-consent" } ] } 214 -{{/code}} 422 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Response**~"|-|HTTP/1.1 200 OK Content-Type: application/json { ~"@id~" : ~"/ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting~", ~"recurringPaymentMethod~" : ~"autogiro~", ~"recurringPaymentScope~" : ~"fixedRecurring~", ~"fixedRecurringAmount~" : 1500.00, ~"parentHREF~": ~"/ledger/credit-account/v1/XXX/accounts/NNN~", ~"operation~" : [ { ~"rel~" : ~"partially-update-recurring-payment-consent~", ~"method~" : ~"patch~", ~"href~" : ~"/ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-consent~" } ] }" data-widget="xwiki-macro" %) 423 +((( 424 +(% class="box" %) 425 +((( 426 +**Response** 427 + 428 +(% class="code" %) 429 +((( 430 +(% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) (% style="color:#666666" %)200(%%) (% style="color:#d2413a; font-weight:bold" %)**OK**(%%) 431 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/json 432 +\\{ 433 + (% style="color:#008000; font-weight:bold" %)**"@id"**(%%) : (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting"(%%), 434 + (% style="color:#008000; font-weight:bold" %)**"recurringPaymentMethod"**(%%) : (% style="color:#ba2121" %)"autogiro"(%%), 435 + (% style="color:#008000; font-weight:bold" %)**"recurringPaymentScope"**(%%) : (% style="color:#ba2121" %)"fixedRecurring"(%%), 436 + (% style="color:#008000; font-weight:bold" %)**"fixedRecurringAmount"**(%%) : (% style="color:#666666" %)1500.00(%%), 437 + (% style="color:#008000; font-weight:bold" %)**"parentHREF"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN"(%%), 438 + (% style="color:#008000; font-weight:bold" %)**"operation"**(%%) : [ 439 + { 440 + (% style="color:#008000; font-weight:bold" %)**"rel"**(%%) : (% style="color:#ba2121" %)"partially-update-recurring-payment-consent"(%%), 441 + (% style="color:#008000; font-weight:bold" %)**"method"**(%%) : (% style="color:#ba2121" %)"patch"(%%), 442 + (% style="color:#008000; font-weight:bold" %)**"href"**(%%) : (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-consent"(%%) 443 + } 444 + ] 445 +} 215 215 ))) 447 +))) 448 +))) 449 +))) 216 216 217 217 ===== Update settings ===== 218 218 ... ... @@ -221,10 +221,26 @@ 221 221 222 222 (% contenteditable="false" tabindex="-1" %) 223 223 ((( 224 -{{code language="http" title="**Request**"}} 225 -PATCH /ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json { "recurringPaymentScope" : "billedAmount", "fixedRecurringAmount" : 0.00 } 226 -{{/code}} 458 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Request**~"|-|PATCH /ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json { ~"recurringPaymentScope~" : ~"billedAmount~", ~"fixedRecurringAmount~" : 0.00 }" data-widget="xwiki-macro" %) 459 +((( 460 +(% class="box" %) 461 +((( 462 +**Request** 463 + 464 +(% class="code" %) 465 +((( 466 +(% style="color:#0000ff" %)PATCH(%%) (% style="color:#0000ff; font-weight:bold" %)**/ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting**(%%) (% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) 467 +(% style="color:#7d9029" %)Host(% style="color:#666666" %):(%%) - 468 +(% style="color:#7d9029" %)Authorization(% style="color:#666666" %):(%%) Bearer <Token> 469 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/json 470 +\\{ 471 + (% style="color:#008000; font-weight:bold" %)**"recurringPaymentScope"**(%%) : (% style="color:#ba2121" %)"billedAmount"(%%), 472 + (% style="color:#008000; font-weight:bold" %)**"fixedRecurringAmount"**(%%) : (% style="color:#666666" %)0.00(%%) 473 +} 227 227 ))) 475 +))) 476 +))) 477 +))) 228 228 229 229 (% class="table-bordered table-striped" %) 230 230 |=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 58px;" %)Modify (patch)|=(% style="width: 1176px;" %)Description ... ... @@ -248,35 +248,158 @@ 248 248 249 249 (% contenteditable="false" tabindex="-1" %) 250 250 ((( 251 -{{code language="http" title="**Request**"}} 252 -POST /ledger/credit-account/v1/XXX/accounts/NNN/cards HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json { "token": "954c8699-b38f-47a2-b568-668b8837dad8", "PanTrunc": "85479*********648", "deleted" : false, "mainCard": true, "cardHolder" : { "number" : "123465", "name": "test testsson", "nationalConsumerIdentifier": { "value": "19101010-1010", "countryCode": "SE" } } } 253 -{{/code}} 501 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Request**~"|-|POST /ledger/credit-account/v1/XXX/accounts/NNN/cards HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json { ~"token~": ~"954c8699-b38f-47a2-b568-668b8837dad8~", ~"PanTrunc~": ~"85479*********648~", ~"deleted~" : false, ~"mainCard~": true, ~"cardHolder~" : { ~"number~" : ~"123465~", ~"name~": ~"test testsson~", ~"nationalConsumerIdentifier~": { ~"value~": ~"19101010-1010~", ~"countryCode~": ~"SE~" } } }" data-widget="xwiki-macro" %) 502 +((( 503 +(% class="box" %) 504 +((( 505 +**Request** 506 + 507 +(% class="code" %) 508 +((( 509 +(% style="color:#0000ff" %)POST(%%) (% style="color:#0000ff; font-weight:bold" %)**/ledger/credit-account/v1/XXX/accounts/NNN/cards**(%%) (% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) 510 +(% style="color:#7d9029" %)Host(% style="color:#666666" %):(%%) - 511 +(% style="color:#7d9029" %)Authorization(% style="color:#666666" %):(%%) Bearer <Token> 512 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/json 513 +\\{ 514 + (% style="color:#008000; font-weight:bold" %)**"token"**(%%): (% style="color:#ba2121" %)"954c8699-b38f-47a2-b568-668b8837dad8"(%%), 515 + (% style="color:#008000; font-weight:bold" %)**"PanTrunc"**(%%): (% style="color:#ba2121" %)"85479~*~*~*~*~*~*~*~**648"(%%), 516 + (% style="color:#008000; font-weight:bold" %)**"deleted"**(%%) : (% style="color:#008000; font-weight:bold" %)**false**(%%), 517 + (% style="color:#008000; font-weight:bold" %)**"mainCard"**(%%): (% style="color:#008000; font-weight:bold" %)**true**(%%), 518 + (% style="color:#008000; font-weight:bold" %)**"cardHolder"**(%%) : { 519 + (% style="color:#008000; font-weight:bold" %)**"number"**(%%) : (% style="color:#ba2121" %)"123465"(%%), 520 + (% style="color:#008000; font-weight:bold" %)**"name"**(%%): (% style="color:#ba2121" %)"test testsson"(%%), 521 + (% style="color:#008000; font-weight:bold" %)**"nationalConsumerIdentifier"**(%%): { 522 + (% style="color:#008000; font-weight:bold" %)**"value"**(%%): (% style="color:#ba2121" %)"19101010-1010"(%%), 523 + (% style="color:#008000; font-weight:bold" %)**"countryCode"**(%%): (% style="color:#ba2121" %)"SE"(%%) 524 + } 525 + } 526 +} 254 254 ))) 528 +))) 529 +))) 530 +))) 255 255 256 256 ==== List cards ==== 257 257 258 258 (% contenteditable="false" tabindex="-1" %) 259 259 ((( 260 -{{code language="http" title="**Request**"}} 261 -GET /ledger/credit-account/v1/XXX/accounts/NNN/cards HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json 262 -{{/code}} 536 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Request**~"|-|GET /ledger/credit-account/v1/XXX/accounts/NNN/cards HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json" data-widget="xwiki-macro" %) 537 +((( 538 +(% class="box" %) 539 +((( 540 +**Request** 541 + 542 +(% class="code" %) 543 +((( 544 +(% style="color:#0000ff" %)GET(%%) (% style="color:#0000ff; font-weight:bold" %)**/ledger/credit-account/v1/XXX/accounts/NNN/cards**(%%) (% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) 545 +(% style="color:#7d9029" %)Host(% style="color:#666666" %):(%%) - 546 +(% style="color:#7d9029" %)Authorization(% style="color:#666666" %):(%%) Bearer <Token> 547 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/json 548 + 263 263 ))) 550 +))) 551 +))) 552 +))) 264 264 554 + 265 265 (% contenteditable="false" tabindex="-1" %) 266 266 ((( 267 -{{code language="http" title="**Response**"}} 268 -HTTP/1.1 200 OK Content-Type: application/json { "operations": null, "items": [ { "token": "954c8699-b38f-47a2-b568-668b8837dad8", "PanTrunc": "85479*********648", "deleted" : false, "mainCard": true, "cardHolder" : { "number" : "123465", "name": "test testsson", "nationalConsumerIdentifier": { "value": "19101010-1010", "countryCode": "SE" } }, "@id": "/ledger/credit-account/v1/XXX/accounts/NNN/cards/741" }, { "token": "274c8699-b38f-47a2-b568-668b8837dat7", "PanTrunc": "78979*********321", "deleted" : false, "mainCard": false, "cardHolder" : { "number" : "987654", "name": "test testsson", "nationalConsumerIdentifier": { "value": "19101010-1010", "countryCode": "SE" } }, "@id": "/ledger/credit-account/v1/XXX/accounts/NNN/cards/274c8699-b38f-47a2-b568-668b8837dat7" } ], "@id": "/ledger/credit-account/v1/XXX/accounts/NNN/cards", "view": { "@id": "/ledger/credit-account/v1/XXX/accounts/NNN/cards?$top=2&$skip=0", "next": "/ledger/credit-account/v1/XXX/accounts/NNN/cards?$top=2&$skip=2" } } 269 -{{/code}} 557 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Response**~"|-|HTTP/1.1 200 OK Content-Type: application/json { ~"operations~": null, ~"items~": [ { ~"token~": ~"954c8699-b38f-47a2-b568-668b8837dad8~", ~"PanTrunc~": ~"85479*********648~", ~"deleted~" : false, ~"mainCard~": true, ~"cardHolder~" : { ~"number~" : ~"123465~", ~"name~": ~"test testsson~", ~"nationalConsumerIdentifier~": { ~"value~": ~"19101010-1010~", ~"countryCode~": ~"SE~" } }, ~"@id~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/cards/741~" }, { ~"token~": ~"274c8699-b38f-47a2-b568-668b8837dat7~", ~"PanTrunc~": ~"78979*********321~", ~"deleted~" : false, ~"mainCard~": false, ~"cardHolder~" : { ~"number~" : ~"987654~", ~"name~": ~"test testsson~", ~"nationalConsumerIdentifier~": { ~"value~": ~"19101010-1010~", ~"countryCode~": ~"SE~" } }, ~"@id~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/cards/274c8699-b38f-47a2-b568-668b8837dat7~" } ], ~"@id~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/cards~", ~"view~": { ~"@id~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/cards?$top=2&$skip=0~", ~"next~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/cards?$top=2&$skip=2~" } }" data-widget="xwiki-macro" %) 558 +((( 559 +(% class="box" %) 560 +((( 561 +**Response** 562 + 563 +(% class="code" %) 564 +((( 565 +(% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) (% style="color:#666666" %)200(%%) (% style="color:#d2413a; font-weight:bold" %)**OK**(%%) 566 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/json 567 +\\{ 568 + (% style="color:#008000; font-weight:bold" %)**"operations"**(%%): (% style="color:#008000; font-weight:bold" %)**null**(%%), 569 + (% style="color:#008000; font-weight:bold" %)**"items"**(%%): [ 570 + { 571 + (% style="color:#008000; font-weight:bold" %)**"token"**(%%): (% style="color:#ba2121" %)"954c8699-b38f-47a2-b568-668b8837dad8"(%%), 572 + (% style="color:#008000; font-weight:bold" %)**"PanTrunc"**(%%): (% style="color:#ba2121" %)"85479~*~*~*~*~*~*~*~**648"(%%), 573 + (% style="color:#008000; font-weight:bold" %)**"deleted"**(%%) : (% style="color:#008000; font-weight:bold" %)**false**(%%), 574 + (% style="color:#008000; font-weight:bold" %)**"mainCard"**(%%): (% style="color:#008000; font-weight:bold" %)**true**(%%), 575 + (% style="color:#008000; font-weight:bold" %)**"cardHolder"**(%%) : { 576 + (% style="color:#008000; font-weight:bold" %)**"number"**(%%) : (% style="color:#ba2121" %)"123465"(%%), 577 + (% style="color:#008000; font-weight:bold" %)**"name"**(%%): (% style="color:#ba2121" %)"test testsson"(%%), 578 + (% style="color:#008000; font-weight:bold" %)**"nationalConsumerIdentifier"**(%%): { 579 + (% style="color:#008000; font-weight:bold" %)**"value"**(%%): (% style="color:#ba2121" %)"19101010-1010"(%%), 580 + (% style="color:#008000; font-weight:bold" %)**"countryCode"**(%%): (% style="color:#ba2121" %)"SE"(%%) 581 + } 582 + }, 583 + (% style="color:#008000; font-weight:bold" %)**"@id"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/cards/741"(%%) 584 + }, 585 + { 586 + (% style="color:#008000; font-weight:bold" %)**"token"**(%%): (% style="color:#ba2121" %)"274c8699-b38f-47a2-b568-668b8837dat7"(%%), 587 + (% style="color:#008000; font-weight:bold" %)**"PanTrunc"**(%%): (% style="color:#ba2121" %)"78979~*~*~*~*~*~*~*~**321"(%%), 588 + (% style="color:#008000; font-weight:bold" %)**"deleted"**(%%) : (% style="color:#008000; font-weight:bold" %)**false**(%%), 589 + (% style="color:#008000; font-weight:bold" %)**"mainCard"**(%%): (% style="color:#008000; font-weight:bold" %)**false**(%%), 590 + (% style="color:#008000; font-weight:bold" %)**"cardHolder"**(%%) : { 591 + (% style="color:#008000; font-weight:bold" %)**"number"**(%%) : (% style="color:#ba2121" %)"987654"(%%), 592 + (% style="color:#008000; font-weight:bold" %)**"name"**(%%): (% style="color:#ba2121" %)"test testsson"(%%), 593 + (% style="color:#008000; font-weight:bold" %)**"nationalConsumerIdentifier"**(%%): { 594 + (% style="color:#008000; font-weight:bold" %)**"value"**(%%): (% style="color:#ba2121" %)"19101010-1010"(%%), 595 + (% style="color:#008000; font-weight:bold" %)**"countryCode"**(%%): (% style="color:#ba2121" %)"SE"(%%) 596 + } 597 + }, 598 + (% style="color:#008000; font-weight:bold" %)**"@id"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/cards/274c8699-b38f-47a2-b568-668b8837dat7"(%%) 599 + } 600 + ], 601 + (% style="color:#008000; font-weight:bold" %)**"@id"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/cards"(%%), 602 + (% style="color:#008000; font-weight:bold" %)**"view"**(%%): { 603 + (% style="color:#008000; font-weight:bold" %)**"@id"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/cards?$top=2&$skip=0"(%%), 604 + (% style="color:#008000; font-weight:bold" %)**"next"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/cards?$top=2&$skip=2"(%%) 605 + } 606 +} 270 270 ))) 608 +))) 609 +))) 610 +))) 271 271 272 272 ==== Get ==== 273 273 274 274 (% contenteditable="false" tabindex="-1" %) 275 275 ((( 276 -{{code language="http" title="**Response**"}} 277 -HTTP/1.1 200 OK Content-Type: application/json { "token": "954c8699-b38f-47a2-b568-668b8837dad8", "PanTrunc": "85479*********648", "deleted" : false, "mainCard": true, "cardHolder" : { "number" : "123465", "name": "test testsson", "nationalConsumerIdentifier": { "value": "19101010-1010", "countryCode": "SE" } }, "@id": "/ledger/credit-account/v1/XXX/accounts/NNN/cards/954c8699-b38f-47a2-b568-668b8837dad8", "parentHREF": "/ledger/credit-account/v1/XXX/accounts/NNN", "operation" : [ { "rel" : "partial-update", "method" : "patch", "href" : "/ledger/credit-account/v1/XXX/accounts/NNN/cards/954c8699-b38f-47a2-b568-668b8837dad8" } ] } 278 -{{/code}} 616 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Response**~"|-|HTTP/1.1 200 OK Content-Type: application/json { ~"token~": ~"954c8699-b38f-47a2-b568-668b8837dad8~", ~"PanTrunc~": ~"85479*********648~", ~"deleted~" : false, ~"mainCard~": true, ~"cardHolder~" : { ~"number~" : ~"123465~", ~"name~": ~"test testsson~", ~"nationalConsumerIdentifier~": { ~"value~": ~"19101010-1010~", ~"countryCode~": ~"SE~" } }, ~"@id~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/cards/954c8699-b38f-47a2-b568-668b8837dad8~", ~"parentHREF~": ~"/ledger/credit-account/v1/XXX/accounts/NNN~", ~"operation~" : [ { ~"rel~" : ~"partial-update~", ~"method~" : ~"patch~", ~"href~" : ~"/ledger/credit-account/v1/XXX/accounts/NNN/cards/954c8699-b38f-47a2-b568-668b8837dad8~" } ] }" data-widget="xwiki-macro" %) 617 +((( 618 +(% class="box" %) 619 +((( 620 +**Response** 621 + 622 +(% class="code" %) 623 +((( 624 +(% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) (% style="color:#666666" %)200(%%) (% style="color:#d2413a; font-weight:bold" %)**OK**(%%) 625 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/json 626 +\\{ 627 + (% style="color:#008000; font-weight:bold" %)**"token"**(%%): (% style="color:#ba2121" %)"954c8699-b38f-47a2-b568-668b8837dad8"(%%), 628 + (% style="color:#008000; font-weight:bold" %)**"PanTrunc"**(%%): (% style="color:#ba2121" %)"85479~*~*~*~*~*~*~*~**648"(%%), 629 + (% style="color:#008000; font-weight:bold" %)**"deleted"**(%%) : (% style="color:#008000; font-weight:bold" %)**false**(%%), 630 + (% style="color:#008000; font-weight:bold" %)**"mainCard"**(%%): (% style="color:#008000; font-weight:bold" %)**true**(%%), 631 + (% style="color:#008000; font-weight:bold" %)**"cardHolder"**(%%) : { 632 + (% style="color:#008000; font-weight:bold" %)**"number"**(%%) : (% style="color:#ba2121" %)"123465"(%%), 633 + (% style="color:#008000; font-weight:bold" %)**"name"**(%%): (% style="color:#ba2121" %)"test testsson"(%%), 634 + (% style="color:#008000; font-weight:bold" %)**"nationalConsumerIdentifier"**(%%): { 635 + (% style="color:#008000; font-weight:bold" %)**"value"**(%%): (% style="color:#ba2121" %)"19101010-1010"(%%), 636 + (% style="color:#008000; font-weight:bold" %)**"countryCode"**(%%): (% style="color:#ba2121" %)"SE"(%%) 637 + } 638 + }, 639 + (% style="color:#008000; font-weight:bold" %)**"@id"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/cards/954c8699-b38f-47a2-b568-668b8837dad8"(%%), 640 + (% style="color:#008000; font-weight:bold" %)**"parentHREF"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN"(%%), 641 + (% style="color:#008000; font-weight:bold" %)**"operation"**(%%) : [ 642 + { 643 + (% style="color:#008000; font-weight:bold" %)**"rel"**(%%) : (% style="color:#ba2121" %)"partial-update"(%%), 644 + (% style="color:#008000; font-weight:bold" %)**"method"**(%%) : (% style="color:#ba2121" %)"patch"(%%), 645 + (% style="color:#008000; font-weight:bold" %)**"href"**(%%) : (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/cards/954c8699-b38f-47a2-b568-668b8837dad8"(%%) 646 + } 647 + ] 648 +} 279 279 ))) 650 +))) 651 +))) 652 +))) 280 280 281 281 (% class="table-bordered table-striped" %) 282 282 |=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 62px;" %)Modify (patch)|=(% style="width: 1401px;" %)Description ... ... @@ -291,19 +291,78 @@ 291 291 292 292 === Transactions === 293 293 667 + 294 294 (% contenteditable="false" tabindex="-1" %) 295 295 ((( 296 -{{code language="http" title="**Request**"}} 297 -GET /ledger/credit-account/v1/XXX/accounts/NNN/transactions HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json 298 -{{/code}} 670 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Request**~"|-|GET /ledger/credit-account/v1/XXX/accounts/NNN/transactions HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json" data-widget="xwiki-macro" %) 671 +((( 672 +(% class="box" %) 673 +((( 674 +**Request** 675 + 676 +(% class="code" %) 677 +((( 678 +(% style="color:#0000ff" %)GET(%%) (% style="color:#0000ff; font-weight:bold" %)**/ledger/credit-account/v1/XXX/accounts/NNN/transactions**(%%) (% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) 679 +(% style="color:#7d9029" %)Host(% style="color:#666666" %):(%%) - 680 +(% style="color:#7d9029" %)Authorization(% style="color:#666666" %):(%%) Bearer <Token> 681 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/json 682 + 299 299 ))) 684 +))) 685 +))) 686 +))) 300 300 688 + 301 301 (% contenteditable="false" tabindex="-1" %) 302 302 ((( 303 -{{code language="http" title="**Response**"}} 304 -HTTP/1.1 200 OK Content-Type: application/json { "operations": null, "items": [ { "type": "payment", "description": "", "amount": 200.00, "billed": false|true, "date": "2019-10-09", "reserveDate": null }, { "type": "purchase", "description": "testbutiken, köpref. 12345689", "amount": 200.00, "billed": false|true, "date": "2019-10-09", "reserveDate": "2019-10-05", }, { "type": "credit", "description": "", "amount": 200.00, "billed": false|true, "date": "2019-10-09", "reserveDate": "2019-10-05" } ], "@id": "/ledger/credit-account/v1/XXX/accounts/NNN/transactions?fromDate=2019-10-01", "view": { "@id": "/ledger/credit-account/v1/XXX/accounts/NNN/transactions?fromDate=2019-10-01&$top=2&$skip=0", "next": "/ledger/credit-account/v1/XXX/accounts/NNN/transactions?fromDate=2019-10-01&$top=2&$skip=2" } } 305 -{{/code}} 691 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Response**~"|-|HTTP/1.1 200 OK Content-Type: application/json { ~"operations~": null, ~"items~": [ { ~"type~": ~"payment~", ~"description~": ~"~", ~"amount~": 200.00, ~"billed~": false|true, ~"date~": ~"2019-10-09~", ~"reserveDate~": null }, { ~"type~": ~"purchase~", ~"description~": ~"testbutiken, köpref. 12345689~", ~"amount~": 200.00, ~"billed~": false|true, ~"date~": ~"2019-10-09~", ~"reserveDate~": ~"2019-10-05~", }, { ~"type~": ~"credit~", ~"description~": ~"~", ~"amount~": 200.00, ~"billed~": false|true, ~"date~": ~"2019-10-09~", ~"reserveDate~": ~"2019-10-05~" } ], ~"@id~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/transactions?fromDate=2019-10-01~", ~"view~": { ~"@id~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/transactions?fromDate=2019-10-01&$top=2&$skip=0~", ~"next~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/transactions?fromDate=2019-10-01&$top=2&$skip=2~" } }" data-widget="xwiki-macro" %) 692 +((( 693 +(% class="box" %) 694 +((( 695 +**Response** 696 + 697 +(% class="code" %) 698 +((( 699 +(% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) (% style="color:#666666" %)200(%%) (% style="color:#d2413a; font-weight:bold" %)**OK**(%%) 700 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/json 701 +\\{ 702 + (% style="color:#008000; font-weight:bold" %)**"operations"**(%%): (% style="color:#008000; font-weight:bold" %)**null**(%%), 703 + (% style="color:#008000; font-weight:bold" %)**"items"**(%%): [ 704 + { 705 + (% style="color:#008000; font-weight:bold" %)**"type"**(%%): (% style="color:#ba2121" %)"payment"(%%), 706 + (% style="color:#008000; font-weight:bold" %)**"description"**(%%): (% style="color:#ba2121" %)""(%%), 707 + (% style="color:#008000; font-weight:bold" %)**"amount"**(%%): (% style="color:#666666" %)200.00(%%), 708 + (% style="color:#008000; font-weight:bold" %)**"billed"**(%%): (% style="color:#008000; font-weight:bold" %)**false**(% style="border:1px solid #ff0000" %)|(% style="color:#008000; font-weight:bold" %)**true**(%%), 709 + (% style="color:#008000; font-weight:bold" %)**"date"**(%%): (% style="color:#ba2121" %)"2019-10-09"(%%), 710 + (% style="color:#008000; font-weight:bold" %)**"reserveDate"**(%%): (% style="color:#008000; font-weight:bold" %)**null**(%%) 711 + }, 712 + { 713 + (% style="color:#008000; font-weight:bold" %)**"type"**(%%): (% style="color:#ba2121" %)"purchase"(%%), 714 + (% style="color:#008000; font-weight:bold" %)**"description"**(%%): (% style="color:#ba2121" %)"testbutiken, köpref. 12345689"(%%), 715 + (% style="color:#008000; font-weight:bold" %)**"amount"**(%%): (% style="color:#666666" %)200.00(%%), 716 + (% style="color:#008000; font-weight:bold" %)**"billed"**(%%): (% style="color:#008000; font-weight:bold" %)**false**(% style="border:1px solid #ff0000" %)|(% style="color:#008000; font-weight:bold" %)**true**(%%), 717 + (% style="color:#008000; font-weight:bold" %)**"date"**(%%): (% style="color:#ba2121" %)"2019-10-09"(%%), 718 + (% style="color:#008000; font-weight:bold" %)**"reserveDate"**(%%): (% style="color:#ba2121" %)"2019-10-05"(%%), 719 + }, 720 + { 721 + (% style="color:#008000; font-weight:bold" %)**"type"**(%%): (% style="color:#ba2121" %)"credit"(%%), 722 + (% style="color:#008000; font-weight:bold" %)**"description"**(%%): (% style="color:#ba2121" %)""(%%), 723 + (% style="color:#008000; font-weight:bold" %)**"amount"**(%%): (% style="color:#666666" %)200.00(%%), 724 + (% style="color:#008000; font-weight:bold" %)**"billed"**(%%): (% style="color:#008000; font-weight:bold" %)**false**(% style="border:1px solid #ff0000" %)|(% style="color:#008000; font-weight:bold" %)**true**(%%), 725 + (% style="color:#008000; font-weight:bold" %)**"date"**(%%): (% style="color:#ba2121" %)"2019-10-09"(%%), 726 + (% style="color:#008000; font-weight:bold" %)**"reserveDate"**(%%): (% style="color:#ba2121" %)"2019-10-05"(%%) 727 + } 728 + ], 729 + (% style="color:#008000; font-weight:bold" %)**"@id"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/transactions?fromDate=2019-10-01"(%%), 730 + (% style="color:#008000; font-weight:bold" %)**"view"**(%%): { 731 + (% style="color:#008000; font-weight:bold" %)**"@id"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/transactions?fromDate=2019-10-01&$top=2&$skip=0"(%%), 732 + (% style="color:#008000; font-weight:bold" %)**"next"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/transactions?fromDate=2019-10-01&$top=2&$skip=2"(%%) 733 + } 734 +} 306 306 ))) 736 +))) 737 +))) 738 +))) 307 307 308 308 (% class="table-bordered table-striped" %) 309 309 |=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 621px;" %)Description ... ... @@ -321,19 +321,60 @@ 321 321 322 322 === Reservations === 323 323 756 + 324 324 (% contenteditable="false" tabindex="-1" %) 325 325 ((( 326 -{{code language="http" title="**Request**"}} 327 -GET /ledger/credit-account/v1/XXX/accounts/NNN/reservations HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json 328 -{{/code}} 759 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Request**~"|-|GET /ledger/credit-account/v1/XXX/accounts/NNN/reservations HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json" data-widget="xwiki-macro" %) 760 +((( 761 +(% class="box" %) 762 +((( 763 +**Request** 764 + 765 +(% class="code" %) 766 +((( 767 +(% style="color:#0000ff" %)GET(%%) (% style="color:#0000ff; font-weight:bold" %)**/ledger/credit-account/v1/XXX/accounts/NNN/reservations**(%%) (% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) 768 +(% style="color:#7d9029" %)Host(% style="color:#666666" %):(%%) - 769 +(% style="color:#7d9029" %)Authorization(% style="color:#666666" %):(%%) Bearer <Token> 770 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/json 771 + 329 329 ))) 773 +))) 774 +))) 775 +))) 330 330 777 + 331 331 (% contenteditable="false" tabindex="-1" %) 332 332 ((( 333 -{{code language="http" title="**Response**"}} 334 -HTTP/1.1 201 Created Content-Type: application/json { "operations": null, "items": [ { "amount": 200.00, "description" : "", "date": "2019-10-05", }, { "amount": 450.00, "description" : "", "date": "2019-10-02", }, ], "@id": "/ledger/credit-account/v1/XXX/accounts/NNN/reservations", } 335 -{{/code}} 780 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Response**~"|-|HTTP/1.1 201 Created Content-Type: application/json { ~"operations~": null, ~"items~": [ { ~"amount~": 200.00, ~"description~" : ~"~", ~"date~": ~"2019-10-05~", }, { ~"amount~": 450.00, ~"description~" : ~"~", ~"date~": ~"2019-10-02~", }, ], ~"@id~": ~"/ledger/credit-account/v1/XXX/accounts/NNN/reservations~", }" data-widget="xwiki-macro" %) 781 +((( 782 +(% class="box" %) 783 +((( 784 +**Response** 785 + 786 +(% class="code" %) 787 +((( 788 +(% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) (% style="color:#666666" %)201(%%) (% style="color:#d2413a; font-weight:bold" %)**Created**(%%) 789 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/json 790 +\\{ 791 + (% style="color:#008000; font-weight:bold" %)**"operations"**(%%): (% style="color:#008000; font-weight:bold" %)**null**(%%), 792 + (% style="color:#008000; font-weight:bold" %)**"items"**(%%): [ 793 + { 794 + (% style="color:#008000; font-weight:bold" %)**"amount"**(%%): (% style="color:#666666" %)200.00(%%), 795 + (% style="color:#008000; font-weight:bold" %)**"description"**(%%) : (% style="color:#ba2121" %)""(%%), 796 + (% style="color:#008000; font-weight:bold" %)**"date"**(%%): (% style="color:#ba2121" %)"2019-10-05"(%%), 797 + }, 798 + { 799 + (% style="color:#008000; font-weight:bold" %)**"amount"**(%%): (% style="color:#666666" %)450.00(%%), 800 + (% style="color:#008000; font-weight:bold" %)**"description"**(%%) : (% style="color:#ba2121" %)""(%%), 801 + (% style="color:#008000; font-weight:bold" %)**"date"**(%%): (% style="color:#ba2121" %)"2019-10-02"(%%), 802 + }, 803 + ], 804 + (% style="color:#008000; font-weight:bold" %)**"@id"**(%%): (% style="color:#ba2121" %)"/ledger/credit-account/v1/XXX/accounts/NNN/reservations"(%%), 805 +} 336 336 ))) 807 +))) 808 +))) 809 +))) 337 337 338 338 (% class="table-bordered table-striped" %) 339 339 |=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 621px;" %)Description ... ... @@ -340,9 +340,12 @@ 340 340 |(% style="width:337px" %)amount|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:621px" %) 341 341 |(% style="width:337px" %)description|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:621px" %)Description of the reservation, normally "point of sale". 342 342 |(% style="width:337px" %)date|(% style="width:205px" %)date|(% style="width:208px" %) |(% style="width:621px" %)Date when the reservation occured 816 + 343 343 Problems 818 + 344 344 If an error occur or any validation failed, a "problem" response will be returned. 345 345 Below is a list of problems that can occur: 821 + 346 346 **HttpStatus 401 Unauthorized** 347 347 348 348 * Token expired ... ... @@ -349,12 +349,18 @@ 349 349 * Token invalid 350 350 * SellerNumber does not match token 351 351 * CompanyNumber does not match token 828 + 352 352 **HttpStatus 400 Error** 830 + 353 353 * Validation: Argument required 354 354 * Validation: Invalid value 833 + 355 355 **HttpStatus 422 Unprocessable entity** 835 + 356 356 * Authorization declined 837 + 357 357 **HttpStatus 409 Conflict** 839 + 358 358 * Invoice already authorized 359 359 * Duplicate InvoiceNumber 360 360 * Authorization is cancelled ... ... @@ -361,15 +361,44 @@ 361 361 * Authorization already captured 362 362 * Authorization has expired 363 363 * Insufficient debited amount XXX 846 + 364 364 **HttpStatus 501 NotImplemented** 848 + 365 365 * CompanyNumber XXX not configured 366 366 * SellerNumber XXX not configured at PayEx 367 367 * CompanyNumber XXX missing configuration 852 + 368 368 **HttpStatus 404 NotFound** 854 + 369 369 * Authorization not found 370 -Below is an example of a problem that will be returned if buyer##.nationalConsumerIdentifier.value## is not valid in the authorization post request.(% contenteditable="false" tabindex="-1" %) 856 + 857 +Below is an example of a problem that will be returned if buyer##.nationalConsumerIdentifier.value## is not valid in the authorization post request. 858 + 859 +(% contenteditable="false" tabindex="-1" %) 371 371 ((( 372 -{{code language="http" title="**Response**"}} 373 -HTTP/1.1 400 Error Content-Type: application/problem+json { "Type": "http://[DNS]/ledger/invoice-purchase/problems/validation", "Title": "A validation error occurred", "Status": 400, "Instance": null, "Detail": "A validation error occurred. Please fix the problems mentioned in the 'problems' property below.", "Problems": [ { "buyer.nationalConsumerIdentifier.value": "Not a valid SE nationalConsumerIdentifier" } ] } 374 -{{/code}} 861 +(% class="macro" data-macro="startmacro:code|-|language=~"http~" title=~"**Response**~"|-|HTTP/1.1 400 Error Content-Type: application/problem+json { ~"Type~": ~"http://[DNS]/ledger/invoice-purchase/problems/validation~", ~"Title~": ~"A validation error occurred~", ~"Status~": 400, ~"Instance~": null, ~"Detail~": ~"A validation error occurred. Please fix the problems mentioned in the 'problems' property below.~", ~"Problems~": [ { ~"buyer.nationalConsumerIdentifier.value~": ~"Not a valid SE nationalConsumerIdentifier~" } ] }" data-widget="xwiki-macro" %) 862 +((( 863 +(% class="box" %) 864 +((( 865 +**Response** 866 + 867 +(% class="code" %) 868 +((( 869 +(% style="color:#008000; font-weight:bold" %)**HTTP**(% style="color:#666666" %)/1.1(%%) (% style="color:#666666" %)400(%%) (% style="color:#d2413a; font-weight:bold" %)**Error**(%%) 870 +(% style="color:#7d9029" %)Content-Type(% style="color:#666666" %):(%%) application/problem+json 871 +\\{ 872 + (% style="color:#008000; font-weight:bold" %)**"Type"**(%%): (% style="color:#ba2121" %)"http:~/~/[DNS]/ledger/invoice-purchase/problems/validation"(%%), 873 + (% style="color:#008000; font-weight:bold" %)**"Title"**(%%): (% style="color:#ba2121" %)"A validation error occurred"(%%), 874 + (% style="color:#008000; font-weight:bold" %)**"Status"**(%%): (% style="color:#666666" %)400(%%), 875 + (% style="color:#008000; font-weight:bold" %)**"Instance"**(%%): (% style="color:#008000; font-weight:bold" %)**null**(%%), 876 + (% style="color:#008000; font-weight:bold" %)**"Detail"**(%%): (% style="color:#ba2121" %)"A validation error occurred. Please fix the problems mentioned in the 'problems' property below."(%%), 877 + (% style="color:#008000; font-weight:bold" %)**"Problems"**(%%): [ 878 + { 879 + (% style="color:#008000; font-weight:bold" %)**"buyer.nationalConsumerIdentifier.value"**(%%): (% style="color:#ba2121" %)"Not a valid SE nationalConsumerIdentifier"(%%) 880 + } 881 + ] 882 +} 375 375 ))) 884 +))) 885 +))) 886 +)))