PayEx Developer Portal

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.

19

//lf-api.payex.com/ledger/**{Subdomain}**/v1/**{LedgerNumber}**/resource1/**{resource1Id}**/resource2/**{resource2Id}**//

20

21

(% class="table-bordered table-striped" %)

22

|=(% style="width: 604px;" %)Route segment|=(% style="width: 2790px;" %)Description

23

|(% style="width:604px" %)Subdomain|(% style="width:2790px" %)In this part of the API it will be **customer**

24

|(% style="width:604px" %)LedgerNumber|(% style="width:2790px" %)The ledger identifier/number at PayEx

25

|(% style="width:604px" %)resource1Id|(% style="width:2790px" %)Identifier of resource1

26

|(% style="width:604px" %)resource2Id|(% style="width:2790px" %)identifier of resource2, subresource to resource1

27

28

(% class="wikigeneratedid" %)

29

Routes that occurs in examples of this documentation will use the following identifiers

30

31

(% class="table-bordered table-striped" %)

32

|=(% style="width: 488px;" %)Resource|=(% style="width: 2271px;" %)Identifier

33

|(% style="width:488px" %)LedgerNumber|(% style="width:2271px" %)XXX

34

|(% 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

44

45

2023-11-27

46

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

59

60

Added resource Kyc-Questions. Planned release 2025-03-04

61

62

2026-01-27

63

Added new possible value for to ActiveConsents - PharmaciesSE

64

65

2026-07-08

66

Added new secontion for Trusted Seller Group Consents

67

68

2026-08-19

69

Added resource Affordability-Questions. Planned release 2026-09-22

== 1. Customers ==

Get a customer from ledger using customer number as identifier

76

77

==== 1.1 Get specific Customer ====

78

79

80

GET /ledger/customer/v1/{ownerNo}/customers/{customerNo} HTTP/1.1

81

Host: -

82

Authorization: Bearer<Token>

83

Content-Type: application/json

Get customer

HTTP/1.1 200 OK

Content-Type: application/json

{

"customerNo": "YYY",

"nationalIdentifier": {

96

"regNo": "YYYYMMDD-NNNN",

97

"countryCode": "SE"

98

},

99

"vatNo": "SE101010101001",

100

"legalEntity": "consumer",

101

"name": "Test Testsson",

102

"emailAddress": "Test@test.se",

103

"protectedIdentity": false,

104

"preferredLanguageCode": "SV",

105

"legalStatus": "active",

106

"msisdn": "+467040000000",

"activeConsents": [

"Betalingsservice",

"Avtalegiro",

"RecurringCard"

],

"ediAddressInfo": {

"van": "ABCXYZ",

"interChangeRecipient": "Recipient_ID1",

115

"buyerId": "123465"

116

},

117

"surpluses": "/ledger/customer/v1/xxx/customers/yyy/surpluses",

118

"legalAddress": "/ledger/customer/v1/xxx/customers/yyy/legal-address",

119

"billingAddress": "/ledger/customer/v1/xxx/customers/yyy/billing-address",

120

"consent": "/ledger/customer/v1/xxx/customers/yyy/consent",

121

"operations": [

122

{

123

"rel": "partial-update-customer",

124

"method": "PATCH",

125

"href": "/ledger/customer/v1/xxx/customers/yyy"

126

},

127

{

128

"rel": "add-billing-address",

129

"method": "POST",

130

"href": "/ledger/customer/v1/xxx/customers/yyy/billing-address"

131

},

132

{

133

"rel": "update-kyc-answers",

134

"method": "POST",

135

"href": "/ledger/customer/v1/xxx/customers/yyy/update-kyc-answers"

136

}

137

],

138

"taxIdentificationNumber": "1234567890"

}

**Possible problems**

145

146

(% class="table-bordered table-striped" %)

147

|=Http status |=Problem type |=Description

148

|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.

149

|500 |handled-exception |The requested resource '' could not be processed. Please contact support.

150

|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.

151

|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.

152

|400 |validation |Validation error when accessing resource . Please refer to the problems property for additional details.

153

|404 |customer-does-not-exists |The requested resource '' was not found.

154

|404 |customer-not-found |The requested resource '' was not found.

155

156

==== 1.2 Create Customer ====

157

158

Create a new customer in ledger

159

160

161

POST /ledger/customer/v1/{ownerNo}/customers HTTP/1.1

162

Host: -

163

Authorization: Bearer<Token>

164

Content-Type: application/json

**Request object specification**

171

172

(% class="table-bordered table-striped" %)

| van |string | |No |

| countryCode |string |Pattern: ^[A-Z]{2}$ |Yes |

Create a customer response

HTTP/1.1 201 Created

Content-Type: application/json

{

"customerNo": "YYY",

"@id": "/ledger/customer/v1/xxx/customers/yyy"

}

**Possible problems**

214

215

(% class="table-bordered table-striped" %)

216

|=Http status |=Problem type |=Description

217

|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.

218

|500 |handled-exception |The requested resource '' could not be processed. Please contact support.

219

|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.

220

|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.

221

|400 |validation |Validation error when accessing resource . Please refer to the problems property for additional details.

222

|400 |invalid-reg-no |Validation error when accessing resource . Please refer to the problems property for additional details.

223

|400 |invalid-phone-no |Validation error when accessing resource . Please refer to the problems property for additional details.

224

|422 |customer-already-exists |The requested resource '' could not be processed. Customer Already Exists

225

226

227

**Response object specification**

228

229

(% class="table-bordered table-striped" %)

230

|=Property |=Data type|=Format|=Description

231

|@id |string | |Uri identifier of the current resource

232

|customerNo |string | |

233

|=nationalIdentifier |object | |

234

| regNo |string | |

235

| countryCode |string |Pattern: ^[A-Z]{2}$ |

236

|vatNo |string | |

237

|legalEntity |string | |

238

|name |string | |

239

|emailAddress |string | |

240

|protectedIdentity |boolean | |

241

|preferredLanguageCode |string | |

242

|legalStatus |string | |

243

|msisdn |string | |

244

|=activeConsents |array | |

245

| |string | |

246

|=ediAddressInfo |object | |

247

| van |string | |

248

| interChangeRecipient |string | |

249

| buyerId |string | |

250

|surpluses |dynamic | |

251

|legalAddress |dynamic | |

252

|billingAddress |dynamic | |

253

|consent |dynamic | |

254

|distributionType |string | |

255

|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]]

