Payouts

Introduction

The Payout API enables merchants/integrators to programmatically create and manage payouts to external bank accounts. It provides a secure and reliable way to transfer funds from a service location balance to a designated beneficiary, supporting automated payout flows and reconciliation.

The API validates payout requests, processes eligible payouts, and updates the service location balance accordingly upon successful execution. It is designed to integrate seamlessly into existing payment systems.

Follow the recipe below for a step-by-step walkthrough:

Endpoint: https://developer.pay.nl/reference/post_payout

Example request

curl --request POST \
     --url https://rest.pay.nl/v2/payout \
     --header 'accept: application/json' \
     --header 'authorization: Basic QVQtMDA0MS00MDMxOjk4ZjQ5Y2YwY2NlMGI4YAz4jNM5ODwUMTc4MWJmNTI5ZTU5MTkzYTQ=' \
     --header 'content-type: application/json' \
     --data '
{
  "transaction": {
    "type": "MIT",
    "amount": {
      "value": 10
    },
    "serviceId": "SL-1234-1234",
    "description": "DESC1234",
    "reference": "REF1234",
    "exchangeUrl": "https://demo.pay.nl/exchange.php"
  },
  "payment": {
    "method": "iban",
    "iban": {
      "number": "NL69INGB0123456789",
      "bic": "INGBNL2A",
      "holder": "John Doe"
    }
  }
}
'

Successful response

{
  "transaction": {
    "id": "EX-9560-1234-3852",
    "orderId": "3233123422Xf3b3f",
    "serviceId": "SL-1234-1234",
    "description": "DESC1234",
    "reference": "REF1234",
    "amount": {
      "value": 10,
      "currency": "EUR"
    },
    "created": "2026-01-02T11:00:35+01:00",
    "modified": "2026-01-02T11:00:36+01:00"
  },
  "_links": [
    {
      "href": "/transactions/EX-9560-1234-3852",
      "rel": "details",
      "type": "GET"
    },
    {
      "href": "/payout",
      "rel": "self",
      "type": "POST"
    }
  ]
}