Changes for page ../credit-account
Last modified by dap on 2022/08/11 10:52
From version 104.1
edited by dap
on 2020/02/06 22:38
on 2020/02/06 22:38
To version 105.1
edited by dap
on 2020/02/06 22:39
on 2020/02/06 22:39
Change comment: There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -320,75 +320,6 @@ 320 320 //More detailed information about the payment order can be found on the accounts resource// 321 321 |(% style="width:337px" %)document|(% style="width:205px" %)string|(% style="width:208px" %)Url|(% style="width:621px" %)Url to download pdf document 322 322 323 -=== === 324 - 325 -=== recurring-payment-setting === 326 - 327 -(% class="wikigeneratedid" %) 328 -This resource contain information/settings related to how recurring payments should behave on this account. 329 - 330 -===== 331 -Requesting the resource ===== 332 - 333 -{{code language="http" title="**Request**"}} 334 -GET /ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting/ HTTP/1.1 335 -Host: - 336 -Authorization: Bearer <Token> 337 -Content-Type: application/json 338 -{{/code}} 339 - 340 - 341 -{{code language="http" title="**Response**"}} 342 -HTTP/1.1 200 OK 343 -Content-Type: application/json 344 - 345 -{ 346 - "@id" : "/ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting", 347 - "recurringPaymentMethod" : "autogiro", 348 - "recurringPaymentScope" : "fixedRecurring", 349 - "fixedRecurringAmount" : 1500.00, 350 - "parentHREF": "/ledger/credit-account/v1/XXX/accounts/NNN", 351 - "operation" : [ 352 - { 353 - "rel" : "partially-update-recurring-payment-consent", 354 - "method" : "patch", 355 - "href" : "/ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-consent" 356 - } 357 - ] 358 -} 359 -{{/code}} 360 - 361 -===== Update settings ===== 362 - 363 -(% class="wikigeneratedid" %) 364 -Execute http patch towards this resource to change how recurring payments should behave on the specified account 365 - 366 -{{code language="http" title="**Request**"}} 367 -PATCH /ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting HTTP/1.1 368 -Host: - 369 -Authorization: Bearer <Token> 370 -Content-Type: application/json 371 - 372 -{ 373 - "recurringPaymentScope" : "billedAmount", 374 - "fixedRecurringAmount" : 0.00 375 -} 376 -{{/code}} 377 - 378 -(% class="table-bordered table-striped" %) 379 -|=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 58px;" %)Modify (patch)|=(% style="width: 1176px;" %)Description 380 -|(% style="width:337px" %)recurringPaymentMethod|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="background-color:palegreen; width:58px" %) |(% style="width:1176px" %)recurringPaymentMethods:((( 381 -* autogiro 382 -))) 383 -|(% style="width:337px" %)recurringPaymentScope|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="background-color:palegreen; width:58px" %) |(% style="width:1176px" %)((( 384 -recurringPaymentScopes: 385 - 386 -* fixedRecurring (Fixed amount to debit monthly) 387 -* totalDebt (Total credit-account debt will be debited) 388 -* billedAmount (Only the minimum amount to pay will be debited) 389 -))) 390 -|(% style="width:337px" %)fixedRecurringAmount|(% 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") 391 - 392 392 === Cards === 393 393 394 394 ==== Post ==== ... ... @@ -625,8 +625,75 @@ 625 625 |(% style="width:337px" %)description|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:621px" %)Description of the reservation, normally "point of sale". 626 626 |(% style="width:337px" %)date|(% style="width:205px" %)date|(% style="width:208px" %) |(% style="width:621px" %)Date when the reservation occured 627 627 628 - Problems559 +=== recurring-payment-setting === 629 629 561 +(% class="wikigeneratedid" %) 562 +This resource contain information/settings related to how recurring payments should behave on this account. 563 + 564 +===== 565 +Requesting the resource ===== 566 + 567 +{{code language="http" title="**Request**"}} 568 +GET /ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting/ HTTP/1.1 569 +Host: - 570 +Authorization: Bearer <Token> 571 +Content-Type: application/json 572 +{{/code}} 573 + 574 + 575 +{{code language="http" title="**Response**"}} 576 +HTTP/1.1 200 OK 577 +Content-Type: application/json 578 + 579 +{ 580 + "@id" : "/ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting", 581 + "recurringPaymentMethod" : "autogiro", 582 + "recurringPaymentScope" : "fixedRecurring", 583 + "fixedRecurringAmount" : 1500.00, 584 + "parentHREF": "/ledger/credit-account/v1/XXX/accounts/NNN", 585 + "operation" : [ 586 + { 587 + "rel" : "partially-update-recurring-payment-consent", 588 + "method" : "patch", 589 + "href" : "/ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-consent" 590 + } 591 + ] 592 +} 593 +{{/code}} 594 + 595 +===== Update settings ===== 596 + 597 +(% class="wikigeneratedid" %) 598 +Execute http patch towards this resource to change how recurring payments should behave on the specified account 599 + 600 +{{code language="http" title="**Request**"}} 601 +PATCH /ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting HTTP/1.1 602 +Host: - 603 +Authorization: Bearer <Token> 604 +Content-Type: application/json 605 + 606 +{ 607 + "recurringPaymentScope" : "billedAmount", 608 + "fixedRecurringAmount" : 0.00 609 +} 610 +{{/code}} 611 + 612 +(% class="table-bordered table-striped" %) 613 +|=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 58px;" %)Modify (patch)|=(% style="width: 1176px;" %)Description 614 +|(% style="width:337px" %)recurringPaymentMethod|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="background-color:palegreen; width:58px" %) |(% style="width:1176px" %)recurringPaymentMethods:((( 615 +* autogiro 616 +))) 617 +|(% style="width:337px" %)recurringPaymentScope|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="background-color:palegreen; width:58px" %) |(% style="width:1176px" %)((( 618 +recurringPaymentScopes: 619 + 620 +* fixedRecurring (Fixed amount to debit monthly) 621 +* totalDebt (Total credit-account debt will be debited) 622 +* billedAmount (Only the minimum amount to pay will be debited) 623 +))) 624 +|(% style="width:337px" %)fixedRecurringAmount|(% 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") 625 + 626 +=== Problems === 627 + 630 630 If an error occur or any validation failed, a "problem" response will be returned. 631 631 Below is a list of problems that can occur: 632 632