Changes for page ../credit-account

Last modified by dap on 2022/08/11 10:52
From version 109.1
edited by dap
on 2020/02/06 22:53
To version 109.2
edited by dap
on 2020/02/06 22:53
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -505,7 +505,7 @@
505 505  }
506 506  {{/code}}
507 507  
508 -==== Transaction resource properties ====
508 +==== Transaction resource properties ====
509 509  
510 510  (% class="table-bordered table-striped" %)
511 511  |=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 621px;" %)Description
... ... @@ -557,7 +557,7 @@
557 557  }
558 558  {{/code}}
559 559  
560 -==== Reservation resource properties ====
560 +==== Reservation resource properties ====
561 561  
562 562  (% class="table-bordered table-striped" %)
563 563  |=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 621px;" %)Description
... ... @@ -570,8 +570,8 @@
570 570  (% class="wikigeneratedid" %)
571 571  This resource contain information/settings related to how recurring payments should behave on this account.
572 572  
573 -=====
574 -Get settings on an account =====
573 +====
574 +Get settings on an account ====
575 575  
576 576  {{code language="http" title="**Request**"}}
577 577  GET /ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting/ HTTP/1.1
... ... @@ -580,6 +580,7 @@
580 580  Content-Type: application/json
581 581  {{/code}}
582 582  
583 +==== ====
583 583  
584 584  {{code language="http" title="**Response**"}}
585 585  HTTP/1.1 200 OK
... ... @@ -601,10 +601,11 @@
601 601  }
602 602  {{/code}}
603 603  
605 +(% class="wikigeneratedid" %)
604 604  ==== Update settings on an account ====
605 605  
606 606  (% class="wikigeneratedid" %)
607 -Execute http patch towards this resource to change how recurring payments should behave on the specified account
609 +==== Execute http patch towards this resource to change how recurring payments should behave on the specified account ====
608 608  
609 609  {{code language="http" title="**Request**"}}
610 610  PATCH /ledger/credit-account/v1/XXX/accounts/NNN/recurring-payment-setting HTTP/1.1
... ... @@ -618,64 +618,148 @@
618 618  }
619 619  {{/code}}
620 620  
621 -==== Recurring-payment-setting resource properties ====
623 +(% class="wikigeneratedid" %)
624 +==== Recurring-payment-setting resource properties ====
622 622  
623 623  (% class="table-bordered table-striped" %)
624 -|=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 58px;" %)Modify (patch)|=(% style="width: 1176px;" %)Description
625 -|(% style="width:337px" %)recurringPaymentMethod|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="background-color:palegreen; width:58px" %) |(% style="width:1176px" %)recurringPaymentMethods:(((
626 -* autogiro
627 +|=(% style="width: 337px;" %)(((
628 +==== Property ====
629 +)))|=(% style="width: 205px;" %)(((
630 +==== Data type ====
631 +)))|=(% style="width: 208px;" %)(((
632 +==== Format ====
633 +)))|=(% style="width: 58px;" %)(((
634 +==== Modify (patch) ====
635 +)))|=(% style="width: 1176px;" %)(((
636 +==== Description ====
627 627  )))
628 -|(% style="width:337px" %)recurringPaymentScope|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="background-color:palegreen; width:58px" %) |(% style="width:1176px" %)(((
629 -recurringPaymentScopes:
638 +|(% style="width:337px" %)(((
639 +==== recurringPaymentMethod ====
640 +)))|(% style="width:205px" %)(((
641 +==== string ====
642 +)))|(% style="width:208px" %)(((
643 +==== ====
644 +)))|(% style="background-color:palegreen; width:58px" %)(((
645 +==== ====
646 +)))|(% style="width:1176px" %)(((
647 +==== recurringPaymentMethods: ====
630 630  
631 -* fixedRecurring (Fixed amount to debit monthly)
632 -* totalDebt (Total credit-account debt will be debited)
633 -* billedAmount (Only the minimum amount to pay will be debited)
649 +(((
650 +* (((
651 +==== autogiro ====
634 634  )))
635 -|(% 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")
653 +)))
654 +)))
655 +|(% style="width:337px" %)(((
656 +==== recurringPaymentScope ====
657 +)))|(% style="width:205px" %)(((
658 +==== string ====
659 +)))|(% style="width:208px" %)(((
660 +==== ====
661 +)))|(% style="background-color:palegreen; width:58px" %)(((
662 +==== ====
663 +)))|(% style="width:1176px" %)(((
664 +==== recurringPaymentScopes: ====
636 636  
637 -=== Problems ===
666 +* (((
667 +==== fixedRecurring (Fixed amount to debit monthly) ====
668 +)))
669 +* (((
670 +==== totalDebt (Total credit-account debt will be debited) ====
671 +)))
672 +* (((
673 +==== billedAmount (Only the minimum amount to pay will be debited) ====
674 +)))
675 +)))
676 +|(% style="width:337px" %)(((
677 +==== fixedRecurringAmount ====
678 +)))|(% style="width:205px" %)(((
679 +==== decimal ====
680 +)))|(% style="width:208px" %)(((
681 +==== ====
682 +)))|(% style="background-color:palegreen; width:58px" %)(((
683 +==== ====
684 +)))|(% style="width:1176px" %)(((
685 +==== amount to monthly debit end-customers bankaccount (Only valid if recurringPaymentScope is set to "fixedRecurring") ====
686 +)))
638 638  
639 -If an error occur or any validation failed, a "problem" response will be returned.
640 -Below is a list of problems that can occur:
688 +(% class="wikigeneratedid" %)
689 +==== Problems ====
641 641  
642 -**HttpStatus 401 Unauthorized**
691 +==== If an error occur or any validation failed, a "problem" response will be returned.
692 +Below is a list of problems that can occur: ====
643 643  
644 -* Token expired
645 -* Token invalid
646 -* SellerNumber does not match token
647 -* CompanyNumber does not match token
694 +==== **HttpStatus 401 Unauthorized** ====
648 648  
649 -**HttpStatus 400 Error**
696 +* (((
697 +==== Token expired ====
698 +)))
699 +* (((
700 +==== Token invalid ====
701 +)))
702 +* (((
703 +==== SellerNumber does not match token ====
704 +)))
705 +* (((
706 +==== CompanyNumber does not match token ====
707 +)))
650 650  
651 -* Validation: Argument required
652 -* Validation: Invalid value
709 +==== **HttpStatus 400 Error** ====
653 653  
654 -**HttpStatus 422 Unprocessable entity**
711 +* (((
712 +==== Validation: Argument required ====
713 +)))
714 +* (((
715 +==== Validation: Invalid value ====
716 +)))
655 655  
656 -* Authorization declined
718 +==== **HttpStatus 422 Unprocessable entity** ====
657 657  
658 -**HttpStatus 409 Conflict**
720 +* (((
721 +==== Authorization declined ====
722 +)))
659 659  
660 -* Invoice already authorized
661 -* Duplicate InvoiceNumber
662 -* Authorization is cancelled
663 -* Authorization already captured
664 -* Authorization has expired
665 -* Insufficient debited amount XXX
724 +==== **HttpStatus 409 Conflict** ====
666 666  
667 -**HttpStatus 501 NotImplemented**
726 +* (((
727 +==== Invoice already authorized ====
728 +)))
729 +* (((
730 +==== Duplicate InvoiceNumber ====
731 +)))
732 +* (((
733 +==== Authorization is cancelled ====
734 +)))
735 +* (((
736 +==== Authorization already captured ====
737 +)))
738 +* (((
739 +==== Authorization has expired ====
740 +)))
741 +* (((
742 +==== Insufficient debited amount XXX ====
743 +)))
668 668  
669 -* CompanyNumber XXX not configured
670 -* SellerNumber XXX not configured at PayEx
671 -* CompanyNumber XXX missing configuration
745 +==== **HttpStatus 501 NotImplemented** ====
672 672  
673 -**HttpStatus 404 NotFound**
747 +* (((
748 +==== CompanyNumber XXX not configured ====
749 +)))
750 +* (((
751 +==== SellerNumber XXX not configured at PayEx ====
752 +)))
753 +* (((
754 +==== CompanyNumber XXX missing configuration ====
755 +)))
674 674  
675 -* Authorization not found
757 +==== **HttpStatus 404 NotFound** ====
676 676  
677 -Below is an example of a problem that will be returned if buyer##.nationalConsumerIdentifier.value## is not valid in the authorization post request.
759 +* (((
760 +==== Authorization not found ====
761 +)))
678 678  
763 +==== Below is an example of a problem that will be returned if buyer##.nationalConsumerIdentifier.value## is not valid in the authorization post request. ====
764 +
679 679  {{code language="http" title="**Response**"}}
680 680  HTTP/1.1 400 Error
681 681  Content-Type: application/problem+json