New order API endpoints - v1.2 #30

Jeroen-G · 2025-09-01T12:27:10Z

Description

Added the order endpoints for the Transaction Gateway Unit API.
Automated tests and linting (run on this repo as soon as this PR is merged)
A PR template

How to test

Have node and npm installed. To run the examples you can use a setup with e.g. npm or bun, for example: bun run ./examples/connect/createOrder.ts or npx ts-node ./examples/connect/createOrder.ts)
npm install
Run npm run test and see tests succeed
Run npm run lint to see linting succeed
Get an API token and service location ID
Try out the examples from `./examples/connect
Try out the examples from other example folders to verify that the old API is still accessible

Releasing

merge this PR
create a release v1.2 with the notes from the changelog

PAY-34: Setup local development

…ange TypeScript target to ES2022 # Conflicts: # tsconfig.json

PAY-36: Add jest testing

PAY-38: Added github actions setup

PAY-37: setup connect API client

PAY-35: Add order create

# Conflicts: # src/connect/order/OrderApi.ts

fix 3 out of 6 vulnerabilities

PAY-53: Improve API test assertions

Co-authored-by: Max Hoogenbosch <[email protected]>

changelog and upgrade guide

update readme with orders

Make sure orderId is used instead of order ID for backward compatability

add service config API

Joep-Scenius · 2025-09-29T11:34:19Z

README.md

+```typescript
+payNL.Transaction.start({
    //the amount in euro
    amount: 19.95,


Dit moet cents zijn, toch?
https://developer.pay.nl/v2.0/reference/post_transactions-1

Dit is de oude(re) API, dus deze docs: https://docs.pay.nl/developers

Maar daar staat het ook dat het in centen moet, dus dat hebben we niet goed gecontroleerd.

Joep-Scenius · 2025-09-29T11:34:42Z

README.md

 // Start transaction and send to the terminal
-Paynl.Transaction.start({
+payNL.Transaction.start({
    amount: 0.01,


Joep-Scenius · 2025-09-29T11:37:32Z

src/api/api.ts

-                       return;
-                   }
-                }
+                    if (response.statusCode !== 200) {


Wordt 201 nooit gebruikt?

Dit is de oude API die we opnieuw geformat hebben maar niet aangepast, dus dat kan ik je niet zeggen.

Joep-Scenius · 2025-09-29T11:39:51Z

src/config.ts

    private static apiToken: string;
    private static serviceId: string;
-    private static baseUrl = "https://rest-api.pay.nl";
+    private static baseUrl = 'https://rest-api.pay.nl';


Wat leeft hier? Ik ken alleen rest.pay.nl en gms-api.tinpay.nl, is dit voor de oude transactie apis? Als dat zo is, was dat een requirement?

Dit is de oude API inderdaad: https://docs.pay.nl/developers

Alles daarvoor hebben we in deze versie niet aangepast, alleen linting is erover gegaan. Zie de andere PR (en de changelog en upgrade guide) voor de complete migratie waarbij dit verdwenen is.

Joep-Scenius · 2025-09-29T11:44:22Z

src/connect/createPayNLClient.ts

+}
+
+function configureBackwardsCompatibleApi(options: ClientOptions) {
+    Paynl.Config.setApiToken(options.apiToken);


Welke format krijgt de apiToken, moet de gebruiker hier AT:at-secret inzetten?

Nee dit is de token (zo word het in my.pay.nl genoemd). Zal er ongeveer zo uit zien :) ****************************************

Er zijn meerdere type tokens, je kan authen via at:at-secret, SL-code:SL-secret, of username/auth JWT tokens. Maar als Wesley het goed vind, maakt het mij niet uit :)

Joep-Scenius · 2025-09-29T12:02:44Z

src/datatypes/directdebit/add-request.ts

-        var data = {};
+        const data = {};

        data['amount'] = Math.round(this.amount * 100);


Als je door de gehele SDK gewoon centen aanhoud, hoef je dit niet te doen. Krijg je ook geen gedoe met afrondingsfoutjes

We wilden in deze versie niks aanpassen aan de bestaande oude code.

Joep-Scenius · 2025-09-29T12:03:32Z

src/datatypes/directdebit/add-request.ts

    }
    private formatDateTime(date: Date) {
-        return dateFormat(date, 'dd-mm-yyyy hh:MM:ss');       
+        return dateFormat(date, 'dd-mm-yyyy hh:MM:ss');


Slikt de API niet gewoon de return van date.toISOString

We wilden in deze versie niks aanpassen aan de bestaande oude code.

Joep-Scenius · 2025-09-29T12:04:01Z

src/datatypes/directdebit/add-request.ts

+        if (this.bankaccountBic) data['bankaccountBic'] = this.bankaccountBic;
+        if (this.processDate) data['processDate'] = this.formatDate(this.processDate);
+        if (this.description) data['description'] = this.description;
+        if (this.ipAddress) data['ipAddress'] = this.ipAddress;
+        if (this.email) data['email'] = this.email;
+        if (this.promotorId) data['promotorId'] = this.promotorId;
+        if (this.tool) data['tool'] = this.tool;
+        if (this.info) data['info'] = this.info;
+        if (this.object) data['object'] = this.object;
+        if (this.extra1) data['extra1'] = this.extra1;
+        if (this.extra2) data['extra2'] = this.extra2;
+        if (this.extra3) data['extra3'] = this.extra3;
+        if (this.currency) data['currency'] = this.currency;
+        if (this.exchangeUrl) data['exchangeUrl'] = this.exchangeUrl;


Waarvoor dient dit?

We wilden in deze versie niks aanpassen aan de bestaande oude code. Dit is enkel linting/formatting die is toegepast.

Joep-Scenius · 2025-09-29T12:05:49Z

src/datatypes/transaction-start.ts

    /**
     * The id of the paymentmethod.
-     * Use PaymentMethods.getList() to retrieve the available paymentmethods 
+     * Use PaymentMethods.getList() to retrieve the available paymentmethods


Wil je hier niet de paymentmethods van de saleslocation gebruiken?

We wilden in deze versie niks aanpassen aan de bestaande oude code.

Joep-Scenius · 2025-09-29T12:07:18Z

src/datatypes/transaction-start.ts

    private calculateVatCode(priceIncl, vatAmount) {
-        var vatCodes = { 0: 'N', 9: 'L', 21: 'H' };
-        var priceExcl = priceIncl - vatAmount;
+        const vatCodes = { 0: 'N', 9: 'L', 21: 'H' };
+        const priceExcl = priceIncl - vatAmount;
        if (!vatAmount || vatAmount == 0 || !priceIncl || priceIncl == 0) {
            return vatCodes[0];
        }

-        var vatRate = (vatAmount / priceExcl) * 100;
+        const vatRate = (vatAmount / priceExcl) * 100;

-        var closest = Object.keys(vatCodes).reduce(
-            (prev, curr) => {
-                var prevFloat = parseFloat(prev);
-                var currFloat = parseFloat(curr);
-                return (Math.abs(currFloat - vatRate) < Math.abs(prevFloat - vatRate) ? curr : prev);
-            });
+        const closest = Object.keys(vatCodes).reduce((prev, curr) => {
+            const prevFloat = parseFloat(prev);
+            const currFloat = parseFloat(curr);
+            return Math.abs(currFloat - vatRate) < Math.abs(prevFloat - vatRate) ? curr : prev;
+        });


Waarom mag de user een vatAmount invullen, ipv door de hele sdk gewoon die N L H toepassen? Is dit voor compatibiliteit

We wilden in deze versie niks aanpassen aan de bestaande oude code.

Jeroen-G · 2025-09-29T12:29:59Z

Bedankt voor je review zo ver @Joep-Scenius! Zoals je ziet heb je deels ook de bestaande code gereviewed, dat laten we hier dus even voor wat het is.

Joep-Scenius · 2025-09-29T13:32:57Z

Oeps, dat had ik niet helemaal door. Lekker laten zitten inderdaad. In je andere PR moet alles wel 100% toch?

Jeroen-G · 2025-09-29T15:10:56Z

Snap ik goed, no worries! Ja in de andere PR is wel alles door ons geschreven 👍

- Use cents where possible - Update type declarations of service config - Remove template literals to improve DX

Joep-Scenius · 2025-10-01T08:00:33Z

Ziet er goed uit! Kunnen jullie een seintje geven als alles is verwerkt? (Waar nodig) dan kun je wel mergen denk ik

PAY-66: Resolved feedback on v1.2.0

Xammie · 2025-10-01T13:12:06Z

@Joep-Scenius ik heb zojuist je feedback verwerkt, kan je er nog een keer naar kijken?

Xammie and others added 30 commits August 21, 2025 11:42

PAY-34: Move samples to root directory

cdc609c

PAY-34: Add ESLint and prettier

f443b67

PAY-34: Formatting and ignoring of existing errors

5a2bf60

PAY-34: Add basic CONTRIBUTING.md with instructions on ESLint

0e11ec0

PAY-34: Update tsconfig.json

3c29742

PAY-34: Rename samples to examples

84e1c02

Add commands to build the package

0f5c725

Add node engine to package.json

bcf3186

Merge pull request #1 from Enrise/PAY-34

6a758a5

PAY-34: Setup local development

add jest for testing

5245697

PR template

4435a47

🔧 jest config updates

3d44d3b

update jest and eslint configurations, add ts-node dependency, and ch…

e643f28

…ange TypeScript target to ES2022 # Conflicts: # tsconfig.json

Merge pull request #5 from Enrise/PAY-36

7b90d61

PAY-36: Add jest testing

setup connect API client

7cac66a

Added github actions setup

2a82fb8

Merge pull request #6 from Enrise/PAY-38

7fad8f8

PAY-38: Added github actions setup

Moved test files to sub directory

89286be

Merge pull request #4 from Enrise/PAY-37

5b887f7

PAY-37: setup connect API client

Fix typescript not publishing sub-directories

c74922e

Add order create endpoint

b9d801a

Split order create types and cleanup code

5a2d6bb

Add more tests and cleanup types

5ec2000

Remove side effects from ApiError and use Date objects in request

22e562f

Refactor API requests

642d2a0

remove dependency on date-fns

315b835

Merge pull request #7 from Enrise/PAY-35

84e112f

PAY-35: Add order create

Update lock file

7c79dd9

Order status

520467d

# Conflicts: # src/connect/order/OrderApi.ts

Update order endpoint

550e1bb

Jeroen-G and others added 6 commits September 1, 2025 15:29

changelog and upgrade guide

c932bfe

fix 3 out of 6 vulnerabilities

301769a

mark as deprecated

535bf91

Merge pull request #2 from Enrise/PAY-49

93a8ddf

fix 3 out of 6 vulnerabilities

Update lock file

7765396

PAY-53: Improve api tests

0930d05

Jeroen-G changed the title ~~New order API endpoints~~ New order API endpoints - v1.2 Sep 2, 2025

Jeroen-G and others added 2 commits September 2, 2025 10:39

Merge pull request #3 from Enrise/PAY-53

d280a26

PAY-53: Improve API test assertions

update readme with orders

bb62042

Jeroen-G mentioned this pull request Sep 2, 2025

v2.0 release #31

Merged

6 tasks

Jeroen-G and others added 11 commits September 2, 2025 15:29

Apply suggestion from @Xammie

1b0d505

Co-authored-by: Max Hoogenbosch <[email protected]>

Apply suggestion from @Xammie

996f864

Co-authored-by: Max Hoogenbosch <[email protected]>

Apply suggestion from @Xammie

7f51b60

Co-authored-by: Max Hoogenbosch <[email protected]>

apply suggestion; update lockfile

6686922

Merge pull request #1 from Enrise/PAY-50

92f7e4f

changelog and upgrade guide

Make sure orderId is used instead of order ID for backward compatability

d34942c

Merge pull request #4 from Enrise/PAY-51

6d952d6

update readme with orders

Merge pull request #7 from Enrise/orderid

d00a816

Make sure orderId is used instead of order ID for backward compatability

remove openapi spec file, not needed

4f08432

add service config API

6a608e3

Merge pull request #11 from Enrise/PAY-61

8cb5dc5

add service config API

Joep-Scenius suggested changes Sep 29, 2025

View reviewed changes

Resolved feedback on v1.2.0

8aba36c

- Use cents where possible - Update type declarations of service config - Remove template literals to improve DX

Merge pull request #17 from Enrise/PAY-66

51342be

PAY-66: Resolved feedback on v1.2.0

Update jsdoc with link to product types

f6af21d

New order API endpoints - v1.2 #30

Are you sure you want to change the base?

New order API endpoints - v1.2 #30

Conversation

Jeroen-G commented Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How to test

Releasing

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Jeroen-G commented Sep 29, 2025

Uh oh!

Joep-Scenius commented Sep 29, 2025

Uh oh!

Jeroen-G commented Sep 29, 2025

Uh oh!

Joep-Scenius commented Oct 1, 2025

Uh oh!

Xammie commented Oct 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Jeroen-G commented Sep 1, 2025 •

edited

Loading