API Reference

Insert an invoice

post
https://api.farpay.io/v2/invoices

Inserts an invoice, based on the Invoice, InvoiceCustomerModel and subsequent InvoiceLine-list.
Get the invoice paid instantly by defining the scheduleParameter as an instant payment. If the customer does
not have a valid Card agreement, the instant payment will fail, and the request will be rejected.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Enumeration of options to process the payment - default is not set. For forcing the payment
to be activated right away, state "Instant"

Allowed:
int32

Optional reference to a paid invoice, that is to be refunded partially or full with a new creditnote

Body Params

The invoice data and subsequent invoice-lines

string
string
required
double
required
double
required
double
required
string
string
date-time
string
date-time
string
Recepient
object
Buyer
object
Destination
object
string
enum
Allowed:
string
string
enum
string
string
string
PdfInvoice
object
PdfAttachments
array of objects
PdfAttachments
InvoiceLines
array of objects
InvoiceLines
string
string
Send
object
string
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

400

The invoice was not received correct

401

apiKey is unauthorized

502

Bad Gateway - PSP or Epay returned with an error code and message

Updated about 1 year ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?