Changes for page ../credit-account
Last modified by Helge Dahl on 2020/02/06 17:55
From version 89.1
edited by David Persson
on 2020/02/06 15:33
on 2020/02/06 15:33
To version 90.1
edited by David Persson
on 2020/02/06 16:43
on 2020/02/06 16:43
Change comment: There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -19,7 +19,6 @@ 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 - 23 23 (% contenteditable="false" tabindex="-1" %)[[image:1579213343157-343.png||data-widget="image" height="325" width="346"]] 24 24 25 25 (% id="HRoutesegments" %) ... ... @@ -26,7 +26,6 @@ 26 26 == Introduction == 27 27 28 28 Each resource in the API corresponds to its own route. All routes are structured according to a specific standard, explained below 29 - 30 30 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. 31 31 //api.payex.com/ledger/**{Subdomain}**/v1/**{LedgerNumber}**/resource1/**{resource1Id}**/resource2/**{resource2Id}**/resource3/**{resource3Id}**// 32 32 ... ... @@ -54,7 +54,6 @@ 54 54 55 55 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. 56 56 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 - 58 58 The following operations is supported 59 59 60 60 * Change the account credit limit ... ... @@ -65,19 +65,17 @@ 65 65 66 66 === Requesting details of a specific account === 67 67 68 - 69 69 (% contenteditable="false" tabindex="-1" %) 70 70 ((( 71 71 {{code language="http" title="**Request**"}} 72 -GET /ledger/credit-account/v1/XXX/accounts/NNN HTTP/1.1 68 +GET /ledger/credit-account/v1/XXX/accounts/NNN HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json 73 73 {{/code}} 74 74 ))) 75 75 76 - 77 77 (% contenteditable="false" tabindex="-1" %) 78 78 ((( 79 79 {{code language="http" title="**Response**"}} 80 -HTTP/1.1 200 OK 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" } ] } 81 81 {{/code}} 82 82 ))) 83 83 ... ... @@ -127,22 +127,19 @@ 127 127 128 128 The bills resources contains all the documents produced in the accounts billing cycle. 129 129 130 - 131 131 ==== Requesting list of bills belonging to a specific account ==== 132 132 133 - 134 134 (% contenteditable="false" tabindex="-1" %) 135 135 ((( 136 136 {{code language="http" title="**Request**"}} 137 -GET /ledger/credit-account/v1/XXX/accounts/NNN/bills HTTP/1.1 130 +GET /ledger/credit-account/v1/XXX/accounts/NNN/bills HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json 138 138 {{/code}} 139 139 ))) 140 140 141 - 142 142 (% contenteditable="false" tabindex="-1" %) 143 143 ((( 144 144 {{code language="http" title="**Response**"}} 145 -HTTP/1.1 200 OK 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" } ] } 146 146 {{/code}} 147 147 ))) 148 148 ... ... @@ -150,19 +150,17 @@ 150 150 151 151 ==== Requesting details of a specific bill ==== 152 152 153 - 154 154 (% contenteditable="false" tabindex="-1" %) 155 155 ((( 156 156 {{code language="http" title="**Request**"}} 157 -GET /ledger/credit-account/v1/XXX/accounts/NNN/bills/456 HTTP/1.1 148 +GET /ledger/credit-account/v1/XXX/accounts/NNN/bills/456 HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json 158 158 {{/code}} 159 159 ))) 160 160 161 - 162 162 (% contenteditable="false" tabindex="-1" %) 163 163 ((( 164 164 {{code language="http" title="**Response**"}} 165 -HTTP/1.1 200 OK 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" } 166 166 {{/code}} 167 167 ))) 168 168 ... ... @@ -213,15 +213,14 @@ 213 213 (% contenteditable="false" tabindex="-1" %) 214 214 ((( 215 215 {{code language="http" title="**Request**"}} 216 -GET /ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting/ HTTP/1.1 206 +GET /ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting/ HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json 217 217 {{/code}} 218 218 ))) 219 219 220 - 221 221 (% contenteditable="false" tabindex="-1" %) 222 222 ((( 223 223 {{code language="http" title="**Response**"}} 224 -HTTP/1.1 200 OK 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" } ] } 225 225 {{/code}} 226 226 ))) 227 227 ... ... @@ -233,7 +233,7 @@ 233 233 (% contenteditable="false" tabindex="-1" %) 234 234 ((( 235 235 {{code language="http" title="**Request**"}} 236 -PATCH /ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting HTTP/1.1 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 } 237 237 {{/code}} 238 238 ))) 239 239 ... ... @@ -260,7 +260,7 @@ 260 260 (% contenteditable="false" tabindex="-1" %) 261 261 ((( 262 262 {{code language="http" title="**Request**"}} 263 -POST /ledger/credit-account/v1/XXX/accounts/NNN/cards HTTP/1.1 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" } } } 264 264 {{/code}} 265 265 ))) 266 266 ... ... @@ -269,15 +269,14 @@ 269 269 (% contenteditable="false" tabindex="-1" %) 270 270 ((( 271 271 {{code language="http" title="**Request**"}} 272 -GET /ledger/credit-account/v1/XXX/accounts/NNN/cards HTTP/1.1 261 +GET /ledger/credit-account/v1/XXX/accounts/NNN/cards HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json 273 273 {{/code}} 274 274 ))) 275 275 276 - 277 277 (% contenteditable="false" tabindex="-1" %) 278 278 ((( 279 279 {{code language="http" title="**Response**"}} 280 -HTTP/1.1 200 OK 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" } } 281 281 {{/code}} 282 282 ))) 283 283 ... ... @@ -286,7 +286,7 @@ 286 286 (% contenteditable="false" tabindex="-1" %) 287 287 ((( 288 288 {{code language="http" title="**Response**"}} 289 -HTTP/1.1 200 OK 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" } ] } 290 290 {{/code}} 291 291 ))) 292 292 ... ... @@ -303,19 +303,17 @@ 303 303 304 304 === Transactions === 305 305 306 - 307 307 (% contenteditable="false" tabindex="-1" %) 308 308 ((( 309 309 {{code language="http" title="**Request**"}} 310 -GET /ledger/credit-account/v1/XXX/accounts/NNN/transactions HTTP/1.1 297 +GET /ledger/credit-account/v1/XXX/accounts/NNN/transactions HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json 311 311 {{/code}} 312 312 ))) 313 313 314 - 315 315 (% contenteditable="false" tabindex="-1" %) 316 316 ((( 317 317 {{code language="http" title="**Response**"}} 318 -HTTP/1.1 200 OK 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" } } 319 319 {{/code}} 320 320 ))) 321 321 ... ... @@ -335,19 +335,17 @@ 335 335 336 336 === Reservations === 337 337 338 - 339 339 (% contenteditable="false" tabindex="-1" %) 340 340 ((( 341 341 {{code language="http" title="**Request**"}} 342 -GET /ledger/credit-account/v1/XXX/accounts/NNN/reservations HTTP/1.1 327 +GET /ledger/credit-account/v1/XXX/accounts/NNN/reservations HTTP/1.1 Host: - Authorization: Bearer <Token> Content-Type: application/json 343 343 {{/code}} 344 344 ))) 345 345 346 - 347 347 (% contenteditable="false" tabindex="-1" %) 348 348 ((( 349 349 {{code language="http" title="**Response**"}} 350 -HTTP/1.1 201 Created 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", } 351 351 {{/code}} 352 352 ))) 353 353 ... ... @@ -356,12 +356,9 @@ 356 356 |(% style="width:337px" %)amount|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:621px" %) 357 357 |(% style="width:337px" %)description|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:621px" %)Description of the reservation, normally "point of sale". 358 358 |(% style="width:337px" %)date|(% style="width:205px" %)date|(% style="width:208px" %) |(% style="width:621px" %)Date when the reservation occured 359 - 360 360 Problems 361 - 362 362 If an error occur or any validation failed, a "problem" response will be returned. 363 363 Below is a list of problems that can occur: 364 - 365 365 **HttpStatus 401 Unauthorized** 366 366 367 367 * Token expired ... ... @@ -368,18 +368,12 @@ 368 368 * Token invalid 369 369 * SellerNumber does not match token 370 370 * CompanyNumber does not match token 371 - 372 372 **HttpStatus 400 Error** 373 - 374 374 * Validation: Argument required 375 375 * Validation: Invalid value 376 - 377 377 **HttpStatus 422 Unprocessable entity** 378 - 379 379 * Authorization declined 380 - 381 381 **HttpStatus 409 Conflict** 382 - 383 383 * Invoice already authorized 384 384 * Duplicate InvoiceNumber 385 385 * Authorization is cancelled ... ... @@ -386,22 +386,15 @@ 386 386 * Authorization already captured 387 387 * Authorization has expired 388 388 * Insufficient debited amount XXX 389 - 390 390 **HttpStatus 501 NotImplemented** 391 - 392 392 * CompanyNumber XXX not configured 393 393 * SellerNumber XXX not configured at PayEx 394 394 * CompanyNumber XXX missing configuration 395 - 396 396 **HttpStatus 404 NotFound** 397 - 398 398 * Authorization not found 399 - 400 -Below is an example of a problem that will be returned if buyer##.nationalConsumerIdentifier.value## is not valid in the authorization post request. 401 - 402 -(% contenteditable="false" tabindex="-1" %) 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" %) 403 403 ((( 404 404 {{code language="http" title="**Response**"}} 405 -HTTP/1.1 400 Error 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" } ] } 406 406 {{/code}} 407 407 )))