256

|taxIdentificationNumber |string | |

257

258

== 2. Active-disbursement-orders ==

259

260

261

list active surpluse disbursement orders pending disbursement batch is run.

262

263

==== 2.1 Get list of Active-disbursement-orders ====

264

265

266

GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/surpluses/{surplusId}/active-disbursement-orders HTTP/1.1

267

Host: -

268

Authorization: Bearer<Token>

269

Content-Type: application/json

Get customer billing-address

HTTP/1.1 200 OK

Content-Type: application/json

{

"items": [

{

"operations": [],

"swedishBankAccount": {

284

"accountNo": "1234567890",

285

"accountType": "BGSE"

}

}

],

"navigation": {

"@id": "/ledger/customer/v1/xxx/customers/yyy/surpluses/zzz/active-disbursement-orders"

}

}

**Possible problems**

298

299

(% class="table-bordered table-striped" %)

300

|=Http status |=Problem type |=Description

301

|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.

302

|500 |handled-exception |The requested resource '' could not be processed. Please contact support.

303

|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.

304

|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.

305

|400 |validation |Validation error when accessing resource . Please refer to the problems property for additional details.

306

|404 |customer-does-not-exists |The requested resource '' was not found.

307

|404 |customer-not-found |The requested resource '' was not found.

308

309

==== 2.2 Create Active-disbursement-order ====

310

311

Add a disbursement order. Disburses all available funds on surplus account, when disbursement batch is run

312

313

314

POST /ledger/customer/v1/{ownerNo}/customers/{customerNo}/surpluses/{surplusId}/active-disbursement-orders HTTP/1.1

315

Host: -

316

Authorization: Bearer<Token>

317

Content-Type: application/json

318

319

{

320

"swedishBankAccount": {

321

"accountNo": "NNN",

322

"accountType": "BGSE | PGSE | BKSE | PKSE"

}

}

**Request object specification**

329

330

(% class="table-bordered table-striped" %)

| bic |string | |Yes |

HTTP/1.1 201 CREATED

Content-Type: application/json

{

}

**Response object specification**

363

364

(% class="table-bordered table-striped" %)

365

|=Property |=Data type|=Format|=Description

366

|=items |array | |

367

| @id |string | |Uri identifier of the current resource

368

| activeDisbursementOrdersId |string | |

369

| 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]]

370

|= norwegianBankAccount |object | |

371

| accountNo |string | |

372

|= swedishBankAccount |object | |

373

| accountNo |string | |

374

| accountType |string | |

375

|= international |object | |

376

| iban |string | |

377

| bic |string | |

378

|= swedishSus |object | |

379

|= nationalIdentifier |object | |

380

| regNo |string | |

381

| countryCode |string | |

382

|= address |object | |

383

| addressee |string | |

384

| streetAddress |string | |

385

| city |string | |

386

| zipCode |string | |

387

| countryCode |string | |

388

| coAddress |string | |

389

|=navigation |object | |

390

