Pay.nl C# SDK

With this SDK you will be able to start transactions and retrieve transactions with their status for the Pay.nl payment service provider.

This SDK provides support for both the PAY 2.0 (stable), and the PAY 3.0 (beta), with each their own client class, PayV2Client and PayV3Client.

---

• Installation
• Quick start and examples
• Supported platforms
• Implemented features
• License

---

Installation

Simply download and restore nuget packages https://www.nuget.org/packages/PayNL.Sdk or install it from package manager

PM> Install-Package PayNL.Sdk -Version x.x.x

Usage

Creating a client, you can find your API key and tokens in the Pay.nl Admin Panel, and the service id (SL-xxxx-xxx) secret in the Pay.nl Services Overview under 'Sales locations':

var client = new PayV2Client("apiSecret", "AT-xxxx-xxxx", "ST-xxxx-xxxx");

Getting a list of available payment methods:

var methods = await client.GetAvailablePaymentMethods();

Starting a transaction:

var transactionRequest = new CreateTransactionRequest()
{
    Amount = new Amount()
        {
            Value = 1000,
        },
    ReturnUrl = "https://demo.pay.nl/complete/",
    Description = "Example transaction",
    Reference = "12345XXY0123"
};

// Contains ID
var transactionResponse = await client.CreateTransaction(transactionRequest);

To determine if a transaction has been paid, you can use:

var trxStatus = await client.GetTransactionInfo(transactionResponse.Id);
var paid = trxStatus.AmountPaid.Value == trxStatus.Amount.Value;

Flexible debit order

To start a flexible debit order first create a mandate:

var mandate = await client.CreateMandate(new CreateMandateRequest
    {
        ServiceId = "SL-1234-1234",
        Amount= 1,
        Bankaccountholder = "John Doe",
        ProcessDate = "dd-MM-yyyy",
        Description = "Create Mandate",
        BankaccountNumber = "NL42INGB0000000000"
    });
var mandateId = mandate.MandateId;

The mandate first needs to be processed, use the below service too check the status of the mandate (MandateStatusCode should be Processed):

var mandate = await client.GetMandate("IO-1234-1234-1234");

Once processed you can start a flexible debit order using the below service:

var debitOrder = await client.CreateFlexibleDirectDebit(new FlexibleDirectDebitRequest
{
    MandateId = "IO-1234-1234-1234",
    Amount = 1,
    ProcessDate = "dd-MM-yyyy",
    Description = "Create debit order",
    Last = false,
});

var debitOrderId = debitOrder.DebitOrderId;

Unit Tests

In order run the unit tests the following environment variables needs too be set up:

Variable	Value
PAY_APIKEY	Your pay API Token from the pay dashboard
PAY_AT	AT code of the API Token (AT-1234-1234)
PAY_SERVICEID	Service location code
PAY_MANDATEID	Mandate code used for direct debit orders
PAY_BANKACCOUNTNUMBER	Iban number used for clearing and diriect debit order tests
PAY_BANKACCOUNTHOLDER	Account holder of the above Iban

Supported platforms

This library is built using .NET standard 2.1. This means that the package supports the following .NET implementations:

Framework	Version Support
.NET and .NET Core	3.0, 3.1, 5.0, 6.0, 7.0, 8.0
.NET Framework 1	N/A
Mono	6.4
Xamarin.iOS	12.16
Xamarin.Mac	5.16
Xamarin.Android	10.0
Universal Windows Platform	N/A
Unity	2021.2

Source: https://docs.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-1

Implemented features API V2

• Transactions
  • Create
  • View
  • Cancel
  • Refund
  • Approve
  • Decline
  • Capture
  • Void
  • Load
  • Load UUID
• Get available currencies
• DirectDebits CRUD
• Ip addresses
  • Get all
  • Verify single
• Merchants
  • Create
  • Get
  • Delete
  • List
  • Update
  • Request review
  • Clearings
  • Invoices
  • Update package
  • Undelete
• Packages
• Get available payment methods
• Get services
• Pin transactions
  • Get status
  • Cancel
  • Get terminals
• Trademarks
  • Get
  • List
  • Create
  • (Un)suspend
• Create vouchers
• Remainder of the documented API

Implemented features API V3

• Orders
  • Create
  • View
  • Capture order
  • Capture amount
  • Capture products
  • Void
  • Abort
  • Approve
  • Decline
• Remainder of the documented API

License

The Assembly is available as open source under the terms of the MIT License.