Changes for page account

Last modified by David Persson on 2024/02/21 07:42

From empty

To version 28.1

edited by David Persson
on 2022/03/15 17:01

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)
- Account.API diagram.jpeg

Details

Page properties

Title

...	...	@@ -1,0 +1,1 @@
	1	+../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,929 @@
++(% class="jumbotron" %)
++(((
++(% class="container" %)
++(((
++Integrate to **PayEx Account API **
++)))
++)))
++
++=== Changelog ===
++
++2021-10-26?
++Moved from the previous Credit Account API
++
++(% id="HRoutesegments" %)
++== Introduction ==
++
++(% class="lead" %)
++This api is used to retrieve information and to change properties related to the customer's account.
++
++[[image:Account.API diagram.jpeg||alt="Account.API.png"]]
++
++
++Each resource in the API corresponds to its own route. All routes are structured according to a specific standard, explained below
++
++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.
++//api.payex.com/ledger/**{Subdomain}**/v1/**{LedgerNumber}**/resource1/**{resource1Id}**/resource2/**{resource2Id}**/resource3/**{resource3Id}**//
++
++(% class="table-bordered table-striped" %)
++|=(% style="width: 604px;" %)Route segment|=(% style="width: 2790px;" %)Description
++|(% style="width:604px" %)Subdomain|(% style="width:2790px" %)In this part of the API it will be account
++|(% style="width:604px" %)LedgerNumber|(% style="width:2790px" %)The ledger identifier/number at PayEx
++|(% style="width:604px" %)resource1Id|(% style="width:2790px" %)Identifier of resource1
++|(% style="width:604px" %)resource2Id|(% style="width:2790px" %)identifier of resource2, subresource to resource1
++|(% style="width:604px" %)resource3Id|(% style="width:2790px" %)identifier of resource3, subresource to resource2
++
++(% class="wikigeneratedid" %)
++Routes that occurs in examples of this documentation will use the following identifiers
++
++(% class="table-bordered table-striped" %)
++|=(% style="width: 488px;" %)Resource|=(% style="width: 2271px;" %)Identifier
++|(% style="width:488px" %)LedgerNumber|(% style="width:2271px" %)XXX
++|(% style="width:488px" %)Accounts|(% style="width:2271px" %)NNN
++|(% style="width:488px" %)Bills|(% style="width:2271px" %)reminder-123
++bill-456
++|(% style="width:488px" %)Cards|(% style="width:2271px" %)954c8699-b38f-47a2-b568-668b8837dad8
++274c8699-b38f-47a2-b568-668b8837dat7
++
++== Accounts ==
++
++The **accounts** resource is located under **ledger/account/v1/ **api**. **The accounts- and its sub-resources are used to create, read and modify information related to a 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
++* Set behaviour of recurring payments
++
++==== Get a specific account ====
++
++====   ====
++
++{{code language="http" title="**Request**"}}
++GET /ledger/account/v1/XXX/accounts/NNN 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/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 | PendingClose | Closed",
++    "creditLimit": 2000.00,
++    "totalBalance" : -1900.0,
++    "reservedAmount": 50.0,
++    "availableAmount": 3850.0,
++    "maxPaymentAmount": 51900.0,
++    "openBill" : "/ledger/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/account/v1/XXX/accounts/NNN/active-payment-orders",
++    "recurringPaymentConfiguration": "/ledger/account/v1/XXX/accounts/NNN/recurring-payment-configuration",
++    "cards": "/ledger/account/v1/XXX/accounts/123456/cards",
++    "transactions": "/ledger/account/v1/XXX/accounts/NNN/transactions",
++    "currency": "sek",
++    "bills": "/ledger/account/v1/XXX/accounts/NNN/bills",
++    "customer": "/ledger/customers/v1/XXX/customer/123456",
++    "operation" : [
++        {
++            "rel" : "add-card-info",
++            "method" : "post",
++            "href" : "/ledger/account/v1/XXX/accounts/NNN/cards"
++        },
++        {
++            "rel" : "request-close-account",
++            "method" : "post",
++            "href" : "/ledger/account/v1/XXX/accounts/NNN/request-close-account"
++        },
++        {
++            "rel" : "apply-for-raised-credit-limit",
++            "method" : "post",
++            "href" : "/ledger/account-onboardings/v1/XXX/accounts/NNN/apply-for-raised-credit-limit"
++        },
++        {
++            "rel" : "partial-update",
++            "method" : "patch",
++            "href" : "/ledger/account-onboardings/v1/XXX/accounts/NNN"
++        }
++    ]
++}
++{{/code}}
++
++==== Change charitydonation ====
++
++{{code language="http" title="**Request**"}}
++PATCH /ledger/account/v1/XXX/accounts/NNN HTTP/1.1
++Host: -
++Authorization: Bearer <Token>
++Content-Type: application/json
++
++{
++    "charityDonation": false
++}
++{{/code}}
++
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 204 NO CONTENT
++Content-Type: application/json
++
++{{/code}}
++
++==== Lower the creditlimit ====
++
++The creditlimit can only be lowered through this patch API call. Increasing of the creditlimit requires signing and has not been implemented yet.
++
++{{code language="http" title="**Request**"}}
++PATCH /ledger/account/v1/XXX/accounts/NNN HTTP/1.1
++Host: -
++Authorization: Bearer <Token>
++Content-Type: application/json
++
++{
++    "creditLimit": 2000.00
++}
++{{/code}}
++
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 204 NO CONTENT
++Content-Type: application/json
++
++{{/code}}
++
++==== Account 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(((
++* **PendingClose**: 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. This value can only be 0 or positive.
++|(% 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.). This value can be either positive or negative. Negative means it is a surplus and positive means it is a debt.
++|(% 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). This value can only be positive.
++|(% 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). This value can only be positive.
++|(% style="width:215px" %)maxPaymentAmount|(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)The largest amount possible to deposit on the account at this moment.
++|(% style="width:215px" %)openBill|(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
++|(% 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" %)bankPayment|(% style="width:114px" %)object|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)Details on how to make a bank payment to the account
++|(% style="width:215px" %)   bankAccountNo|(% style="width:114px" %)string|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)Bank account number for payments against the current account
++|(% style="width:215px" %)   bankAccountType|(% style="width:114px" %)string|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)(((
++Type of bank account
++
++* BGSE
++* PGSE
++* BKNO
++)))
++|(% style="width:215px" %)   bic|(% style="width:114px" %)string|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)BIC/SWIFT (Business Identifier Code)
++|(% style="width:215px" %)   iban|(% style="width:114px" %)string|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)IBAN (International Bank Account Number)
++|(% style="width:215px" %)   paymentReference|(% style="width:114px" %)string|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)Payment reference of the current account
++|(% 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" %)
++
++----
++
++==== Register-psp-payment ====
++
++Method: POST
++Execution of this operation will result in an attempt to deposit the amount on the given account.
++
++(% class="box infomessage" %)
++(((
++Access to this operation is not normally granted, unless otherwise agreed.
++)))
++
++{{code language="http" title="**Request**"}}
++POST /ledger/account/v1/XXX/accounts/NNN/register-psp-payment HTTP/1.1
++Host: -
++Authorization: Bearer <Token>
++Content-Type: application/json
++
++{
++    "Amount": 2000.00,
++    "PaymentDate": "2021-01-01",
++    "sourcePspPaymentTransactionId": "123456789"
++}
++{{/code}}
++
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 204 NO CONTENT
++Content-Type: application/json
++
++{{/code}}
++
++===== Register-psp-payment resource properties =====
++
++(% class="table-bordered table-striped" %)
++|=(% style="width: 161px;" %)Property|=(% style="width: 121px;" %)Data type|=(% style="width: 195px;" %)Format|=(% style="width: 1309px;" %)Description
++|(% style="width:161px" %)Amount|(% style="width:121px" %)Decimal|(% style="width:195px" %) |(% style="width:1309px" %)Amount to deposit on account, max value is found on the account resource in the property "MaxPaymentAmount".
++|(% style="width:161px" %)PaymentDate|(% style="width:121px" %)Date|(% style="width:195px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:1309px" %)Date of the actual payment
++|(% style="width:161px" %)sourcePspPaymentTransactionId|(% style="width:121px" %)String|(% style="width:195px" %)Maxlength: 50|(% style="width:1309px" %)Unique identifier for the payment
++
++----
++
++== Bills ==
++
++The bills resources contains all the documents produced in the accounts billing cycle.
++
++
++==== List all bills of an account ====
++
++
++{{code language="http" title="**Request**"}}
++GET /ledger/account/v1/XXX/accounts/NNN/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/account/v1/501/accounts/NNN/bills?status=open",
++    "items" : [
++        {
++            "@id": "/ledger/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/account/v1/XXX/accounts/NNN/bills/reminder-124645/document"
++        },
++        {
++            "@id": "/ledger/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/account/v1/XXX/accounts/NNN/bills/reminder-124645/document"
++        },
++        {
++            "@id": "/ledger/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/account/v1/XXX/accounts/NNN/bills/reminder-124645/document"
++        }
++    ]
++}
++{{/code}}
++
++====   ====
++
++==== Get specific bill ====
++
++
++{{code language="http" title="**Request**"}}
++GET /ledger/account/v1/XXX/accounts/NNN/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/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/account/v1/XXX/accounts/NNN/bills/reminder-124645/document"
++}
++{{/code}}
++
++==== Bill resource properties ====
++
++(% 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
++
++== Cards ==
++
++==== Add card to account ====
++
++Execute http post towards this resource to add a new card to the specified account
++
++{{code language="http" title="**Request**"}}
++POST /ledger/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"
++        }
++    }
++}
++{{/code}}
++
++==== Add replacement card ====
++
++This operation is used to replace an existing card, and is therefore executed on the card to be replaced. The contract of the postbody is the same as POST towards the cards resource.
++
++{{code language="http" title="**Request**"}}
++POST /ledger/account/v1/XXX/accounts/NNN/cards/954c8699-b38f-47a2-b568-668b8837dad8/add-replacement-card 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"
++        }
++    }
++}
++{{/code}}
++
++==== List cards on an account ====
++
++{{code language="http" title="**Request**"}}
++GET /ledger/account/v1/XXX/accounts/NNN/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/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/account/v1/XXX/accounts/NNN/cards/274c8699-b38f-47a2-b568-668b8837dat7"
++        }
++    ],
++    "@id": "/ledger/account/v1/XXX/accounts/NNN/cards",
++    "view": {
++        "@id": "/ledger/account/v1/XXX/accounts/NNN/cards?$top=2&$skip=0",
++        "next": "/ledger/account/v1/XXX/accounts/NNN/cards?$top=2&$skip=2"
++    }
++}
++{{/code}}
++
++==== Get a specific card ====
++
++
++{{code language="http" title="**Request**"}}
++GET /ledger/account/v1/XXX/accounts/NNN/cards/954c8699-b38f-47a2-b568-668b8837dad8 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
++
++{
++    "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/account/v1/XXX/accounts/NNN/cards/954c8699-b38f-47a2-b568-668b8837dad8",
++    "parentHREF": "/ledger/account/v1/XXX/accounts/NNN",
++    "operation" : [
++        {
++            "rel" : "partial-update",
++            "method" : "patch",
++            "href" : "/ledger/account/v1/XXX/accounts/NNN/cards/954c8699-b38f-47a2-b568-668b8837dad8"
++        },
++        {
++            "rel": "add-replacement-card",
++            "href": "/ledger/account/v1/XXX/accounts/NNN/cards/5823a2d9-34d2-4bc4-8b6d-1e27f4511363/add-replacement-card",
++            "method": "POST"
++        }
++    ]
++}
++{{/code}}
++
++==== Card resource properties ====
++
++(% 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 ==
++
++==== List transactions on an account ====
++
++You can filter transactions by date in two different ways. Either filtering can be done by date range or by listing transactions by month.
++
++**Date range example**
++
++{{code language="http" title="**Request**"}}
++GET /ledger/account/v1/XXX/accounts/NNN/transactions?fromDate=2020-02-10&todate=2020-06-01 HTTP/1.1
++Host: -
++Authorization: Bearer <Token>
++Content-Type: application/json
++
++
++{{/code}}
++
++**Monthly example**
++
++{{code language="http" title="**Request**"}}
++GET /ledger/account/v1/XXX/accounts/NNN/transactions?month=2020-04 HTTP/1.1
++Host: -
++Authorization: Bearer <Token>
++Content-Type: application/json
++
++
++{{/code}}
++
++**Standard (default last 30 days) **
++
++{{code language="http" title="**Request**"}}
++GET /ledger/account/v1/XXX/accounts/NNN/transactions 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": [
++        {
++            "type": "payment",
++            "description": "",
++            "amount": 200.00,
++            "initiatedFromPointOfSale": false,
++            "date": "2019-10-09"
++        },
++        {
++            "type": "purchase",
++            "description": "testbutiken, köpref. 12345689",
++            "amount": 200.00,
++            "initiatedFromPointOfSale": true,
++            "date": "2019-10-09"
++        },
++        {
++            "type": "credit",
++            "description": "",
++            "amount": 200.00,
++            "initiatedFromPointOfSale": true,
++            "date": "2019-10-09"
++        }
++    ],
++    "@id": "/ledger/account/v1/XXX/accounts/NNN/transactions"
++}
++{{/code}}
++
++==== Transaction resource properties ====
++
++(% 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
++* AdministrationFee
++* BillingFee
++* CollectionFee
++* Deduction
++* Disbursement
++* DisbursementReturned
++* Interest
++* LateFee
++* ReminderFee
++* MigratedBalance// (Amount of the initially migrated balance on the account)//
++)))
++|(% 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" %)This value can be either positive or negative. Negative means decreasing debt or increasing surplus. Positive transactions increases debt or decreases surplus.
++|(% style="width:337px" %)initiatedFromPointOfSale|(% style="width:205px" %)bool|(% style="width:208px" %) |(% style="width:621px" %)Indicates whether the transaction was initiated from point of sale, or else it is a "ledger" transaction that was initiated internally in the ledgersystem.
++|(% style="width:337px" %)date|(% style="width:205px" %)date|(% style="width:208px" %) |(% style="width:621px" %)Date when the transaction was initiated (Authorization date)
++
++== Reservations ==
++
++==== List reservations in an account ====
++
++{{code language="http" title="**Request**"}}
++GET /ledger/account/v1/XXX/accounts/NNN/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/account/v1/XXX/accounts/NNN/reservations",
++}
++{{/code}}
++
++==== Reservation resource properties ====
++
++(% 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
++
++== Recurring-payment-configuration ==
++
++(% class="wikigeneratedid" %)
++This resource contain information/settings related to how recurring payments should behave on this account.
++
++====
++Get settings on an account ====
++
++
++{{code language="http" title="**Request**"}}
++GET /ledger/account/v1/XXX/accounts/NNN/recurring-payment-configuration/ 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/account/v1/XXX/accounts/NNN/recurring-payment-configurations",
++    "paymentMethod" : "autogiro",
++    "paymentScope" : "fixedRecurring",
++    "fixedAmount" : 1500.00,
++    "parentHREF": "/ledger/account/v1/XXX/accounts/NNN",
++    "operation" : [
++        {
++            "rel" : "partially-update-recurring-payment-consent",
++            "method" : "patch",
++            "href" : "/ledger/account/v1/XXX/accounts/NNN/recurring-payment-consent"
++        }
++    ]
++}
++{{/code}}
++
++==== Create settings on an account ====
++
++(% class="wikigeneratedid" %)
++Execute http **POST **towards this resource to create recurring payments configuration for specified account.
++
++{{code language="http" title="**Request**"}}
++POST /ledger/account/v1/XXX/accounts/NNN/recurring-payment-configuration HTTP/1.1
++Host: -
++Authorization: Bearer <Token>
++Content-Type: application/json
++
++{
++    "paymentMethod" : "autogiro",
++    "paymentScope" : "billedAmount",
++    "fixedAmount" : 0.00
++}
++{{/code}}
++
++====
++Update settings on an account ====
++
++(% class="wikigeneratedid" %)
++Execute http **PATCH** towards this resource to update the recurring payment configuration
++
++{{code language="http" title="**Request**"}}
++PATCH /ledger/account/v1/XXX/accounts/NNN/recurring-payment-configuration HTTP/1.1
++Host: -
++Authorization: Bearer <Token>
++Content-Type: application/json
++
++{
++    "paymentScope" : "billedAmount",
++    "fixedAmount" : 0.00
++}
++{{/code}}
++
++==== Delete settings on an account ====
++
++(% class="wikigeneratedid" %)
++Execute http **DELETE **to delete the recurring payment settings for the specified account. By deleting the settings, the account will not use the consent registered on the customer for recurring payments.
++
++{{code language="http" title="**Request**"}}
++DELETE /ledger/account/v1/XXX/accounts/NNN/recurring-payment-configuration HTTP/1.1
++Host: -
++Authorization: Bearer <Token>
++Content-Type: application/json
++
++{}
++{{/code}}
++
++==== Recurring-payment-configuration resource properties ====
++
++(% 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" %)paymentMethod|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="background-color:palegreen; width:58px" %) |(% style="width:1176px" %)paymentMethods:(((
++* autogiro
++)))
++|(% style="width:337px" %)paymentScope|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="background-color:palegreen; width:58px" %) |(% style="width:1176px" %)(((
++paymentScopes:
++
++* fixedRecurring (Fixed amount to debit monthly)
++* totalDebt (Total account debt / used credit will be debited each month)
++* billedAmount (Only the //"minimum amount to pay"// will be debited each month)
++)))
++|(% style="width:337px" %)fixedAmount|(% 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")
++
++== Active-payment-orders ==
++
++(% class="wikigeneratedid" %)
++This resource corresponds to an active / scheduled payment order placed against the specific account, the end-customer will be debited at the given executeDate.
++
++====
++Get active payment orders for an account ====
++
++
++{{code language="http" title="**Request**"}}
++GET /ledger/account/v1/XXX/accounts/NNN/active-payment-orders/ 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": [
++        {
++            "paymentMethod": "autogiro",
++            "executeDate": "2020-02-15",
++            "amount": 200.00
++        }
++    ],
++    "view": {
++        "@id": "/ledger/account/v1/XXX/accounts/NNN/active-payment-orders?$top=2&$skip=0",
++        "next": "/ledger/account/v1/XXX/accounts/NNN/active-payment-orders?$top=2&$skip=2"
++    }
++}
++{{/code}}
++
++====   ====
++
++==== Active-payment-orders resource properties ====
++
++(% 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" %)paymentMethod|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:58px" %) |(% style="width:1176px" %)paymentMethods:(((
++* autogiro
++)))
++|(% style="width:337px" %)executeDate|(% style="width:205px" %)Date|(% style="width:208px" %) |(% style="width:58px" %) |(% style="width:1176px" %)(((
++The date when the payment order will be executed
++)))
++|(% style="width:337px" %)amount|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:58px" %) |(% style="width:1176px" %)The amount to debit the owner of the consent
++
++===   ===
++
++== Problems ==
++
++All errors from the api are returned in the form of "problems" (response body), except for the http status code itself.
++The problem object contain more detailed info on what the error is. The "type" property can be used to programmatically interpret the error as it contains a code definition of the problem.
++Other properties can be useful for logging and subsequent troubleshooting. Some problems are extended with additional parameters so it may be a good idea to log response body as raw data to include these.
++
++Problems of type validation does contain an additional list ("Problems") that describes exactly which parameter that failed the validation
++
++=== Example ===
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 400 Error
++Content-Type: application/problem+json
++
++{
++   "Type" : "ledger.account.validation",
++   "Title" : "A validation error occurred",
++   "Status" : 400,
++   "Instance" : "215d4206-ca35-4f43-85ad-169c8f6d4ec1",
++   "Detail" : "A validation error occurred. Please fix the problems mentioned in the 'problems' property below.",
++   "Problems" : [
++      {
++         "amount" : "Expected value between [0,01]-[79228162514264337593543950335] actual [0]"
++      }
++   ]
++}
++{{/code}}
++
++=== Problem types ===
++
++(% class="box infomessage" %)
++(((
++Note, each problem typecode is preceded by "ledger.account." in this API, e.g. the error "validation" in the table below will appear as typecode "ledger.account.validation".
++)))
++
++(% class="table-bordered table-striped" %)
++|=(% style="width: 537px;" %)Problem type (code)|=(% style="width: 172px;" %)Httpstatus|=(% style="width: 796px;" %)Description
++|(% style="width:537px" %)validation|(% style="width:172px" %)400|(% style="width:796px" %)occurs if any of the inputvalidation fails, it is described in the problem which parameter that failed the validation
++|(% style="width:537px" %)customer-does-not-exists|(% style="width:172px" %)404|(% style="width:796px" %)can occur if customernumber is part of the querystring towards account resource
++|(% style="width:537px" %)card-not-found|(% style="width:172px" %)404|(% style="width:796px" %)
++|(% style="width:537px" %)duplicate-card-token|(% style="width:172px" %)409|(% style="width:796px" %)
++|(% style="width:537px" %)card-update-failed|(% style="width:172px" %)422|(% style="width:796px" %)
++|(% style="width:537px" %)account-not-found|(% style="width:172px" %)404|(% style="width:796px" %)
++|(% style="width:537px" %)invalid-reg-no|(% style="width:172px" %)400|(% style="width:796px" %)

Account.API diagram.jpeg

Author

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

Size

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

Content