Changes for page 2. Customer

Last modified by Jenny Eklund on 2026/08/19 11:28

From empty

To version 248.1

edited by Jenny Eklund
on 2026/08/19 11:28

Change comment: There is no comment for this version

Summary

Page properties (6 modified, 0 added, 0 removed)
Attachments (0 modified, 11 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,0 +1,1 @@
	1	+2. Customer

Parent

...	...	@@ -1,0 +1,1 @@
	1	+Main.WebHome

Author

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

Default language

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

Tags

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

Content

@@ -1,0
          +1,1466 @@
++(% class="jumbotron" %)
++(((
++(% class="container" %)
++(((
++Integrate to **PayEx Customer API **
++)))
++)))
++
++== Introduction ==
++
++(% class="lead" %)
++This api is used to create/read customers or change properties related to the customer.
++
++[[image:image260819.png||alt="CustomerApiImage"]]
++
++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 resource2Id, to operate on this resource you must also include the ids of its parentresources in the route.
++//lf-api.payex.com/ledger/**{Subdomain}**/v1/**{LedgerNumber}**/resource1/**{resource1Id}**/resource2/**{resource2Id}**//
++
++(% 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 **customer**
++|(% 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
++
++(% 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" %)Customer|(% style="width:2271px" %)NNN (CustomerNo)
++
++= Swagger =
++
++[[Swagger.json-2026-08-19>>attach:Swagger_Releases-502848.txt]]
++
++== Changelog ==
++
++2023-01-17
++Added //surpluses// property to the Customer resource with planned release 2024-01-23
++
++2023-11-27
++Added new resource Surpluses & added a general 404 not-found to problems list.
++
++2024-04-26
++
++Added TaxIdentificationNumber to the Customer resource with planned release 2024-05-28
++
++2024-05-15
++
++Added Consent and underlying resources with planned release 2024-05-28. Updated Introduction API overview visual.
++
++2025-02-14
++
++Added operation Update-Kyc-Answers and updates to the Customer resource Operations list to reflect that. Planned release 2025-03-04
++
++Added resource Kyc-Questions. Planned release 2025-03-04
++
++2026-01-27
++Added new possible value for to ActiveConsents - PharmaciesSE
++
++2026-07-08
++Added new secontion for Trusted Seller Group Consents
++
++2026-08-19
++Added resource Affordability-Questions. Planned release 2026-09-22
++
++
++== 1. Customers ==
++
++
++Get a customer from ledger using customer number as identifier
++
++==== 1.1 Get specific Customer ====
++
++{{code language="http" title="**Request**"}}
++GET /ledger/customer/v1/{ownerNo}/customers/{customerNo} HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{{/code}}
++
++Get customer
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++  "customerNo": "YYY",
++  "nationalIdentifier": {
++    "regNo": "YYYYMMDD-NNNN",
++    "countryCode": "SE"
++  },
++  "vatNo": "SE101010101001",
++  "legalEntity": "consumer",
++  "name": "Test Testsson",
++  "emailAddress": "Test@test.se",
++  "protectedIdentity": false,
++  "preferredLanguageCode": "SV",
++  "legalStatus": "active",
++  "msisdn": "+467040000000",
++  "activeConsents": [
++    "Betalingsservice",
++    "Avtalegiro",
++    "RecurringCard"
++  ],
++  "ediAddressInfo": {
++    "van": "ABCXYZ",
++    "interChangeRecipient": "Recipient_ID1",
++    "buyerId": "123465"
++  },
++  "surpluses": "/ledger/customer/v1/xxx/customers/yyy/surpluses",
++  "legalAddress": "/ledger/customer/v1/xxx/customers/yyy/legal-address",
++  "billingAddress": "/ledger/customer/v1/xxx/customers/yyy/billing-address",
++  "consent": "/ledger/customer/v1/xxx/customers/yyy/consent",
++  "operations": [
++    {
++      "rel": "partial-update-customer",
++      "method": "PATCH",
++      "href": "/ledger/customer/v1/xxx/customers/yyy"
++    },
++    {
++      "rel": "add-billing-address",
++      "method": "POST",
++      "href": "/ledger/customer/v1/xxx/customers/yyy/billing-address"
++    },
++    {
++      "rel": "update-kyc-answers",
++      "method": "POST",
++      "href": "/ledger/customer/v1/xxx/customers/yyy/update-kyc-answers"
++    }
++  ],
++  "taxIdentificationNumber": "1234567890"
++}
++{{/code}}
++
++
++
++**Possible problems**
++
++(% class="table-bordered table-striped" %)
++|=Http status |=Problem type |=Description
++|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.
++|500 |handled-exception |The requested resource '' could not be processed. Please contact support.
++|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.
++|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.
++|400 |validation |Validation error when accessing resource . Please refer to the problems property for additional details.
++|404 |customer-does-not-exists |The requested resource '' was not found.
++|404 |customer-not-found |The requested resource '' was not found.
++
++==== 1.2 Create Customer ====
++
++Create a new customer in ledger
++
++{{code language="http" title="**Request**"}}
++POST /ledger/customer/v1/{ownerNo}/customers HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++
++{{/code}}
++
++
++**Request object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Required|=Description
++|customerNo |string | |No |
++|=ediAddressInfo |object |  |No |
++|   van |string | |No |
++|   interChangeRecipient |string | |No |
++|   buyerId |string | |No |
++|emailAddress |string | |No |
++|=legalAddress |object |  |No |
++|   addressee |string | |No |
++|   streetAddress |string | |No |
++|   zipCode |string | |No |
++|   city |string | |No |
++|   coAddress |string | |No |
++|   countryCode |string | |No |
++|=billingAddress |object |  |No |
++|legalEntity |string | |No |
++|msisdn |string | |No |
++|name |string | |No |
++|=nationalIdentifier |object |  |No |
++|   regNo |string | |Yes |
++|   countryCode |string |Pattern: ^[A-Z]{2}$ |Yes |
++|protectedIdentity |boolean | |Yes |
++|preferredLanguageCode |string | |No |
++|vatNo |string | |No |
++|distributionType |string | |No |
++|taxIdentificationNumber |string | |No |
++
++Create a customer response
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 201 Created
++Content-Type: application/json
++
++{
++  "customerNo": "YYY",
++  "@id": "/ledger/customer/v1/xxx/customers/yyy"
++}
++{{/code}}
++
++
++**Possible problems**
++
++(% class="table-bordered table-striped" %)
++|=Http status |=Problem type |=Description
++|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.
++|500 |handled-exception |The requested resource '' could not be processed. Please contact support.
++|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.
++|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.
++|400 |validation |Validation error when accessing resource . Please refer to the problems property for additional details.
++|400 |invalid-reg-no |Validation error when accessing resource . Please refer to the problems property for additional details.
++|400 |invalid-phone-no |Validation error when accessing resource . Please refer to the problems property for additional details.
++|422 |customer-already-exists |The requested resource '' could not be processed. Customer Already Exists
++
++
++**Response object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Description
++|@id |string | |Uri identifier of the current resource
++|customerNo |string | |
++|=nationalIdentifier |object |  |
++|   regNo |string | |
++|   countryCode |string |Pattern: ^[A-Z]{2}$ |
++|vatNo |string | |
++|legalEntity |string | |
++|name |string | |
++|emailAddress |string | |
++|protectedIdentity |boolean | |
++|preferredLanguageCode |string | |
++|legalStatus |string | |
++|msisdn |string | |
++|=activeConsents |array |  |
++|    |string | |
++|=ediAddressInfo |object |  |
++|   van |string | |
++|   interChangeRecipient |string | |
++|   buyerId |string | |
++|surpluses |dynamic |  |
++|legalAddress |dynamic |  |
++|billingAddress |dynamic |  |
++|consent |dynamic |  |
++|distributionType |string | |
++|operations |array | |List of operations that is possible to perform on the current resource, read more about the ~[~[hypermedia part of the response>>https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/ledger-api-general-docs/restful-pattern-guideline/#HHyper-mediaresponse]]
++|taxIdentificationNumber |string | |
++
++== 2. Active-disbursement-orders ==
++
++
++list active surpluse disbursement orders pending disbursement batch is run.
++
++==== 2.1 Get list of Active-disbursement-orders ====
++
++{{code language="http" title="**Request**"}}
++GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/surpluses/{surplusId}/active-disbursement-orders HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{{/code}}
++
++Get customer billing-address
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++  "items": [
++    {
++      "operations": [],
++      "swedishBankAccount": {
++        "accountNo": "1234567890",
++        "accountType": "BGSE"
++      }
++    }
++  ],
++  "navigation": {
++    "@id": "/ledger/customer/v1/xxx/customers/yyy/surpluses/zzz/active-disbursement-orders"
++  }
++}
++{{/code}}
++
++
++
++**Possible problems**
++
++(% class="table-bordered table-striped" %)
++|=Http status |=Problem type |=Description
++|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.
++|500 |handled-exception |The requested resource '' could not be processed. Please contact support.
++|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.
++|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.
++|400 |validation |Validation error when accessing resource . Please refer to the problems property for additional details.
++|404 |customer-does-not-exists |The requested resource '' was not found.
++|404 |customer-not-found |The requested resource '' was not found.
++
++==== 2.2 Create Active-disbursement-order ====
++
++Add a disbursement order. Disburses all available funds on surplus account, when disbursement batch is run
++
++{{code language="http" title="**Request**"}}
++POST /ledger/customer/v1/{ownerNo}/customers/{customerNo}/surpluses/{surplusId}/active-disbursement-orders HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{
++  "swedishBankAccount": {
++    "accountNo": "NNN",
++    "accountType": "BGSE | PGSE | BKSE | PKSE"
++  }
++}
++{{/code}}
++
++
++**Request object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Required|=Description
++|activeDisbursementOrdersId |string | |No |
++|=norwegianBankAccount |object |  |No |
++|   accountNo |string | |Yes |
++|=swedishBankAccount |object |  |No |
++|   accountNo |string | |Yes |
++|   accountType |string | |Yes |
++|=international |object |  |No |
++|   iban |string | |Yes |
++|   bic |string | |Yes |
++|=swedishSus |object |  |No |
++|=   nationalIdentifier |object |  |No |
++|      regNo |string | |No |
++|      countryCode |string | |No |
++|=   address |object |  |No |
++|      addressee |string | |No |
++|      streetAddress |string | |No |
++|      city |string | |No |
++|      zipCode |string | |No |
++|      countryCode |string | |No |
++|      coAddress |string | |No |
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 201 CREATED
++Content-Type: application/json
++
++{
++}
++{{/code}}
++
++
++**Response object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Description
++|=items |array |  |
++|   @id |string | |Uri identifier of the current resource
++|   activeDisbursementOrdersId |string | |
++|   operations |array | |List of operations that is possible to perform on the current resource, read more about the ~[~[hypermedia part of the response>>https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/ledger-api-general-docs/restful-pattern-guideline/#HHyper-mediaresponse]]
++|=   norwegianBankAccount |object |  |
++|      accountNo |string | |
++|=   swedishBankAccount |object |  |
++|      accountNo |string | |
++|      accountType |string | |
++|=   international |object |  |
++|      iban |string | |
++|      bic |string | |
++|=   swedishSus |object |  |
++|=      nationalIdentifier |object |  |
++|         regNo |string | |
++|         countryCode |string | |
++|=      address |object |  |
++|         addressee |string | |
++|         streetAddress |string | |
++|         city |string | |
++|         zipCode |string | |
++|         countryCode |string | |
++|         coAddress |string | |
++|=navigation |object |  |
++|   @id |string |Type: uri |The current result view.
++|   first |string |Type: uri |Link to the first results.
++|   previous |string |Type: uri |Link to the previous results.
++|   next |string |Type: uri |Link to the next results.
++
++== 3. Surpluses ==
++
++
++List all available surpluses on the customer
++
++==== 3.1 Get list of Surpluses ====
++
++{{code language="http" title="**Request**"}}
++GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/surpluses HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{{/code}}
++
++Get surpluses list
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++  "items": [
++    {
++      "surplusId": "123",
++      "balance": 10,
++      "currency": "SEK",
++      "date": "2026-08-16T00:00:00+02:00",
++      "status": "open",
++      "invoice": "/ledger/invoice/v1/XXX/invoices/AAA",
++      "activeDisbursementOrders": "/ledger/customer/v1/xxx/customers/yyy/surpluses/123/active-disbursement-orders",
++      "operations": [
++        {
++          "rel": "active-disbursement-orders",
++          "method": "POST",
++          "href": "/ledger/customer/v1/xxx/customers/yyy/surpluses/123/active-disbursement-orders"
++        }
++      ],
++      "@id": "/ledger/customer/v1/xxx/customers/yyy/surpluses/123"
++    },
++    {
++      "surplusId": "456",
++      "balance": 20,
++      "currency": "SEK",
++      "date": "2026-08-14T00:00:00+02:00",
++      "status": "pending-disbursement",
++      "account": "/ledger/account/v1/XXX/accounts/BBB",
++      "activeDisbursementOrders": "/ledger/customer/v1/xxx/customers/yyy/surpluses/456/active-disbursement-orders",
++      "operations": [
++        {
++          "rel": "active-disbursement-orders",
++          "method": "POST",
++          "href": "/ledger/customer/v1/xxx/customers/yyy/surpluses/456/active-disbursement-orders"
++        }
++      ],
++      "@id": "/ledger/customer/v1/xxx/customers/yyy/surpluses/456"
++    },
++    {
++      "surplusId": "789",
++      "balance": 30,
++      "currency": "SEK",
++      "date": "2026-08-07T00:00:00+02:00",
++      "status": "pending-regulate",
++      "invoice": "/ledger/invoice/v1/XXX/invoices/AAA",
++      "activeDisbursementOrders": "/ledger/customer/v1/xxx/customers/yyy/surpluses/789/active-disbursement-orders",
++      "operations": [
++        {
++          "rel": "active-disbursement-orders",
++          "method": "POST",
++          "href": "/ledger/customer/v1/xxx/customers/yyy/surpluses/789/active-disbursement-orders"
++        }
++      ],
++      "@id": "/ledger/customer/v1/xxx/customers/yyy/surpluses/789"
++    }
++  ],
++  "navigation": {
++    "@id": "/ledger/customer/v1/xxx/customers/yyy/surpluses"
++  }
++}
++{{/code}}
++
++
++A surplus is the remaining value from a payment that was greater than the current debt, also referred as an 'overpayment'. Each instance of an overpayment will create a new surplus. A surplus will often have a connection to an account or invoice based of where the payment was placed but surpluses without connection to an account or invoice also exist. Surpluses can be used to settle upcoming debt or be disbursed.
++
++==== 3.2 Get specific Surpluse ====
++
++{{code language="http" title="**Request**"}}
++GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/surpluses/{surplusId} HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{{/code}}
++
++Get single surplus
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++  "surplusId": "YYY",
++  "balance": 10,
++  "currency": "SEK",
++  "date": "2026-08-16T00:00:00+02:00",
++  "status": "open",
++  "invoice": "/ledger/invoice/v1/XXX/invoices/AAA",
++  "account": "/ledger/account/v1/XXX/accounts/BBB",
++  "activeDisbursementOrders": "/ledger/customer/v1/xxx/customers/yyy/surpluses/yyy/active-disbursement-orders",
++  "operations": [
++    {
++      "rel": "active-disbursement-orders",
++      "method": "POST",
++      "href": "/ledger/customer/v1/xxx/customers/yyy/surpluses/yyy/active-disbursement-orders"
++    }
++  ],
++  "@id": "/ledger/customer/v1/XXX/customers/AAA/surpluses/YYY"
++}
++{{/code}}
++
++
++
++**Response object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Description
++|@id |string | |Uri identifier of the current resource
++|surplusId |string | |
++|balance |number |Type: double |
++|currency |string | |
++|date |string |Type: date-time |
++|status |string | |
++|invoice |string | |
++|account |string | |
++|activeDisbursementOrders |dynamic |  |
++|operations |array | |List of operations that is possible to perform on the current resource, read more about the ~[~[hypermedia part of the response>>https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/ledger-api-general-docs/restful-pattern-guideline/#HHyper-mediaresponse]]
++
++== 4. Trusted-seller-groups ==
++
++
++Get details about the customer's active Consent.
++
++==== 4.1 Get list of Trusted-seller-groups ====
++
++{{code language="http" title="**Request**"}}
++GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/consent/trusted-seller-groups HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{{/code}}
++
++Get consent list
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++  "items": [
++    {
++      "consentType": "ccccc1",
++      "operations": [
++        {
++          "rel": "delete-trusted-seller-group",
++          "method": "DELETE",
++          "href": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups/ccccc1"
++        }
++      ],
++      "@id": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups/ccccc1"
++    },
++    {
++      "consentType": "ccccc2",
++      "operations": [
++        {
++          "rel": "delete-trusted-seller-group",
++          "method": "DELETE",
++          "href": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups/ccccc2"
++        }
++      ],
++      "@id": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups/ccccc2"
++    }
++  ],
++  "navigation": {
++    "@id": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups"
++  }
++}
++{{/code}}
++
++
++
++**Possible problems**
++
++(% class="table-bordered table-striped" %)
++|=Http status |=Problem type |=Description
++|400 |validation |Occurs if the validation of the request fails, it is described in the problem why the input is invalid.
++|404 |not-found |Occurs if the requested resource is not found.
++|409 |conflict |Occurs if the requested resource already exists.
++|500 |fatal |Unexpected error, logs may give details about the problem
++
++Get details about the customer's active Consent.
++
++==== 4.2 Get specific Trusted-seller-group ====
++
++{{code language="http" title="**Request**"}}
++GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/consent/trusted-seller-groups/{consentType} HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{{/code}}
++
++Get single consent
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++  "consentType": "ccccc",
++  "operations": [
++    {
++      "rel": "delete-trusted-seller-group",
++      "method": "DELETE",
++      "href": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups/ccccc"
++    }
++  ]
++}
++{{/code}}
++
++
++
++**Possible problems**
++
++(% class="table-bordered table-striped" %)
++|=Http status |=Problem type |=Description
++|400 |validation |Occurs if the validation of the request fails, it is described in the problem why the input is invalid.
++|404 |not-found |Occurs if the requested resource is not found.
++|409 |conflict |Occurs if the requested resource already exists.
++|500 |fatal |Unexpected error, logs may give details about the problem
++
++==== 4.3 Create Trusted-seller-group ====
++
++Save a pdf Consent document as a Base64 string for specific CustomerNo and ConsentType.
++
++{{code language="http" title="**Request**"}}
++POST /ledger/customer/v1/{ownerNo}/customers/{customerNo}/consent/trusted-seller-groups HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{
++  "consentType": "PharmaciesSE",
++  "applicationDocument": {
++    "content": "JVBERi0xLjQKJ...",
++    "fileType": "pdf"
++  }
++}
++{{/code}}
++
++
++**Request object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Required|=Description
++|consentType |string | |Yes |Name of the Consent Type
++|=applicationDocument |object |  |Yes |
++|   content |string | |Yes |A base64 encoded string representing the content of the document.
++|   fileType |string |Pattern: (?i)^(pdf~|txt~|json~|xml)$ |Yes |The file type of the document. Supported file types are: pdf, txt, json and xml. The validation is case insensitive.
++
++Save a consent document
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++  "consentType": "cccc",
++  "operations": [
++    {
++      "rel": "delete-trusted-seller-group",
++      "method": "DELETE",
++      "href": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups/cccc"
++    }
++  ],
++  "@id": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups/cccc"
++}
++{{/code}}
++
++
++**Possible problems**
++
++(% class="table-bordered table-striped" %)
++|=Http status |=Problem type |=Description
++|400 |validation |Occurs if the validation of the request fails, it is described in the problem why the input is invalid.
++|404 |not-found |Occurs if the requested resource is not found.
++|409 |conflict |Occurs if the requested resource already exists.
++|500 |fatal |Unexpected error, logs may give details about the problem
++
++
++**Response object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Description
++|@id |string | |Uri identifier of the current resource
++|consentType |string | |
++|operations |array | |List of operations that is possible to perform on the current resource, read more about the ~[~[hypermedia part of the response>>https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/ledger-api-general-docs/restful-pattern-guideline/#HHyper-mediaresponse]]
++
++== 5. Legal-address ==
++
++
++The legal address is where claims is normally sent to. It is required for a customer to have a legal address registered
++
++==== 5.1 Get list of Legal-address ====
++
++{{code language="http" title="**Request**"}}
++GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/legal-address HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{{/code}}
++
++Get customer legal-address
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++  "addressee": "Test Testsson",
++  "streetAddress": "Test street 1",
++  "zipCode": "60000",
++  "city": "Test town",
++  "coAddress": "Co address",
++  "countryCode": "SE",
++  "operations": [
++    {
++      "rel": "update-legal-address",
++      "method": "PUT",
++      "href": "/ledger/customer/v1/xxx/customers/yyy/legal-address"
++    },
++    {
++      "rel": "update-legal-address-from-population-register",
++      "method": "POST",
++      "href": "/ledger/customer/v1/xxx/customers/yyy/legal-address/update-legal-address-from-population-register"
++    }
++  ]
++}
++{{/code}}
++
++
++
++**Possible problems**
++
++(% class="table-bordered table-striped" %)
++|=Http status |=Problem type |=Description
++|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.
++|500 |handled-exception |The requested resource '' could not be processed. Please contact support.
++|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.
++|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.
++|400 |validation |Validation error when accessing resource . Please refer to the problems property for additional details.
++|404 |customer-does-not-exists |The requested resource '' was not found.
++|404 |customer-not-found |The requested resource '' was not found.
++
++
++**Response object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Description
++|@id |string | |Uri identifier of the current resource
++|addressee |string | |
++|streetAddress |string | |
++|zipCode |string | |
++|city |string | |
++|coAddress |string | |
++|countryCode |string | |
++|operations |array | |List of operations that is possible to perform on the current resource, read more about the ~[~[hypermedia part of the response>>https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/ledger-api-general-docs/restful-pattern-guideline/#HHyper-mediaresponse]]
++
++== 6. Update-kyc-answers ==
++
++
++==== 6.1 Create Update-kyc-answer ====
++
++When exposed on customer resources operations list it's a indication previous KYC answers up for renewal. Able to update KYC with this operation even if current aren't expired but won't be suggested on the customer resource
++
++{{code language="http" title="**Request**"}}
++POST /ledger/customer/v1/{ownerNo}/customers/{customerNo}/update-kyc-answers HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{
++  "answers": [
++    {
++      "questionCode": "taxable_outside_sweden",
++      "answerCode": "no"
++    },
++    {
++      "questionCode": "multiple_citizenship",
++      "answerCode": "yes"
++    },
++    {
++      "questionCode": "citizen_ship_country_codes",
++      "answerCode": "SWE"
++    },
++    {
++      "questionCode": "citizen_ship_country_codes",
++      "answerCode": "NOR"
++    }
++  ]
++}
++{{/code}}
++
++
++**Request object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Required|=Description
++|=answers |array |  |Yes |
++|   questionCode |string | |Yes |The code definition of the question
++|   answerCode |string | |Yes |The code definition of the answer
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 201 CREATED
++Content-Type: application/json
++
++{
++}
++{{/code}}
++
++
++**Possible problems**
++
++(% class="table-bordered table-striped" %)
++|=Http status |=Problem type |=Description
++|400 |validation |Occurs if the validation of the request fails, it is described in the problem why the input is invalid.
++|404 |not-found |Occurs if the customer not found or if KYC is not configured on this ledger.
++|409 |company-kyc-questions-not-configured |Occurs if ledger is not currently configured for KYC
++|500 |fatal |Unexpected error, logs may give details about the problem
++
++== 7. Update-legal-address-from-population-register ==
++
++
++==== 7.1 Create Update-legal-address-from-population-register ====
++
++Execution of this operation will result in an attempt to retrieve (and replace) the customer's legal address from the population registry.
++
++{{code language="http" title="**Request**"}}
++POST /ledger/customer/v1/{ownerNo}/customers/{customerNo}/legal-address/update-legal-address-from-population-register HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{
++}
++{{/code}}
++
++
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 204 NO CONTENT
++Content-Type: application/json
++
++{}
++{{/code}}
++
++
++**Possible problems**
++
++(% class="table-bordered table-striped" %)
++|=Http status |=Problem type |=Description
++|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.
++|500 |handled-exception |The requested resource '' could not be processed. Please contact support.
++|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.
++|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.
++|400 |validation |Validation error when accessing resource . Please refer to the problems property for additional details.
++|404 |customer-does-not-exists |The requested resource '' was not found.
++|404 |customer-not-found |The requested resource '' was not found.
++
++== 8. Billing-address ==
++
++
++The billing address is where invoices/bills/letters etc. is normally sent to. This address is optional
++
++==== 8.1 Get list of Billing-address ====
++
++{{code language="http" title="**Request**"}}
++GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/billing-address HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{{/code}}
++
++Get customer billing-address
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++  "addressee": "Test Testsson",
++  "streetAddress": "Test street 1",
++  "zipCode": "60000",
++  "city": "Test town",
++  "coAddress": "Co address",
++  "countryCode": "SE",
++  "operations": [
++    {
++      "rel": "update-billing-address",
++      "method": "PUT",
++      "href": "/ledger/customer/v1/xxx/customers/yyy/billing-address"
++    },
++    {
++      "rel": "delete-billing-address",
++      "method": "DELETE",
++      "href": "/ledger/customer/v1/xxx/customers/yyy/billing-address"
++    }
++  ]
++}
++{{/code}}
++
++
++
++**Possible problems**
++
++(% class="table-bordered table-striped" %)
++|=Http status |=Problem type |=Description
++|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.
++|500 |handled-exception |The requested resource '' could not be processed. Please contact support.
++|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.
++|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.
++|400 |validation |Validation error when accessing resource . Please refer to the problems property for additional details.
++|404 |customer-does-not-exists |The requested resource '' was not found.
++|404 |customer-not-found |The requested resource '' was not found.
++
++==== 8.2 Create Billing-addre ====
++
++Add a billing address to customer. The billing address is where invoices/bills/letters etc. is normally sent to. This address is optional
++
++{{code language="http" title="**Request**"}}
++POST /ledger/customer/v1/{ownerNo}/customers/{customerNo}/billing-address HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{
++  "addressee": "Test Testsson",
++  "streetAddress": "Test street 1",
++  "zipCode": "60000",
++  "city": "Test town",
++  "coAddress": "Co address",
++  "countryCode": "SE"
++}
++{{/code}}
++
++
++**Request object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Required|=Description
++|addressee |string | |No |
++|streetAddress |string | |No |
++|zipCode |string | |No |
++|city |string | |No |
++|coAddress |string | |No |
++|countryCode |string | |No |
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 201 CREATED
++Content-Type: application/json
++
++{
++}
++{{/code}}
++
++
++**Possible problems**
++
++(% class="table-bordered table-striped" %)
++|=Http status |=Problem type |=Description
++|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.
++|500 |handled-exception |The requested resource '' could not be processed. Please contact support.
++|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.
++|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.
++|400 |validation |Validation error when accessing resource . Please refer to the problems property for additional details.
++|404 |customer-does-not-exists |The requested resource '' was not found.
++|404 |customer-not-found |The requested resource '' was not found.
++
++
++**Response object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Description
++|@id |string | |Uri identifier of the current resource
++|addressee |string | |
++|streetAddress |string | |
++|zipCode |string | |
++|city |string | |
++|coAddress |string | |
++|countryCode |string | |
++|operations |array | |List of operations that is possible to perform on the current resource, read more about the ~[~[hypermedia part of the response>>https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/ledger-api-general-docs/restful-pattern-guideline/#HHyper-mediaresponse]]
++
++== 9. Consent ==
++
++
++Underlying resources that display information or enable registration of a customer's consent.
++
++==== 9.1 Get list of Consent ====
++
++{{code language="http" title="**Request**"}}
++GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/consent HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{{/code}}
++
++Get customer consent
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++  "recurringCard": "/ledger/customer/v1/xxx/customers/yyy/consent/recurring-card",
++  "recurringCardRedirectRegistration": "/ledger/customer/v1/xxx/customers/yyy/consent/recurring-card-redirect-registration",
++  "trustedSellerGroups": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups",
++  "availableTrustedSellerGroupConsents": [],
++  "operations": [
++    {
++      "rel": "add-trusted-seller-group",
++      "method": "POST",
++      "href": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups"
++    },
++    {
++      "rel": "add-recurring-card-redirect-registration",
++      "method": "POST",
++      "href": "/ledger/customer/v1/xxx/customers/yyy/consent/recurring-card-redirect-registration"
++    }
++  ]
++}
++{{/code}}
++
++
++
++**Response object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Description
++|@id |string | |Uri identifier of the current resource
++|recurringCard |dynamic |  |
++|recurringCardRedirectRegistration |dynamic |  |
++|trustedSellerGroups |dynamic |  |
++|=availableTrustedSellerGroupConsents |array |  |
++|    |string | |
++|operations |array | |List of operations that is possible to perform on the current resource, read more about the ~[~[hypermedia part of the response>>https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/ledger-api-general-docs/restful-pattern-guideline/#HHyper-mediaresponse]]
++
++== 10. Find-customer ==
++
++
++==== 10.1 Create Find-customer ====
++
++ It is used to find customer with nationalIdentifier.
++
++{{code language="http" title="**Request**"}}
++POST /ledger/customer/v1/{ownerNo}/find-customer HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{
++  "nationalIdentifier": {
++    "regNo": "YYYYMMDD-NNNN",
++    "countryCode": "SE"
++  }
++}
++{{/code}}
++
++
++**Request object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Required|=Description
++|=nationalIdentifier |object |  |No |
++|   regNo |string | |Yes |
++|   countryCode |string | |No |
++
++Find customer with nationalIdentifier, regno and countrycode, returns CustomerNo = YYY
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++  "customerNo": "YYY"
++}
++{{/code}}
++
++
++**Possible problems**
++
++(% class="table-bordered table-striped" %)
++|=Http status |=Problem type |=Description
++|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.
++|500 |handled-exception |The requested resource '' could not be processed. Please contact support.
++|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.
++|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.
++|400 |validation |Validation error when accessing resource . Please refer to the problems property for additional details.
++|400 |invalid-reg-no |Validation error when accessing resource . Please refer to the problems property for additional details.
++|404 |customer-does-not-exists |The requested resource '' was not found.
++|404 |customer-not-found |The requested resource '' was not found.
++
++
++**Response object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Description
++|@id |string | |Uri identifier of the current resource
++|customerNo |string | |
++
++== 11. Recurring-card ==
++
++
++Get details about the customer's active Recurring Card Consent.
++
++==== 11.1 Get list of Recurring-card ====
++
++{{code language="http" title="**Request**"}}
++GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/consent/recurring-card HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{{/code}}
++
++Get customer active Recurring Card Consent.
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++  "cardToken": "2eb28854-07ec-4e88-b672-7c61cc54b461",
++  "consentExpiryDate": "04-2035",
++  "instrumentDisplayName": "551000******1232",
++  "cardExpiryDate": "04/2035",
++  "cardBrand": "Visa",
++  "operations": [
++    {
++      "rel": "delete-recurring-card",
++      "method": "DELETE",
++      "href": "/ledger/customer/v1/xxx/customers/yyy/consent/recurring-card"
++    }
++  ]
++}
++{{/code}}
++
++
++
++**Response object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Description
++|@id |string | |Uri identifier of the current resource
++|cardToken |string | |
++|consentExpiryDate |string | |
++|instrumentDisplayName |string | |
++|cardExpiryDate |string | |
++|cardBrand |string | |
++|operations |array | |List of operations that is possible to perform on the current resource, read more about the ~[~[hypermedia part of the response>>https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/ledger-api-general-docs/restful-pattern-guideline/#HHyper-mediaresponse]]
++
++== 12. Recurring-card-redirect-registration ==
++
++
++Get details about the customer's ongoing Recurring Card registration.
++
++==== 12.1 Get list of Recurring-card-redirect-registration ====
++
++{{code language="http" title="**Request**"}}
++GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/consent/recurring-card-redirect-registration HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{{/code}}
++
++Customer's ongoing Recurring Card Registration.
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++  "redirectUrl": "https://ecom.externalintegration.payex.com/checkout/abc123",
++  "status": "Initialized",
++  "operations": []
++}
++{{/code}}
++
++
++==== 12.2 Create Recurring-card-redirect-registration ====
++
++Initializes the customer's Recurring Card registration with redirect to SwedbankPay.
++
++{{code language="http" title="**Request**"}}
++POST /ledger/customer/v1/{ownerNo}/customers/{customerNo}/consent/recurring-card-redirect-registration HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{
++  "completeUrl": "https://www.google.com/search?q=cancelurl",
++  "cancelUrl": "https://www.google.com/search?q=completeurl",
++  "language": "en-US"
++}
++{{/code}}
++
++
++**Request object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Required|=Description
++|completeUrl |string |Type: uri |Yes |
++|cancelUrl |string |Type: uri |Yes |
++|language |string | |Yes |
++
++Customer's ongoing Recurring Card Registration.
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++  "redirectUrl": "https://ecom.externalintegration.payex.com/checkout/abc123",
++  "status": "Initialized",
++  "operations": [],
++  "@id": "/ledger/customer/v1/xxx/customers/yyy/consent/recurring-card-redirect-registration"
++}
++{{/code}}
++
++
++**Response object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Description
++|@id |string | |Uri identifier of the current resource
++|redirectUrl |string | |
++|status |string | |
++|operations |array | |List of operations that is possible to perform on the current resource, read more about the ~[~[hypermedia part of the response>>https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/ledger-api-general-docs/restful-pattern-guideline/#HHyper-mediaresponse]]
++
++== 13. Kyc-questions ==
++
++
++Get KYC questions from ledger using company number as identifier
++
++==== 13.1 Get list of Kyc-questions ====
++
++{{code language="http" title="**Request**"}}
++GET /ledger/customer/v1/{ownerNo}/kyc-questions?language={language} HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{{/code}}
++
++Get CompanyInstance KYC questions if configured or a 404 company-kyc-questions-not-configured response if not
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++  "kycQuestions": [
++    {
++      "questionText": "What is your current employment?",
++      "answer": {
++        "type": "single",
++        "required": true,
++        "possibleAnswers": [
++          {
++            "answerCode": "selfemployed",
++            "answerText": "Own business"
++          },
++          {
++            "answerCode": "private_employee",
++            "answerText": "Private employee"
++          },
++          {
++            "answerCode": "goverment_employee",
++            "answerText": "Government employee"
++          }
++        ]
++      },
++      "questionCode": "employment"
++    },
++    {
++      "questionText": "What is your yearly income",
++      "answer": {
++        "type": "single",
++        "required": true,
++        "possibleAnswers": [
++          {
++            "answerCode": "incomeinterval1",
++            "answerText": "0-100 000 SEK"
++          },
++          {
++            "answerCode": "incomeinterval2",
++            "answerText": "100 001-200 000 SEK"
++          },
++          {
++            "answerCode": "incomeinterval3",
++            "answerText": "200 001-300 000 SEK"
++          },
++          {
++            "answerCode": "incomeinterval4",
++            "answerText": "Over 300 001 SEK"
++          }
++        ]
++      },
++      "questionCode": "income"
++    }
++  ],
++  "operations": []
++}
++{{/code}}
++
++
++
++**Query parameters**
++
++(% class="table-bordered table-striped" %)
++|=Name |=Required |=Description
++|language |False |format ISO639-1, if not supported or none given request defaults to language code 'en'(English)
++
++
++**Possible problems**
++
++(% class="table-bordered table-striped" %)
++|=Http status |=Problem type |=Description
++|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.
++|500 |handled-exception |The requested resource '' could not be processed. Please contact support.
++|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.
++|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.
++|404 |company-kyc-questions-not-configured |The requested resource '' was not found.
++
++
++**Response object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Description
++|@id |string | |Uri identifier of the current resource
++|=kycQuestions |array |  |
++|   questionCode |string | |The code definition of the question
++|   questionText |string | |The translated text of the question
++|=   answer |object |  |
++|      type |string | |The type of the expected answer: single ~| multi ~| text
++|      required |boolean | |If the answer is required
++|      textValidationRegEx |string | |The regex the answer should match
++|=      possibleAnswers |array |  |
++|         answerCode |string | |The code definition of the answer
++|         answerText |string | |The translated text of the answer
++|=         subQuestions |array |  |
++|operations |array | |List of operations that is possible to perform on the current resource, read more about the ~[~[hypermedia part of the response>>https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/ledger-api-general-docs/restful-pattern-guideline/#HHyper-mediaresponse]]
++
++== 14. Affordability-questions ==
++
++
++Get affordability questions from ledger using company number as identifier
++
++==== 14.1 Get list of Affordability-questions ====
++
++{{code language="http" title="**Request**"}}
++GET /ledger/customer/v1/{ownerNo}/affordability-questions?language={language} HTTP/1.1
++Host: -
++Authorization: Bearer<Token>
++Content-Type: application/json
++
++{{/code}}
++
++Get CompanyInstance affordability questions if configured. It's expected that not all credit assessment levels are configured for every company.
++
++{{code language="http" title="**Response**"}}
++HTTP/1.1 200 OK
++Content-Type: application/json
++
++{
++  "creditAssessmentLevel1": [
++    {
++      "questionCode": "yearly_revenue",
++      "questionText": "What is your yearly revenue?",
++      "answer": {
++        "type": "single",
++        "required": true,
++        "possibleAnswers": [
++          {
++            "answerCode": "interval1",
++            "answerText": "0-500 000 SEK"
++          },
++          {
++            "answerCode": "interval2",
++            "answerText": "500 001-1 000 000 SEK"
++          }
++        ]
++      }
++    }
++  ],
++  "creditAssessmentLevel2": [
++    {
++      "questionCode": "number_of_employees",
++      "questionText": "How many employees does the company have?",
++      "answer": {
++        "type": "single",
++        "required": true,
++        "possibleAnswers": [
++          {
++            "answerCode": "interval1",
++            "answerText": "1-10"
++          },
++          {
++            "answerCode": "interval2",
++            "answerText": "11-50"
++          }
++        ]
++      }
++    }
++  ],
++  "operations": []
++}
++{{/code}}
++
++
++
++**Query parameters**
++
++(% class="table-bordered table-striped" %)
++|=Name |=Required |=Description
++|language |False |format ISO639-1, if not supported or none given request defaults to language code 'en'(English)
++
++
++**Possible problems**
++
++(% class="table-bordered table-striped" %)
++|=Http status |=Problem type |=Description
++|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.
++|500 |handled-exception |The requested resource '' could not be processed. Please contact support.
++|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.
++|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.
++
++
++**Response object specification**
++
++(% class="table-bordered table-striped" %)
++|=Property |=Data type|=Format|=Description
++|@id |string | |Uri identifier of the current resource
++|=creditAssessmentLevel1 |array |  |
++|   questionCode |string | |The code definition of the question
++|   questionText |string | |The translated text of the question
++|=   answer |object |  |
++|      type |string | |The type of the expected answer: single ~| multi ~| text
++|      required |boolean | |If the answer is required
++|      textValidationRegEx |string | |The regex the answer should match
++|=      possibleAnswers |array |  |
++|         answerCode |string | |The code definition of the answer
++|         answerText |string | |The translated text of the answer
++|=         subQuestions |array |  |
++|=creditAssessmentLevel2 |array |  |
++|=creditAssessmentLevel3 |array |  |
++|operations |array | |List of operations that is possible to perform on the current resource, read more about the ~[~[hypermedia part of the response>>https://developer.payex.com/xwiki/wiki/developer/view/Main/Invoicing/ledger-api-general-docs/restful-pattern-guideline/#HHyper-mediaresponse]]
++
++{{display reference="developer:Main.Invoicing.ledger-api-general-docs.api-section-problems.WebHome"/}}

Screenshot 2026-07-08 141842.png

Author

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

Size

...	...	@@ -1,0 +1,1 @@
	1	+76.0 KB

Content

1612164530151-211.png

Author

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

Size

...	...	@@ -1,0 +1,1 @@
	1	+8.3 KB

Content

image260819.png

Author

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

Size

...	...	@@ -1,0 +1,1 @@
	1	+69.3 KB

Content

customerapi-2025-02.PNG

Author

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

Size

...	...	@@ -1,0 +1,1 @@
	1	+76.7 KB

Content

1661344288319-663.png

Author

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

Size

...	...	@@ -1,0 +1,1 @@
	1	+111.1 KB

Content

Swagger_Releases-502848.txt

Author

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

Size

...	...	@@ -1,0 +1,1 @@
	1	+144.4 KB

Content

PayEx - Ledger API's - Customer Wiki Visual(1).png

Author

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

Size

...	...	@@ -1,0 +1,1 @@
	1	+16.8 KB

Content

Swagger_Releases-499976(3).txt

Author

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

Size

...	...	@@ -1,0 +1,1 @@
	1	+135.5 KB

Content

1612164561442-820.png

Author

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

Size

...	...	@@ -1,0 +1,1 @@
	1	+12.9 KB

Content

PayEx - Ledger API's - customer.png

Author

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

Size

...	...	@@ -1,0 +1,1 @@
	1	+78.8 KB

Content

PayEx - Ledger API's - Customer Wiki Visual.png

Author

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

Size

...	...	@@ -1,0 +1,1 @@
	1	+156.4 KB

Content