Changes for page ../credit-account

Last modified by David Persson on 2022/08/11 10:52

From empty

To version 65.1

edited by David Persson
on 2020/01/16 23:14

Change comment: There is no comment for this version

Summary

Page properties (6 modified, 0 added, 0 removed)
Attachments (0 modified, 1 added, 0 removed)
- 1578554263550-159.png

Details

Page properties

Title

...	...	@@ -1,0 +1,1 @@
	1	+../credit-account

Parent

...	...	@@ -1,0 +1,1 @@
	1	+Main.credit-account.api.WebHome

Author

@@ -1,1
          +1,1 @@
--XWiki.XWikiGuest
++xwiki:XWiki.dap

Default language

...	...	@@ -1,0 +1,1 @@
	1	+en

Tags

...	...	@@ -1,0 +1,1 @@
	1	+px-custom-page-content

Content

@@ -1,0
          +1,615 @@
++(% class="jumbotron" %)
++(((
++(% class="container" %)
++(((
++Integrate to **PayEx Credit Account API **
++)))
++)))
++
++(% class="box errormessage" %)
++(((
++Todo: Saknar operation för att hitta konton som tillhör en person/ett personnummer
++)))
++
++
++== Accounts ==
++
++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.
++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.
++
++The following operations is supported
++
++* Change the account credit limit
++* Add extra cards
++* Request cancellation of account
++* Turn on/off charity donation
++
++=== Requesting details of a specific account ===
++
++
++{{code language="http" title="**Request**"}}
++GET /ledger/credit-account/v1/XXX/accounts/YYY HTTP/1.1
++Host: -
++Authorization: Bearer <Token>
++Content-Type: application/json
++{{/code}}
++
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++    "@id": "/ledger/credit-account/v1/501/accounts/1234567",
++    "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/501/accounts/123456/bills/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/501/accounts/123456/active-payment-orders",
++    "recurringPaymentConsent": "/ledger/credit-account/v1/501/accounts/123456/recurring-payment",
++    "cards": "/ledger/credit-account/v1/501/accounts/123456/cards",
++    "transactions": "/ledger/credit-account/v1/501/accounts/123456/transactions",
++    "currency": "sek",
++    "bills": "/ledger/credit-account/v1/501/accounts/123456/bills",
++    "customer": "/ledger/customers/v1/501/customer/123456",
++    "operation" : [
++        {
++            "rel" : "add-card-info",
++            "method" : "post",
++            "href" : "/ledger/credit-account/v1/501/accounts/123456/cards"
++        },
++        {
++            "rel" : "request-close-account",
++            "method" : "post",
++            "href" : "/ledger/credit-account/v1/501/accounts/123456/request-close-account"
++        },
++        {
++            "rel" : "apply-for-raised-credit-limit",
++            "method" : "post",
++            "href" : "/ledger/credit-account-onboardings/v1/501/accounts/123456/apply-for-raised-credit-limit"
++        },
++        {
++            "rel" : "partial-update",
++            "method" : "patch",
++            "href" : "/ledger/credit-account-onboardings/v1/501/accounts/123456"
++        }
++    ]
++}
++{{/code}}
++
++**Resource properties**
++
++(% class="table-bordered table-striped" %)
++|=(% style="width: 215px;" %)Property|=(% style="width: 114px;" %)Data type|=(% style="width: 161px;" %)Format|=(% style="width: 61px;" %)Modify (patch)|=(% style="width: 877px;" %)Description
++|(% style="width:215px" %)@id |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: |(% style="width:61px" %) |(% style="width:877px" %)Uri of the specific account
++|(% style="width:215px" %)accountNo |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 50|(% style="width:61px" %) |(% style="width:877px" %)The identifier of the account
++|(% style="width:215px" %)startDate |(% style="width:114px" %)date|(% style="width:161px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:61px" %) |(% style="width:877px" %)Date when the account was started
++|(% style="width:215px" %)description |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 200|(% style="width:61px" %) |(% style="width:877px" %)A description of the type of account
++|(% style="width:215px" %)accountProfileType |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 50|(% style="width:61px" %) |(% style="width:877px" %)The defined code of the accounttype, //Examples: kontodebet, kontokredit, kontofaktura//
++|(% style="width:215px" %)accountAlias |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 50|(% style="width:61px" %) |(% style="width:877px" %)A descriptive name for the account type, //Examples: kontokredit1, matkonto1//
++|(% style="width:215px" %)customerNo |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 50|(% style="width:61px" %) |(% style="width:877px" %)Identifier of the customer (account owner)
++|(% style="width:215px" %)status |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 25|(% style="width:61px" %) |(% style="width:877px" %)Status of the account(((
++* **pending-close**: the customer has requested the account to be closed, the account will be closed when possible.
++* **open**: the account is open and active
++* **closed**: the account has been closed
++)))
++|(% style="width:215px" %)creditLimit |(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="background-color:palegreen; width:61px" %) |(% style="width:877px" %)The creditlimit of the account, support patch operation but only lower
++|(% style="width:215px" %)totalBalance|(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)Total current sum of all balances (including capital / interest / fees, etc.)
++|(% style="width:215px" %)reservedAmount |(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)Sum of all outstanding reservations (which are valid and not captured)
++|(% style="width:215px" %)availableAmount |(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)Available credit (cannot be calculated from the above amounts as fees can be included there, which does not affect available credit)
++|(% style="width:215px" %)openBill.amountToPay |(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)The minimum amount to pay on the currently open bill
++|(% style="width:215px" %)openBill.bill |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
++|(% style="width:215px" %)openBill.dueDate |(% style="width:114px" %)date|(% style="width:161px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:61px" %) |(% style="width:877px" %)
++|(% style="width:215px" %)openBill.billType |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 25|(% style="width:61px" %) |(% style="width:877px" %)(((
++BillTypes:
++
++* Bill
++* Reminder1
++* Reminder2
++* Collection
++)))
++|(% style="width:215px" %)charityDonation |(% style="width:114px" %)bool|(% style="width:161px" %) |(% style="background-color:palegreen; width:61px" %) |(% style="width:877px" %)If donations should be made from the account
++|(% style="width:215px" %)interestRate.debtInterest|(% style="width:114px" %)decimal|(% style="width:161px" %)Percentage|(% style="width:61px" %) |(% style="width:877px" %)yearly debt interestrate
++|(% style="width:215px" %)interestRate.penaltyInterest|(% style="width:114px" %)decimal|(% style="width:161px" %)Percentage|(% style="width:61px" %) |(% style="width:877px" %)yearly penalty interestrate
++|(% style="width:215px" %)offer |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
++|(% style="width:215px" %)recurringPaymentConsent|(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
++|(% style="width:215px" %)cards |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
++|(% style="width:215px" %)transactions |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
++|(% style="width:215px" %)currency |(% style="width:114px" %)string|(% style="width:161px" %)[[ISO 4217>>https://sv.wikipedia.org/wiki/ISO_4217]]|(% style="width:61px" %) |(% style="width:877px" %)
++|(% style="width:215px" %)bills |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
++|(% style="width:215px" %)customer |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
++|(% style="width:337px" %)activePaymentOrder.paymentMethod|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 15|(% style="width:61px" %)(((
++
++)))|(% style="width:877px" %)(((
++PaymentTypes:
++
++* AUTOGIRO
++)))
++|(% style="width:337px" %)activePaymentOrder.executionDate|(% style="width:205px" %)date|(% style="width:208px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:61px" %) |(% style="width:877px" %)Date when the paymentorder will be executed (when end-customer will be debited)
++|(% style="width:337px" %)activePaymentOrder.amount|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:61px" %) |(% style="width:877px" %)Amount that will be charged, this amount may be adjusted when the payment order is executed, if the "amount to pay" on the bill has decreased
++|(% style="width:215px" %) |(% style="width:114px" %) |(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)
++
++=== Bills ===
++
++The bills resources contains all the documents produced in the accounts billing cycle.
++
++
++==== Requesting list of bills belonging to a specific account ====
++
++
++{{code language="http" title="**Request**"}}
++GET /ledger/credit-account/v1/XXX/accounts/123/bills HTTP/1.1
++Host: -
++Authorization: Bearer <Token>
++Content-Type: application/json
++
++{{/code}}
++
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++    "@id": "/ledger/credit-account/v1/501/accounts/123456/bills?status=open",
++    "items" : [
++        {
++            "@id": "/ledger/credit-account/v1/501/accounts/123456/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/501/accounts/123456/bills/reminder-124645/document"
++        },
++        {
++            "@id": "/ledger/credit-account/v1/501/accounts/123456/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/501/accounts/123456/bills/reminder-124645/document"
++        },
++        {
++            "@id": "/ledger/credit-account/v1/501/accounts/123456/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/501/accounts/123456/bills/reminder-124645/document"
++        }
++    ]
++}
++{{/code}}
++
++====   ====
++
++==== Requesting details of a specific bill ====
++
++
++{{code language="http" title="**Request**"}}
++GET /ledger/credit-account/v1/XXX/accounts/123/bills/456 HTTP/1.1
++Host: -
++Authorization: Bearer <Token>
++Content-Type: application/json
++
++{{/code}}
++
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++    "@id": "/ledger/credit-account/v1/501/accounts/123456/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/501/accounts/123456/bills/reminder-124645/document"
++}
++{{/code}}
++
++==   ==
++
++(% class="table-bordered table-striped" %)
++|=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 621px;" %)Description
++|(% style="width:337px" %)@id|(% style="width:205px" %)string|(% style="width:208px" %)Uri|(% style="width:621px" %)
++|(% style="width:337px" %)dueDate|(% style="width:205px" %)date|(% style="width:208px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:621px" %)
++|(% style="width:337px" %)billDate|(% style="width:205px" %)date|(% style="width:208px" %) |(% style="width:621px" %)Date when bill was created
++|(% style="width:337px" %)billNo|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 50|(% style="width:621px" %)The identifier of the bill
++|(% style="width:337px" %)billAmount|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:621px" %)the amount that is stated on the actual bill/document
++|(% style="width:337px" %)billType|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 25|(% style="width:621px" %)(((
++BillTypes:
++
++* Bill
++* Reminder1
++* Reminder2
++* Collection
++)))
++|(% style="width:337px" %)status|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:621px" %)"open" / "closed"
++|(% style="width:337px" %)activePaymentDetails|(% style="width:205px" %)object|(% style="width:208px" %) |(% style="width:621px" %)only set if status of bill is "open"
++|(% style="width:337px" %)activePaymentDetails.minimumAmountToBePayed|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:621px" %)The least amount to pay on the bill
++|(% style="width:337px" %)activePaymentDetails.bankAccountNo|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 15|(% style="width:621px" %)bankaccount for payment
++|(% style="width:337px" %)activePaymentDetails.bankAccountType|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 10|(% style="width:621px" %)BankAccountTypes:(((
++* BKSE (swedish bankaccount)
++* PKSE (swedish plusgiro)
++* BGSE (swedish bankgiro)
++* PGSE (swedish plusgiro OCR)
++)))
++|(% style="width:337px" %)activePaymentDetails.bic|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 11|(% style="width:621px" %)Bank Identifier Code (BIC)
++|(% style="width:337px" %)activePaymentDetails.iban|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 34|(% style="width:621px" %)International Bank Account Number (IBAN)
++|(% style="width:337px" %)activePaymentDetails.paymentReference|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 50|(% style="width:621px" %)reference to specify on the payment
++|(% style="width:337px" %)activePaymentDetails.paymentOrdersExists|(% style="width:205px" %)bool|(% style="width:208px" %) |(% style="width:621px" %)if there is an active payment order to be executed related to this bill for "recurring payments".
++//More detailed information about the payment order can be found on the accounts resource//
++|(% style="width:337px" %)document|(% style="width:205px" %)string|(% style="width:208px" %)Url|(% style="width:621px" %)Url to download pdf document
++
++===   ===
++
++=== recurring-payment-consent ===
++
++This resource contain information/settings related to how recurring payments should behave on this account.
++
++
++{{code language="http" title="**Request**"}}
++POST /ledger/credit-account/v1/XXX/accounts/123/recurring-payment-consent HTTP/1.1
++Host: -
++Authorization: Bearer <Token>
++Content-Type: application/json
++{{/code}}
++
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++    "@id" : "/ledger/credit-account/v1/501/accounts/123456/recurring-payment-consent",
++    "recurringPaymentMethod" : "autogiro",
++    "recurringPaymentScope" : "fixedRecurring | totalDebt | billedAmount | onDemand",
++    "fixedRecurringAmount" : 1500.00,
++    "parentHREF": "/ledger/credit-account/v1/501/accounts/123456"
++}
++
++{{/code}}
++
++
++(% class="table-bordered table-striped" %)
++|=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 58px;" %)Modify (patch)|=(% style="width: 1176px;" %)Description
++|(% style="width:337px" %)recurringPaymentMethod|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="background-color:palegreen; width:58px" %) |(% style="width:1176px" %)recurringPaymentMethods:(((
++* autogiro
++)))
++|(% style="width:337px" %)recurringPaymentScope|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="background-color:palegreen; width:58px" %) |(% style="width:1176px" %)(((
++recurringPaymentScopes:
++
++* fixedRecurring (Fixed amount to debit monthly)
++* totalDebt (Total credit-account debt will be debited)
++* billedAmount (Only the minimum amount to pay will be debited)
++)))
++|(% 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")
++
++=== Cards ===
++
++List cards
++
++{{code language="http" title="**Request**"}}
++POST /ledger/credit-account/v1/XXX/accounts/123/cards HTTP/1.1
++Host: -
++Authorization: Bearer <Token>
++Content-Type: application/json
++
++
++{{/code}}
++
++
++{{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/501/accounts/123456/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/501/accounts/123456/cards/742"
++        }
++    ],
++    "@id": "/ledger/credit-account/v1/501/accounts/123456/cards",
++    "view": {
++        "@id": "/ledger/credit-account/v1/501/accounts/123456/cards?$top=2&$skip=0",
++        "next": "/ledger/credit-account/v1/501/accounts/123456/cards?$top=2&$skip=2"
++    }
++}
++{{/code}}
++
++{{code language="http" title="**Request**"}}
++POST /ledger/credit-account/v1/XXX/accounts/123/cards/456 HTTP/1.1
++Host: -
++Authorization: Bearer <Token>
++Content-Type: application/json
++
++
++{{/code}}
++
++==== Get ====
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 201 Created
++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/501/accounts/123456/cards/741",
++    "parentHREF": "/ledger/credit-account/v1/501/accounts/123456",
++    "operation" : [
++        {
++            "rel" : "partial-update",
++            "method" : "patch",
++            "href" : "/ledger/credit-account/v1/501/accounts/123456/cards/741"
++        }
++    ]
++}
++{{/code}}
++
++(% class="table-bordered table-striped" %)
++|=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 62px;" %)Modify (patch)|=(% style="width: 1401px;" %)Description
++|(% style="width:337px" %)token|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:62px" %) |(% style="width:1401px" %)token identifier of the card
++|(% style="width:337px" %)panTrunc|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:62px" %) |(% style="width:1401px" %)truncated PAN
++|(% style="width:337px" %)deleted|(% style="width:205px" %)bool|(% style="width:208px" %) |(% style="background-color:palegreen; width:62px" %) |(% style="width:1401px" %)indicates wheter the card has been deleted
++|(% style="width:337px" %)mainCard|(% style="width:205px" %)bool|(% style="width:208px" %) |(% style="width:62px" %) |(% style="width:1401px" %)indicated whether this card is the main card of the account (cardholder is always owner of account)
++|(% style="width:337px" %)cardHolder.number|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:62px" %) |(% style="width:1401px" %)Cardholder customernumber
++|(% style="width:337px" %)cardHolder.name|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:62px" %) |(% style="width:1401px" %)Cardholder fullname
++|(% style="width:337px" %)cardHolder.nationalConsumerIdentifier.value|(% style="width:205px" %)string|(% style="width:208px" %)YYYYMMDD-NNNC|(% style="width:62px" %) |(% style="width:1401px" %)
++|(% style="width:337px" %)cardHolder.nationalConsumerIdentifier.countryCode|(% style="width:205px" %)string|(% style="width:208px" %)[[ISO 3166-1 alpha-2>>url:https://sv.wikipedia.org/wiki/ISO_3166]]|(% style="width:62px" %) |(% style="width:1401px" %)
++
++=== Transactions ===
++
++
++{{code language="http" title="**Request**"}}
++POST /ledger/credit-account/v1/XXX/accounts/123/transactions HTTP/1.1
++Host: -
++Authorization: Bearer <Token>
++Content-Type: application/json
++
++
++{{/code}}
++
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 201 Created
++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/501/accounts/123456/transactions?fromDate=2019-10-01",
++    "view": {
++        "@id": "/ledger/credit-account/v1/501/accounts/123456/transactions?fromDate=2019-10-01&$top=2&$skip=0",
++        "next": "/ledger/credit-account/v1/501/accounts/123456/transactions?fromDate=2019-10-01&$top=2&$skip=2"
++    }
++}
++{{/code}}
++
++(% class="table-bordered table-striped" %)
++|=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 621px;" %)Description
++|(% style="width:337px" %)type|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:621px" %)(((
++Type of transaction
++
++* Payment
++* Purchase
++* Credit
++)))
++|(% style="width:337px" %)description|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:621px" %)Description of the transaction, for purchases it usually includes "point of sale" and "receipt reference"
++|(% style="width:337px" %)amount|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:621px" %)
++|(% style="width:337px" %)billed|(% style="width:205px" %)bool|(% style="width:208px" %) |(% style="width:621px" %)Indicates wheter a bill has been created after the transaction (ie. if the transaction is included in any bill or not)
++|(% style="width:337px" %)date|(% style="width:205px" %)date|(% style="width:208px" %) |(% style="width:621px" %)//Valuedate//
++
++=== Reservations ===
++
++
++{{code language="http" title="**Request**"}}
++POST /ledger/credit-account/v1/XXX/accounts/123/reservations HTTP/1.1
++Host: -
++Authorization: Bearer <Token>
++Content-Type: application/json
++
++
++{{/code}}
++
++
++{{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/501/accounts/123456/reservations",
++}
++{{/code}}
++
++(% class="table-bordered table-striped" %)
++|=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 621px;" %)Description
++|(% style="width:337px" %)amount|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:621px" %)
++|(% style="width:337px" %)description|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:621px" %)Description of the reservation, normally "point of sale".
++|(% style="width:337px" %)date|(% style="width:205px" %)date|(% style="width:208px" %) |(% style="width:621px" %)Date when the reservation occured
++
++Problems
++
++If an error occur or any validation failed, a "problem" response will be returned.
++Below is a list of problems that can occur:
++
++**HttpStatus 401 Unauthorized**
++
++* Token expired
++* Token invalid
++* SellerNumber does not match token
++* CompanyNumber does not match token
++
++**HttpStatus 400 Error**
++
++* Validation: Argument required
++* Validation: Invalid value
++
++**HttpStatus 422 Unprocessable entity**
++
++* Authorization declined
++
++**HttpStatus 409 Conflict**
++
++* Invoice already authorized
++* Duplicate InvoiceNumber
++* Authorization is cancelled
++* Authorization already captured
++* Authorization has expired
++* Insufficient debited amount XXX
++
++**HttpStatus 501 NotImplemented**
++
++* CompanyNumber XXX not configured
++* SellerNumber XXX not configured at PayEx
++* CompanyNumber XXX missing configuration
++
++**HttpStatus 404 NotFound**
++
++* Authorization not found
++
++Below is an example of a problem that will be returned if buyer##.nationalConsumerIdentifier.value## is not valid in the authorization post request.
++
++{{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"
++        }
++    ]
++}
++{{/code}}

1578554263550-159.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+xwiki:XWiki.dap

Size

...	...	@@ -1,0 +1,1 @@
	1	+0 bytes

Content