readme

FarPay API Documentation

Welcome to the FarPay API documentation. This comprehensive guide will help you integrate with FarPay's payment processing platform to handle invoices, payments, customer management, and recurring payment agreements.

Quick Start

Get your API key from the FarPay web application
Test the API using our interactive documentation
Review examples in our integration examples

Base URL

https://api.farpay.io/v2

Authentication

All API requests require an API key in the header:

X-API-KEY: your-api-key-here
Accept: application/json

Core Concepts

Resource	Description	Endpoint
Customers	Manage customer information and payment agreements	`/customers`
Orders	Create payment flows and agreements	`/orders`
Invoices	Generate and manage invoices	`/invoices`
Payments	Track payment history and process refunds	`/payments`
Agreements	Manage recurring payment instruments	`/agreements`
Payment Sets	Access aggregated payment information	`/paymentsets`
Deliveries	Upload files for batch processing	`/deliveries`

Payment Methods Supported

MobilePay - Mobile payment solution
Cards - Visa, MasterCard, Dankort
Betalingsservice - Direct debit for private customers
Leverandørservice - Direct debit for businesses

Date Formats

Input dates: YYYY-MM-DD
Response dates: YYYY-MM-DDTHH:mm:ssZ

Getting Help

API Testing: Use our interactive documentation
Support: Contact us through our website
Examples: Check our integration examples

Documentation Sections

Authentication & Setup

Learn how to obtain and use your API key, understand request headers, and get started with the API.

Customers

Manage customer information, create payment agreements, and handle customer data.

Orders

Create payment flows, manage user interactions, and handle payment agreements.

Invoices

Generate invoices, track payment status, and manage invoice lifecycle.

Invoice Extensions

Configure invoice delivery behavior and payment flow overrides using the Invoice Delivery Extension.

Invoice Sending

Configure how invoices are sent to customers using different channels and scheduling options.

Invoice Refunds

Process refunds for paid invoices using the refund endpoint.

Instant Payments

Process immediate card payments when creating invoices using the schedulePayment=Instant parameter.

Payments

View payment history, process refunds, and track payment status.

Agreements

Manage recurring payment instruments and payment agreements.

Payment Sets

Access aggregated payment information for reconciliation and reporting.

Deliveries

Upload files for batch processing and file-based integrations.

Bill Deliveries

Upload bill files for batch processing using the FarPay Bill format, including Overførselsservice (OS) bills.

Settings & Metadata

Access API version information and system metadata.

Examples

Complete integration examples and use case scenarios.

Release Notes

Latest updates and changes to the API.