| @id |string |Type: uri |The current result view.

391

| first |string |Type: uri |Link to the first results.

392

| previous |string |Type: uri |Link to the previous results.

393

| next |string |Type: uri |Link to the next results.

== 3. Surpluses ==

List all available surpluses on the customer

399

400

==== 3.1 Get list of Surpluses ====

401

402

403

GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/surpluses HTTP/1.1

404

Host: -

405

Authorization: Bearer<Token>

406

Content-Type: application/json

Get surpluses list

HTTP/1.1 200 OK

Content-Type: application/json

{

"items": [

{

"surplusId": "123",

"balance": 10,

"currency": "SEK",

"date": "2026-08-16T00:00:00+02:00",

423

"status": "open",

424

"invoice": "/ledger/invoice/v1/XXX/invoices/AAA",

425

"activeDisbursementOrders": "/ledger/customer/v1/xxx/customers/yyy/surpluses/123/active-disbursement-orders",

426

"operations": [

427

{

428

"rel": "active-disbursement-orders",

429

"method": "POST",

430

"href": "/ledger/customer/v1/xxx/customers/yyy/surpluses/123/active-disbursement-orders"

431

}

432

],

433

"@id": "/ledger/customer/v1/xxx/customers/yyy/surpluses/123"

},

{

"surplusId": "456",

"balance": 20,

"currency": "SEK",

"date": "2026-08-14T00:00:00+02:00",

440

"status": "pending-disbursement",

441

"account": "/ledger/account/v1/XXX/accounts/BBB",

442

"activeDisbursementOrders": "/ledger/customer/v1/xxx/customers/yyy/surpluses/456/active-disbursement-orders",

443

"operations": [

444

{

445

"rel": "active-disbursement-orders",

446

"method": "POST",

447

"href": "/ledger/customer/v1/xxx/customers/yyy/surpluses/456/active-disbursement-orders"

448

}

449

],

450

"@id": "/ledger/customer/v1/xxx/customers/yyy/surpluses/456"

},

{

"surplusId": "789",

"balance": 30,

"currency": "SEK",

"date": "2026-08-07T00:00:00+02:00",

457

"status": "pending-regulate",

458

"invoice": "/ledger/invoice/v1/XXX/invoices/AAA",

459

"activeDisbursementOrders": "/ledger/customer/v1/xxx/customers/yyy/surpluses/789/active-disbursement-orders",

460

"operations": [

461

{

462

"rel": "active-disbursement-orders",

463

"method": "POST",

464

"href": "/ledger/customer/v1/xxx/customers/yyy/surpluses/789/active-disbursement-orders"

465

}

466

],

467

"@id": "/ledger/customer/v1/xxx/customers/yyy/surpluses/789"

}

],

"navigation": {

"@id": "/ledger/customer/v1/xxx/customers/yyy/surpluses"

}

}

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.

478

479

==== 3.2 Get specific Surpluse ====

480

481

482

GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/surpluses/{surplusId} HTTP/1.1

483

Host: -

484

Authorization: Bearer<Token>

485

Content-Type: application/json

Get single surplus

HTTP/1.1 200 OK

Content-Type: application/json

{

"surplusId": "YYY",

"balance": 10,

"currency": "SEK",

"date": "2026-08-16T00:00:00+02:00",

500

"status": "open",

501

"invoice": "/ledger/invoice/v1/XXX/invoices/AAA",

502

"account": "/ledger/account/v1/XXX/accounts/BBB",

503

"activeDisbursementOrders": "/ledger/customer/v1/xxx/customers/yyy/surpluses/yyy/active-disbursement-orders",

504

"operations": [

505

{

506

"rel": "active-disbursement-orders",

507

"method": "POST",

508

"href": "/ledger/customer/v1/xxx/customers/yyy/surpluses/yyy/active-disbursement-orders"

509

}

510

],

511

"@id": "/ledger/customer/v1/XXX/customers/AAA/surpluses/YYY"

}

**Response object specification**

518

519

(% class="table-bordered table-striped" %)

520

|=Property |=Data type|=Format|=Description

521

|@id |string | |Uri identifier of the current resource

522

|surplusId |string | |

523

|balance |number |Type: double |

524

|currency |string | |

525

|date |string |Type: date-time |

|status |string | |

|invoice |string | |

|account |string | |

|activeDisbursementOrders |dynamic | |

530

|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]]

531

532

== 4. Trusted-seller-groups ==

533

534

535

Get details about the customer's active Consent.

536

537

==== 4.1 Get list of Trusted-seller-groups ====

538

539

540

GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/consent/trusted-seller-groups HTTP/1.1

541

Host: -

542

Authorization: Bearer<Token>

543

Content-Type: application/json

Get consent list

