For AI agents: visit https://developer.farpay.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Recipes
API Reference
Support
v2
Log In
API Reference
Search
Log In
v2
Recipes
API Reference
Support
capture-orders
JUMP TO
FARPAY DOCS
How to use the API
Available countries
Test Cards in FarPay
Agreements
agreements
Customers
customers
Deliveries
Bill Deliveries
Get Payments
Inbound deliveries
Bill
Extensible content
Minimal payload
General fields
Reminder
Delivery method
Language code
Payment method
Template
Sending invoice channel
Payout
Embedding
Full payload
deliveries
payout-deliveries
Invoices
Insert invoice document
Instant Payments
Invoice Extensions
Invoice Refunds
Invoice Sending
invoices
Orders
Payments
payment-sets
payments
Payment Sets
Webhooks
Payment Webhook
Agreement webhook
order-webhooks
agreement-webhooks
payment-webhooks
webhooks
authentication
cancel-orders
capture-orders
examples
release-notes
readme
settings
FarPay API v2
V2Agreements
Get agreements
get
Create agreement
post
Updates agreement
get
Delete agreement
del
V2Customers
Get customers
get
Update customer
put
Insert customer
post
Gets a customer
get
Deletes a customer, based on the customer number.
del
Send signup email
post
V2Deliveries
Get deliveries, that has been sent by API to FarPay
get
Insert delivery with file content
post
Gets a delivery with the file container
get
Set the delivery to Ok
put
V2Invoices
Gets invoice references
get
Insert an invoice
post
Get a single invoice
get
Delete an invoice
del
Update the send invoice status
patch
Get the PDF Invoice
get
Partial or full refund of paid invoice
post
V2Orders
Get orders
get
Update order
put
Insert order
post
Deletes an order based on a token
del
Gets an order
get
Capture an order, that is in PendingCapture state.
get
Cancel an order.
get
V2Payments
Get a list of payment references, based on the client id and client secret. Remark that the invoiceID and the payment dates are mutual exclusive.
get
BETA - Show payment
get
Refund partial or full amount, based on a previous payment.
post
V2PaymentSets
Get a list of paymentsets, based on the presented criteria - PaymentType, fromDate and toDate.
get
Get Payment Set details
get
V2Settings
Gets the version information for the API
get
V2Subscriptions (Deprecated)
Get subscriptions
get
Insert a subscription
post
Insert subscription request
post
Gets a subscription
get
FarPay Reseller API
Merchants
List all reseller merchants.
get
Create a new merchant.
post
Get a single reseller merchant, and all the details
get
Reseller
Get reseller info
get
Powered by
capture-orders
Copy Page
Updated 16 days ago
authentication
Did this page help you?
Yes
No
Updated 16 days ago
authentication
Did this page help you?
Yes
No