HTTP/1.1 200 OK

Content-Type: application/json

{

"items": [

{

"consentType": "ccccc1",

557

"operations": [

558

{

559

"rel": "delete-trusted-seller-group",

560

"method": "DELETE",

561

"href": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups/ccccc1"

562

}

563

],

564

"@id": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups/ccccc1"

565

},

566

{

567

"consentType": "ccccc2",

568

"operations": [

569

{

570

"rel": "delete-trusted-seller-group",

571

"method": "DELETE",

572

"href": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups/ccccc2"

573

}

574

],

575

"@id": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups/ccccc2"

}

],

"navigation": {

"@id": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups"

}

}

**Possible problems**

587

588

(% class="table-bordered table-striped" %)

589

|=Http status |=Problem type |=Description

590

|400 |validation |Occurs if the validation of the request fails, it is described in the problem why the input is invalid.

591

|404 |not-found |Occurs if the requested resource is not found.

592

|409 |conflict |Occurs if the requested resource already exists.

593

|500 |fatal |Unexpected error, logs may give details about the problem

594

595

Get details about the customer's active Consent.

596

597

==== 4.2 Get specific Trusted-seller-group ====

598

599

600

GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/consent/trusted-seller-groups/{consentType} HTTP/1.1

601

Host: -

602

Authorization: Bearer<Token>

603

Content-Type: application/json

Get single consent

HTTP/1.1 200 OK

Content-Type: application/json

612

613

{

614

"consentType": "ccccc",

615

"operations": [

616

{

617

"rel": "delete-trusted-seller-group",

618

"method": "DELETE",

619

"href": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups/ccccc"

}

]

}

**Possible problems**

628

629

(% class="table-bordered table-striped" %)

630

|=Http status |=Problem type |=Description

631

|400 |validation |Occurs if the validation of the request fails, it is described in the problem why the input is invalid.

632

|404 |not-found |Occurs if the requested resource is not found.

633

|409 |conflict |Occurs if the requested resource already exists.

634

|500 |fatal |Unexpected error, logs may give details about the problem

635

636

==== 4.3 Create Trusted-seller-group ====

637

638

Save a pdf Consent document as a Base64 string for specific CustomerNo and ConsentType.

639

640

641

POST /ledger/customer/v1/{ownerNo}/customers/{customerNo}/consent/trusted-seller-groups HTTP/1.1

642

Host: -

643

Authorization: Bearer<Token>

644

Content-Type: application/json

645

646

{

647

"consentType": "PharmaciesSE",

648

"applicationDocument": {

649

"content": "JVBERi0xLjQKJ...",

"fileType": "pdf"

}

}

**Request object specification**

657

658

(% class="table-bordered table-striped" %)

Save a consent document

HTTP/1.1 200 OK

Content-Type: application/json

670

671

{

672

"consentType": "cccc",

673

"operations": [

674

{

675

"rel": "delete-trusted-seller-group",

676

"method": "DELETE",

677

"href": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups/cccc"

678

}

679

],

680

"@id": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups/cccc"

}

**Possible problems**

686

687

(% class="table-bordered table-striped" %)

688

|=Http status |=Problem type |=Description

689

|400 |validation |Occurs if the validation of the request fails, it is described in the problem why the input is invalid.

690

|404 |not-found |Occurs if the requested resource is not found.

691

|409 |conflict |Occurs if the requested resource already exists.

692

|500 |fatal |Unexpected error, logs may give details about the problem

693

694

695

**Response object specification**

696

697

(% class="table-bordered table-striped" %)

698

|=Property |=Data type|=Format|=Description

699

|@id |string | |Uri identifier of the current resource

700

|consentType |string | |

701

|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]]

702

703

== 5. Legal-address ==

704

705

706

The legal address is where claims is normally sent to. It is required for a customer to have a legal address registered

707

708

==== 5.1 Get list of Legal-address ====

709

710

711

GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/legal-address HTTP/1.1

712

Host: -

713

Authorization: Bearer<Token>

714

Content-Type: application/json

Get customer legal-address

HTTP/1.1 200 OK

Content-Type: application/json

723

724

{

725

"addressee": "Test Testsson",

726

"streetAddress": "Test street 1",

727

"zipCode": "60000",

728

"city": "Test town",

729

"coAddress": "Co address",

"countryCode": "SE",

"operations": [

{

"rel": "update-legal-address",

734

"method": "PUT",

735

"href": "/ledger/customer/v1/xxx/customers/yyy/legal-address"

736

},

737

{

738

"rel": "update-legal-address-from-population-register",

739

"method": "POST",

740

"href": "/ledger/customer/v1/xxx/customers/yyy/legal-address/update-legal-address-from-population-register"

}

]

}

**Possible problems**

749

750

(% class="table-bordered table-striped" %)

751

|=Http status |=Problem type |=Description

752

|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.

753

|500 |handled-exception |The requested resource '' could not be processed. Please contact support.

754

|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.

755

|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.

756

|400 |validation |Validation error when accessing resource . Please refer to the problems property for additional details.

757

|404 |customer-does-not-exists |The requested resource '' was not found.

758

|404 |customer-not-found |The requested resource '' was not found.

759

760

761

**Response object specification**

762

763

(% class="table-bordered table-striped" %)

764

|=Property |=Data type|=Format|=Description

765

|@id |string | |Uri identifier of the current resource

766

|addressee |string | |

767

|streetAddress |string | |

768

|zipCode |string | |

769

|city |string | |

770

|coAddress |string | |

771

|countryCode |string | |

772

|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]]

773

774

== 6. Update-kyc-answers ==

775

776

777

==== 6.1 Create Update-kyc-answer ====

778

779

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

780

781

782

POST /ledger/customer/v1/{ownerNo}/customers/{customerNo}/update-kyc-answers HTTP/1.1

783

Host: -

784

Authorization: Bearer<Token>

785

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"

}

]

}

**Request object specification**

811

812

(% class="table-bordered table-striped" %)

HTTP/1.1 201 CREATED

Content-Type: application/json

{

}

**Possible problems**

828

829

(% class="table-bordered table-striped" %)

830

|=Http status |=Problem type |=Description

831

|400 |validation |Occurs if the validation of the request fails, it is described in the problem why the input is invalid.

832

|404 |not-found |Occurs if the customer not found or if KYC is not configured on this ledger.

833

|409 |company-kyc-questions-not-configured |Occurs if ledger is not currently configured for KYC

834

|500 |fatal |Unexpected error, logs may give details about the problem

835

836

== 7. Update-legal-address-from-population-register ==

837

838

839

==== 7.1 Create Update-legal-address-from-population-register ====

840

841

Execution of this operation will result in an attempt to retrieve (and replace) the customer's legal address from the population registry.

842

843

844

POST /ledger/customer/v1/{ownerNo}/customers/{customerNo}/legal-address/update-legal-address-from-population-register HTTP/1.1

845

Host: -

846

Authorization: Bearer<Token>

847

Content-Type: application/json

{

}

HTTP/1.1 204 NO CONTENT

857

Content-Type: application/json

{}

**Possible problems**

864

865

(% class="table-bordered table-striped" %)

866

|=Http status |=Problem type |=Description

867

|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.

868

|500 |handled-exception |The requested resource '' could not be processed. Please contact support.

869

|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.

870

|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.

871

|400 |validation |Validation error when accessing resource . Please refer to the problems property for additional details.

872

|404 |customer-does-not-exists |The requested resource '' was not found.

873

|404 |customer-not-found |The requested resource '' was not found.

874

875

== 8. Billing-address ==

876

877

878

The billing address is where invoices/bills/letters etc. is normally sent to. This address is optional

879

880

==== 8.1 Get list of Billing-address ====

881

882

883

GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/billing-address HTTP/1.1

884

Host: -

885

Authorization: Bearer<Token>

886

Content-Type: application/json

Get customer billing-address

HTTP/1.1 200 OK

Content-Type: application/json

895

896

{

897

"addressee": "Test Testsson",

898

"streetAddress": "Test street 1",

899

"zipCode": "60000",

900

"city": "Test town",

901

"coAddress": "Co address",

"countryCode": "SE",

"operations": [

{

"rel": "update-billing-address",

906

"method": "PUT",

907

"href": "/ledger/customer/v1/xxx/customers/yyy/billing-address"

908

},

909

{

910

"rel": "delete-billing-address",

911

"method": "DELETE",

912

"href": "/ledger/customer/v1/xxx/customers/yyy/billing-address"

}

]

}

**Possible problems**

921

922

(% class="table-bordered table-striped" %)

923

|=Http status |=Problem type |=Description

924

|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.

925

|500 |handled-exception |The requested resource '' could not be processed. Please contact support.

926

|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.

927

|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.

928

|400 |validation |Validation error when accessing resource . Please refer to the problems property for additional details.

929

|404 |customer-does-not-exists |The requested resource '' was not found.

930

|404 |customer-not-found |The requested resource '' was not found.

931

932

==== 8.2 Create Billing-addre ====

933

934

Add a billing address to customer. The billing address is where invoices/bills/letters etc. is normally sent to. This address is optional

935

936

937

POST /ledger/customer/v1/{ownerNo}/customers/{customerNo}/billing-address HTTP/1.1

938

Host: -

939

Authorization: Bearer<Token>

940

Content-Type: application/json

941

942

{

943

"addressee": "Test Testsson",

944

"streetAddress": "Test street 1",

945

"zipCode": "60000",

946

"city": "Test town",

947

"coAddress": "Co address",

"countryCode": "SE"

}

**Request object specification**

954

955

(% class="table-bordered table-striped" %)

HTTP/1.1 201 CREATED

Content-Type: application/json

{

}

**Possible problems**

974

975

(% class="table-bordered table-striped" %)

976

|=Http status |=Problem type |=Description

977

|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.

978

|500 |handled-exception |The requested resource '' could not be processed. Please contact support.

979

|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.

980

|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.

981

|400 |validation |Validation error when accessing resource . Please refer to the problems property for additional details.

982

|404 |customer-does-not-exists |The requested resource '' was not found.

983

|404 |customer-not-found |The requested resource '' was not found.

984

985

986

**Response object specification**

987

988

(% class="table-bordered table-striped" %)

989

|=Property |=Data type|=Format|=Description

990

|@id |string | |Uri identifier of the current resource

991

|addressee |string | |

992

|streetAddress |string | |

993

|zipCode |string | |

994

|city |string | |

995

|coAddress |string | |

996

|countryCode |string | |

997

|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.

1003

1004

==== 9.1 Get list of Consent ====

1005

1006

1007

GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/consent HTTP/1.1

1008

Host: -

1009

Authorization: Bearer<Token>

1010

Content-Type: application/json

Get customer consent

HTTP/1.1 200 OK

Content-Type: application/json

1019

1020

{

1021

"recurringCard": "/ledger/customer/v1/xxx/customers/yyy/consent/recurring-card",

1022

"recurringCardRedirectRegistration": "/ledger/customer/v1/xxx/customers/yyy/consent/recurring-card-redirect-registration",

1023

"trustedSellerGroups": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups",

1024

"availableTrustedSellerGroupConsents": [],

1025

"operations": [

1026

{

1027

"rel": "add-trusted-seller-group",

1028

"method": "POST",

1029

"href": "/ledger/customer/v1/xxx/customers/yyy/consent/trusted-seller-groups"

1030

},

1031

{

1032

"rel": "add-recurring-card-redirect-registration",

1033

"method": "POST",

1034

"href": "/ledger/customer/v1/xxx/customers/yyy/consent/recurring-card-redirect-registration"

}

]

}

**Response object specification**

1043

1044

(% class="table-bordered table-striped" %)

1045

|=Property |=Data type|=Format|=Description

1046

|@id |string | |Uri identifier of the current resource

1047

|recurringCard |dynamic | |

1048

|recurringCardRedirectRegistration |dynamic | |

1049

|trustedSellerGroups |dynamic | |

1050

|=availableTrustedSellerGroupConsents |array | |

1051

| |string | |

1052

|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]]

1053

1054

== 10. Find-customer ==

1055

1056

1057

==== 10.1 Create Find-customer ====

1058

1059

It is used to find customer with nationalIdentifier.

1060

1061

1062

POST /ledger/customer/v1/{ownerNo}/find-customer HTTP/1.1

1063

Host: -

1064

Authorization: Bearer<Token>

1065

Content-Type: application/json

1066

1067

{

1068

"nationalIdentifier": {

1069

"regNo": "YYYYMMDD-NNNN",

"countryCode": "SE"

}

}

**Request object specification**

1077

1078

(% class="table-bordered table-striped" %)

Find customer with nationalIdentifier, regno and countrycode, returns CustomerNo = YYY

HTTP/1.1 200 OK

Content-Type: application/json

{

"customerNo": "YYY"

}

**Possible problems**

1097

1098

(% class="table-bordered table-striped" %)

1099

|=Http status |=Problem type |=Description

1100

|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.

1101

|500 |handled-exception |The requested resource '' could not be processed. Please contact support.

1102

|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.

1103

|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.

1104

|400 |validation |Validation error when accessing resource . Please refer to the problems property for additional details.

1105

|400 |invalid-reg-no |Validation error when accessing resource . Please refer to the problems property for additional details.

1106

|404 |customer-does-not-exists |The requested resource '' was not found.

1107

|404 |customer-not-found |The requested resource '' was not found.

1108

1109

1110

**Response object specification**

1111

1112

(% class="table-bordered table-striped" %)

1113

|=Property |=Data type|=Format|=Description

1114

|@id |string | |Uri identifier of the current resource

1115

|customerNo |string | |

1116

1117

== 11. Recurring-card ==

1118

1119

1120

Get details about the customer's active Recurring Card Consent.

1121

1122

==== 11.1 Get list of Recurring-card ====

1123

1124

1125

GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/consent/recurring-card HTTP/1.1

1126

Host: -

1127

Authorization: Bearer<Token>

1128

Content-Type: application/json

Get customer active Recurring Card Consent.

HTTP/1.1 200 OK

Content-Type: application/json

1137

1138

{

1139

"cardToken": "2eb28854-07ec-4e88-b672-7c61cc54b461",

1140

"consentExpiryDate": "04-2035",

1141

"instrumentDisplayName": "551000******1232",

1142

"cardExpiryDate": "04/2035",

"cardBrand": "Visa",

"operations": [

{

"rel": "delete-recurring-card",

1147

"method": "DELETE",

1148

"href": "/ledger/customer/v1/xxx/customers/yyy/consent/recurring-card"

}

]

}

**Response object specification**

1157

1158

(% class="table-bordered table-striped" %)

1159

|=Property |=Data type|=Format|=Description

1160

|@id |string | |Uri identifier of the current resource

1161

|cardToken |string | |

1162

|consentExpiryDate |string | |

1163

|instrumentDisplayName |string | |

1164

|cardExpiryDate |string | |

1165

|cardBrand |string | |

1166

|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]]

1167

1168

== 12. Recurring-card-redirect-registration ==

1169

1170

1171

Get details about the customer's ongoing Recurring Card registration.

1172

1173

==== 12.1 Get list of Recurring-card-redirect-registration ====

1174

1175

1176

GET /ledger/customer/v1/{ownerNo}/customers/{customerNo}/consent/recurring-card-redirect-registration HTTP/1.1

1177

Host: -

1178

Authorization: Bearer<Token>

1179

Content-Type: application/json

Customer's ongoing Recurring Card Registration.

HTTP/1.1 200 OK

Content-Type: application/json

1188

1189

{

1190

"redirectUrl": "https://ecom.externalintegration.payex.com/checkout/abc123",

1191

"status": "Initialized",

"operations": []

}

==== 12.2 Create Recurring-card-redirect-registration ====

1198

1199

Initializes the customer's Recurring Card registration with redirect to SwedbankPay.

1200

1201

1202

POST /ledger/customer/v1/{ownerNo}/customers/{customerNo}/consent/recurring-card-redirect-registration HTTP/1.1

1203

Host: -

1204

Authorization: Bearer<Token>

1205

Content-Type: application/json

1206

1207

{

1208

"completeUrl": "https://www.google.com/search?q=cancelurl",

1209

"cancelUrl": "https://www.google.com/search?q=completeurl",

"language": "en-US"

}

**Request object specification**

1216

1217

(% class="table-bordered table-striped" %)

Customer's ongoing Recurring Card Registration.

HTTP/1.1 200 OK

Content-Type: application/json

1228

1229

{

1230

"redirectUrl": "https://ecom.externalintegration.payex.com/checkout/abc123",

1231

"status": "Initialized",

1232

"operations": [],

1233

"@id": "/ledger/customer/v1/xxx/customers/yyy/consent/recurring-card-redirect-registration"

}

**Response object specification**

1239

1240

(% class="table-bordered table-striped" %)

1241

|=Property |=Data type|=Format|=Description

1242

|@id |string | |Uri identifier of the current resource

1243

|redirectUrl |string | |

1244

|status |string | |

1245

|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]]

1246

1247

== 13. Kyc-questions ==

1248

1249

1250

Get KYC questions from ledger using company number as identifier

1251

1252

==== 13.1 Get list of Kyc-questions ====

1253

1254

1255

GET /ledger/customer/v1/{ownerNo}/kyc-questions?language={language} HTTP/1.1

1256

Host: -

1257

Authorization: Bearer<Token>

1258

Content-Type: application/json

Get CompanyInstance KYC questions if configured or a 404 company-kyc-questions-not-configured response if not

HTTP/1.1 200 OK

Content-Type: application/json

{

"kycQuestions": [

{

"questionText": "What is your current employment?",

"answer": {

"type": "single",

"required": true,

"possibleAnswers": [

{

"answerCode": "selfemployed",

1278

"answerText": "Own business"

1279

},

1280

{

1281

"answerCode": "private_employee",

1282

"answerText": "Private employee"

1283

},

1284

{

1285

"answerCode": "goverment_employee",

1286

"answerText": "Government employee"

}

]

},

"questionCode": "employment"

1291

},

1292

{

1293

"questionText": "What is your yearly income",

"answer": {

"type": "single",

"required": true,

"possibleAnswers": [

{

"answerCode": "incomeinterval1",

1300

"answerText": "0-100 000 SEK"

1301

},

1302

{

1303

"answerCode": "incomeinterval2",

1304

"answerText": "100 001-200 000 SEK"

1305

},

1306

{

1307

"answerCode": "incomeinterval3",

1308

"answerText": "200 001-300 000 SEK"

1309

},

1310

{

1311

"answerCode": "incomeinterval4",

1312

"answerText": "Over 300 001 SEK"

}

]

},

"questionCode": "income"

}

],

"operations": []

}

**Query parameters**

(% class="table-bordered table-striped" %)

1328

|=Name |=Required |=Description

1329

|language |False |format ISO639-1, if not supported or none given request defaults to language code 'en'(English)

1330

1331

1332

**Possible problems**

1333

1334

(% class="table-bordered table-striped" %)

1335

|=Http status |=Problem type |=Description

1336

|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.

1337

|500 |handled-exception |The requested resource '' could not be processed. Please contact support.

1338

|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.

1339

|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.

1340

|404 |company-kyc-questions-not-configured |The requested resource '' was not found.

1341

1342

1343

**Response object specification**

1344

1345

(% class="table-bordered table-striped" %)

1346

|=Property |=Data type|=Format|=Description

1347

|@id |string | |Uri identifier of the current resource

1348

|=kycQuestions |array | |

1349

| questionCode |string | |The code definition of the question

1350

| questionText |string | |The translated text of the question

1351

|= answer |object | |

1352

1353

| required |boolean | |If the answer is required

1354

| textValidationRegEx |string | |The regex the answer should match

1355

|= possibleAnswers |array | |

1356

| answerCode |string | |The code definition of the answer

1357

| answerText |string | |The translated text of the answer

1358

|= subQuestions |array | |

1359

|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]]

1360

1361

== 14. Affordability-questions ==

1362

1363

1364

Get affordability questions from ledger using company number as identifier

1365

1366

==== 14.1 Get list of Affordability-questions ====

1367

1368

1369

GET /ledger/customer/v1/{ownerNo}/affordability-questions?language={language} HTTP/1.1

1370

Host: -

1371

Authorization: Bearer<Token>

1372

Content-Type: application/json

Get CompanyInstance affordability questions if configured. It's expected that not all credit assessment levels are configured for every company.

HTTP/1.1 200 OK

Content-Type: application/json

1381

1382

{

1383

"creditAssessmentLevel1": [

1384

{

1385

"questionCode": "yearly_revenue",

1386

"questionText": "What is your yearly revenue?",

"answer": {

"type": "single",

"required": true,

"possibleAnswers": [

{

"answerCode": "interval1",

1393

"answerText": "0-500 000 SEK"

1394

},

1395

{

1396

"answerCode": "interval2",

1397

"answerText": "500 001-1 000 000 SEK"

}

]

}

}

],

"creditAssessmentLevel2": [

1404

{

1405

"questionCode": "number_of_employees",

1406

"questionText": "How many employees does the company have?",

"answer": {

"type": "single",

"required": true,

"possibleAnswers": [

{

"answerCode": "interval1",

"answerText": "1-10"

},

{

"answerCode": "interval2",

1417

"answerText": "11-50"

}

]

}

}

],

"operations": []

}

**Query parameters**

(% class="table-bordered table-striped" %)

1432

|=Name |=Required |=Description

1433

|language |False |format ISO639-1, if not supported or none given request defaults to language code 'en'(English)

1434

1435

1436

**Possible problems**

1437

1438

(% class="table-bordered table-striped" %)

1439

|=Http status |=Problem type |=Description

1440

|500 |internal-server-error |The requested resource '' could not be processed. Please contact support.

1441

|500 |handled-exception |The requested resource '' could not be processed. Please contact support.

1442

|500 |unhandled-exception |The requested resource '' could not be processed. Please contact support.

1443

|400 |general-validation-error |Validation error when accessing resource . Please refer to the problems property for additional details.

1444

1445

1446

**Response object specification**

1447

1448

(% class="table-bordered table-striped" %)

1449

|=Property |=Data type|=Format|=Description

1450

|@id |string | |Uri identifier of the current resource

1451

|=creditAssessmentLevel1 |array | |

1452

| questionCode |string | |The code definition of the question

1453

| questionText |string | |The translated text of the question

1454

|= answer |object | |

1455

1456

| required |boolean | |If the answer is required

1457

| textValidationRegEx |string | |The regex the answer should match

1458

|= possibleAnswers |array | |

1459

| answerCode |string | |The code definition of the answer

1460

| answerText |string | |The translated text of the answer

1461

|= subQuestions |array | |

1462

|=creditAssessmentLevel2 |array | |

1463

|=creditAssessmentLevel3 |array | |

1464

|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]]

1465

1466

{{display reference="developer:Main.Invoicing.ledger-api-general-docs.api-section-problems.WebHome"/}}

Wiki source code of 2. Customer