{"swagger":"2.0","info":{"version":"v2","title":"FarPay API v2"},"host":"api.farpay.io","schemes":["https"],"paths":{"/v2/agreements":{"get":{"tags":["V2Agreements"],"summary":"Get agreements","description":"<code>\r\n  <b>Gets a collection of all agreements</b>\r\n            \r\n             PaymentTypes are:\r\n              \"LS\" - Leverandørservice\r\n              \"BS\" - Betalingsservice\r\n              \"Dankort\"\r\n              \"Visa\"\r\n              \"MasterCard\"\r\n              \"MobilePaySubscriptions\" - MobilePay subscriptions\r\n            \r\n             Statuses are:\r\n              \"Ok\" (default) - active agreement\r\n              \"Pending\" - The agreement is being processed.\r\n              \"Cancel\" - The agreement is cancelled\r\n              \"Error\"\r\n             </code>","operationId":"V2Agreements_GetAgreements","consumes":[],"produces":["application/json","application/xml"],"parameters":[{"name":"paymentType","in":"query","description":"Available payments types","required":false,"type":"string"},{"name":"customerNumber","in":"query","description":"","required":false,"type":"string"},{"name":"status","in":"query","description":"Filter the statuses, default is \"Ok\"","required":false,"type":"string"}],"responses":{"401":{"description":"ApiKey is unauthorized"},"204":{"description":"No agreements where found","schema":{"type":"array","items":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Agreements.Agreement"}}}}},"post":{"tags":["V2Agreements"],"summary":"Create agreement","description":"Create an agreement, based on the agreement object. The agreement is returned with status and an ID for later references","operationId":"V2Agreements_CreateAgreement","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"agreement","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Agreements.AgreementCreate"}}],"responses":{"401":{"description":"Unauthorized access"},"400":{"description":"See body for details"}}}},"/v2/agreements/{id}":{"get":{"tags":["V2Agreements"],"summary":"Updates agreement","description":"Agreements are updated asynchronous, meaning that the final state of the update will be available the day after the update.","operationId":"V2Agreements_GetAgreement","consumes":[],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"401":{"description":"apiKey is unauthorized"},"404":{"description":"The agreement was not found"},"200":{"description":"Returns with a list of invoice references","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Agreements.Agreement"}}}},"delete":{"tags":["V2Agreements"],"summary":"Delete agreement","description":"All invoices, that are planed to be paid by this agreement, will be set to be handled\r\nwith the secondary payment instrument FI-Kreditor.","operationId":"V2Agreements_CancelAgreement","consumes":[],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"401":{"description":"apiKey is unauthorized"},"404":{"description":"The agreement was not found"},"200":{"description":"The agreement is marked for deletion","schema":{"type":"object"}}}}},"/v2/customers":{"get":{"tags":["V2Customers"],"summary":"Get customers","description":"Gets a collection of customers, based on optional critieria and paging.\r\nPaging is default set to 100. If more data is needed override of pageSize is needed.","operationId":"V2Customers_Get","consumes":[],"produces":["application/json","application/xml"],"parameters":[{"name":"criteria","in":"query","description":"Adding search criteria to your query. Search on name, customer number, address information","required":false,"type":"string"},{"name":"pageNumber","in":"query","description":"Optional - Paging ability","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"Optional - Paging ability","required":false,"type":"integer","format":"int32"}],"responses":{"401":{"description":"ApiKey is unauthorized"},"404":{"description":"Customers not found"},"200":{"description":"The total list of customers","schema":{"type":"array","items":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Customers.CustomerResponse"}}}}},"put":{"tags":["V2Customers"],"summary":"Update customer","description":"Here are the values that can be updated:\r\n* Name\r\n* Various address info\r\n* AttachPdfInvoice flag\r\n* Customer Language - leave blank when the communication is rendered in the default language of the sender.\r\n* Email","operationId":"V2Customers_UpdateCustomer","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customer","in":"body","description":"Customer updates","required":true,"schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Customers.CustomerRequest"}}],"responses":{"401":{"description":"apiKey is unauthorized"},"403":{"description":"Request not authorized to customer"},"404":{"description":"Customer not found"},"400":{"description":"Bad request - customer payload not parsed"},"200":{"description":"The updated customer","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Customers.CustomerResponse"}}}},"post":{"tags":["V2Customers"],"summary":"Insert customer","description":"Customer is defined by a minimum model, enabling the system\r\nto create an payment instrument (BS, LS, Card, MobilePay)","operationId":"V2Customers_InsertCustomer","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customer","in":"body","required":true,"schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Customers.CustomerInsert"}}],"responses":{"401":{"description":"apiKey is unauthorized"},"400":{"description":"The received customer was malformed or the customer number already exists. Se details in response body"},"200":{"description":"A customer has been created","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Customers.CustomerResponse"}}}}},"/v2/customers/{customerNumber}":{"get":{"tags":["V2Customers"],"summary":"Gets a customer","description":"Based on the customer number, the customer is presented with agreement details if present","operationId":"V2Customers_GetSingleCustomer","consumes":[],"produces":["application/json","application/xml"],"parameters":[{"name":"customerNumber","in":"path","description":"The customer number reference","required":true,"type":"string"}],"responses":{"401":{"description":"apiKey is unauthorized"},"200":{"description":"The customer object with optional agreement details","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Customers.CustomerResponse"}},"404":{"description":"The customer was not found"}}},"delete":{"tags":["V2Customers"],"summary":"Deletes a customer, based on the customer number.","description":"Return different HttpStatusCodes, depending on the outcome of the request.","operationId":"V2Customers_DeleteCustomer","consumes":[],"produces":["application/json"],"parameters":[{"name":"customerNumber","in":"path","description":"The customer number, that identifies the customer","required":true,"type":"string"}],"responses":{"200":{"description":"Customer deleted"},"400":{"description":"Customer number is required"},"404":{"description":"Customer not found"}}}},"/v2/customers/{customerNumber}/agreementRequest":{"post":{"tags":["V2Customers"],"summary":"Send signup email","description":"Sends a signup email to the customer' email address. Where the user can signup for an\r\nautomated payment agreement.","operationId":"V2Customers_SendAgreementSignupToCustomer","consumes":[],"produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"Types available are: \"ls\", \"bs\", \"card\", \"mp\" or \"all\" when you want the customer to select\r\n            between available payment types. Other values are rejected","required":true,"type":"string"},{"name":"customerNumber","in":"path","description":"Your customer reference","required":true,"type":"string"},{"name":"email","in":"query","description":"the destination of the email that is to be sent","required":false,"type":"string"},{"name":"phone","in":"query","description":"Your customer phone number","required":false,"type":"string"},{"name":"currency","in":"query","description":"Currency of the agreement - default is DKK","required":false,"type":"string"}],"responses":{"401":{"description":"apiKey is unauthorized"},"405":{"description":"Method not allowed in types"},"400":{"description":"Invalid type - see body for details"},"404":{"description":"Customer not found"},"200":{"description":"Message sent to customer"},"502":{"description":"Bad gateway - MobilePay specific error"}}}},"/v2/deliveries":{"get":{"tags":["V2Deliveries"],"summary":"Get deliveries, that has been sent by API to FarPay","description":"The list contains references to the delivery, that can be accessed in details by calling the\r\ndeliveries/{id} endpoint.","operationId":"V2Deliveries_GetDeliveries","consumes":[],"produces":["application/json","application/xml"],"parameters":[{"name":"status","in":"query","description":"New, Processing, Ok, Error","required":false,"type":"string","enum":["New","Processing","Ok","Error"]},{"name":"type","in":"query","description":"Specify the delivery type","required":false,"type":"string","enum":["Invoice","Agreement","Payment"]},{"name":"direction","in":"query","description":"CompanyToFarPay, FarPayToCompany","required":false,"type":"string","enum":["CompanyToFarPay","FarPayToCompany"]},{"name":"fromDate","in":"query","description":"","required":false,"type":"string","format":"date-time"},{"name":"toDate","in":"query","description":"","required":false,"type":"string","format":"date-time"}],"responses":{"401":{"description":"ApiKey is unauthorized"},"404":{"description":"No Orders where found"},"200":{"description":"The list of deliveries are presented","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Deliveries.DeliveryReferenceContainer"}}}},"post":{"tags":["V2Deliveries"],"summary":"Insert delivery with file content","description":"The delivery should always contain a file object. It's optional to populate the 'File/Data' property,\r\nbut not the 'File/FileName' property.\r\n            \r\nIf File/Data is empty, then your response will include a property named 'FileUploadUri' for uploading the file itself.\r\nYou'll have 30 min. for uploading your binary file - the link expires after that.\r\nPUT is the only valid request at the 'FileUploadUri' with a binary file within the request body.\r\nThe header <b>'x-ms-blob-type: blockblob'</b> is required.\r\nOnce the file has been uploaded the delivery will be processed.","operationId":"V2Deliveries_InsertDelivery","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"delivery","in":"body","required":true,"schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Deliveries.Delivery"}}],"responses":{"401":{"description":"apiKey is unauthorized"},"400":{"description":""},"200":{"description":"The delivery reference for status and further elaboration.","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Deliveries.DeliveryReference"}}}}},"/v2/deliveries/{id}":{"get":{"tags":["V2Deliveries"],"summary":"Gets a delivery with the file container","description":"Data in the file object is presented as XML content","operationId":"V2Deliveries_GetDelivery","consumes":[],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"},{"name":"includeFile","in":"query","required":true,"type":"boolean"}],"responses":{"401":{"description":"apiKey is unauthorized"},"404":{"description":"The order was not found"},"200":{"description":"The delivery response object","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Deliveries.DeliveryResponse"}}}},"put":{"tags":["V2Deliveries"],"summary":"Set the delivery to Ok","operationId":"V2Deliveries_UpdateDelivery","consumes":["application/json","application/xml"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"delivery ID","required":true,"type":"integer","format":"int32"},{"name":"delivery","in":"body","description":"the delivery model, containing the statuscode. File is not needed","required":true,"schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Deliveries.DeliveryUpdate"}}],"responses":{"401":{"description":"ApiKey is unauthorized"},"404":{"description":"Delivery not found"},"403":{"description":"Not able to change the status"},"200":{"description":"Delivery is set to Ok","schema":{"type":"object"}}}}},"/v2/invoices":{"get":{"tags":["V2Invoices"],"summary":"Gets invoice references","description":"Gets a collection of InvoiceReferences. Optional criteria for filtering are from and to date.\r\nThe Dateformat is yyyy-MM-dd (e.g. \"2017-05-31\") for the 31th of May 2017.\r\nPayment status will be","operationId":"V2Invoices_GetInvoices","consumes":[],"produces":["application/json","application/xml"],"parameters":[{"name":"invoiceNumber","in":"query","description":"optional invoicenumber to find a specific invoice","required":false,"type":"string"},{"name":"customerNumber","in":"query","description":"optional filter for getting all invoices for a specific customer","required":false,"type":"string"},{"name":"deliveryId","in":"query","description":"optional delivery id, that filters all invoices, that have been created\r\nbased on that specific deliveryId - There can be one or many invoices.","required":false,"type":"integer","format":"int32"},{"name":"fromPaymentDueDate","in":"query","description":"optional from date with format: yyyy-MM-dd","required":false,"type":"string"},{"name":"toPaymentDueDate","in":"query","description":"optional to date with format: yyyy-MM-dd","required":false,"type":"string"},{"name":"paymentStatus","in":"query","description":"optional filter on payment the paymentstate.","required":false,"type":"string","enum":["NotPaid","Paid","Scheduled","Pending","Rejected","Chargeback","PaymentFailed","NA"]}],"responses":{"400":{"description":"Date must be formatted correct, see body for details"},"401":{"description":"apiKey is unauthorized"},"200":{"description":"Get an enumeration of invoiceReferences","schema":{"type":"array","items":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.InvoiceReference"}}},"204":{"description":"Empty result","schema":{"type":"array","items":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.InvoiceReference"}}}}},"post":{"tags":["V2Invoices"],"summary":"Insert an invoice","description":"Inserts an invoice, based on the Invoice, InvoiceCustomerModel and subsequent InvoiceLine-list.\r\nGet the invoice paid instantly by defining the scheduleParameter as an instant payment. If the customer does\r\nnot have a valid Card agreement, the instant payment will fail, and the request will be rejected.","operationId":"V2Invoices_InsertInvoice","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"invoiceRequest","in":"body","description":"The invoice data and subsequent invoice-lines","required":true,"schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.InvoiceRequest"}},{"name":"schedulePayment","in":"query","description":"Enumeration of options to process the payment - default is not set. For forcing the payment\r\n            to be activated right away, state \"Instant\"","required":false,"type":"string","enum":["Default","Automatic","Manual","Instant"]},{"name":"refundInvoiceId","in":"query","description":"Optional reference to a paid invoice, that is to be refunded partially or full with a new creditnote","required":false,"type":"integer","format":"int32"}],"responses":{"400":{"description":"The invoice was not received correct"},"401":{"description":"apiKey is unauthorized"},"502":{"description":"Bad Gateway - PSP or Epay returned with an error code and message"},"200":{"description":"Returns with a list of invoice references","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.InvoiceReference"}}}}},"/v2/invoices/{id}":{"get":{"tags":["V2Invoices"],"summary":"Get a single invoice","operationId":"V2Invoices_GetInvoice","consumes":[],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"invoice ID","required":true,"type":"integer","format":"int32"}],"responses":{"400":{"description":"The invoice was not received correct"},"401":{"description":"apiKey is unauthorized"},"404":{"description":"Invoice not found"},"200":{"description":"Returns an invoice","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.InvoiceResponse"}}}},"delete":{"tags":["V2Invoices"],"summary":"Delete an invoice","description":"When the invoice is marked as deleted, the invoice will be absent from the portal and from the API.","operationId":"V2Invoices_DeleteInvoice","consumes":[],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"your invoice reference - Remark...it is not the invoicenumber","required":true,"type":"integer","format":"int32"}],"responses":{"401":{"description":"apiKey is unauthorized"},"404":{"description":"The invoice was not found"},"403":{"description":"Unauthorized reference to invoice"},"200":{"description":"The invoice was successfully deleted","schema":{"type":"object"}}}},"patch":{"tags":["V2Invoices"],"summary":"Update the send invoice status","description":"In order to resend he invoice, set the status to <b>Queue</b>. Otherwise mark the invoice\r\nin the wanted state.<br />\r\nNote that the queued invoices will be moved to another state, as soon as the invoice is processed, which\r\ncan result in a immediate update of the invoice, since it is process momentarily after this call. Hence\r\nthe returned invoice reference will hold the new status.","operationId":"V2Invoices_UpdateInvoice","consumes":["application/json","application/xml"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"The invoice reference","required":true,"type":"integer","format":"int32"},{"name":"invoiceUpdate","in":"body","description":"The invoice send reference","required":true,"schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.InvoiceUpdateRequest"}}],"responses":{"401":{"description":"apiKey is unauthorized"},"404":{"description":"Invoice not found"},"200":{"description":"The invoice will be sent right away or scheduled.","schema":{"type":"object"}}}}},"/v2/invoices/{id}/download":{"get":{"tags":["V2Invoices"],"summary":"Get the PDF Invoice","description":"The invoice is downloaded, and marked as received as downloaded within the FarPay system. If the invoice is\r\ndue, and the system is configured to be sending reminders, the reminder is sent instead.","operationId":"V2Invoices_DownloadPdfInvoice","consumes":[],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"the reference to the invoice","required":true,"type":"integer","format":"int32"}],"responses":{"404":{"description":"The invoice was not found"},"204":{"description":"The invoice has no PDF document","schema":{"type":"object"}},"200":{"description":"The PDF document was successfully downloaded","schema":{"type":"object"}}}}},"/v2/invoices/{id}/refund":{"post":{"tags":["V2Invoices"],"summary":"Partial or full refund of paid invoice","description":"Refunds can be refunded as long as paidAmount &gt; 0.\r\nEach refund is registered with amount, currency and timestamp.","operationId":"V2Invoices_RefundInvoice","consumes":["application/json","application/xml"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Invoice reference","required":true,"type":"integer","format":"int32"},{"name":"refundRequest","in":"body","description":"Refund container - holds the amount. When amount is not set, full refund occurs","required":true,"schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.RefundRequest"}}],"responses":{"404":{"description":"The invoice was not found"},"400":{"description":"No amount to refund, or the refund amount is too high"},"502":{"description":"Gateway errors, in execution of the refund"}}}},"/v2/orders":{"get":{"tags":["V2Orders"],"summary":"Get orders","description":"Gets a list orders.","operationId":"V2Orders_Get","consumes":[],"produces":["application/json"],"parameters":[{"name":"status","in":"query","description":"Order status filter","required":false,"type":"string","enum":["New","PendingPayment","PendingCustomerNumber","Ok","Error","Canceled","Expired"]},{"name":"externalId","in":"query","description":"get a single order, based on your external ID","required":false,"type":"string"},{"name":"invoiceId","in":"query","description":"get a list of orders, based on the invoice (ID)","required":false,"type":"string"},{"name":"orderId","in":"query","description":"get a list (of one order), given an Order.ID","required":false,"type":"string"}],"responses":{"401":{"description":"ApiKey is unauthorized"},"404":{"description":"No Orders where found"},"200":{"description":"The total list of customers","schema":{"type":"array","items":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Orders.OrderResponse"}}}}},"put":{"tags":["V2Orders"],"summary":"Update order","description":"Here are the values that can be updated in the customer node:\r\n* Customer number\r\n* Name\r\n* Email","operationId":"V2Orders_UpdateOrder","consumes":["application/json","application/xml"],"produces":["application/json"],"parameters":[{"name":"order","in":"body","description":"Order updates","required":true,"schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Orders.OrderUpdateCustomer"}}],"responses":{"401":{"description":"apiKey is unauthorized"},"400":{"description":"The order was not received, or malformed"},"404":{"description":"Order not found"},"403":{"description":"Unauthorized access to order"},"204":{"description":"The requested order was not found","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Orders.OrderResponse"}},"200":{"description":"The updated customer","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Orders.OrderResponse"}}}},"post":{"tags":["V2Orders"],"summary":"Insert order","description":"","operationId":"V2Orders_InsertOrder","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"order","in":"body","required":true,"schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Orders.OrderRequest"}}],"responses":{"401":{"description":"apiKey is unauthorized"},"400":{"description":""},"200":{"description":"The newly created order object","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Orders.OrderResponse"}}}},"delete":{"tags":["V2Orders"],"summary":"Deletes an order based on a token","operationId":"V2Orders_DeleteOrder","consumes":[],"produces":["application/json"],"parameters":[{"name":"token","in":"query","description":"Identifies an order with a token","required":true,"type":"string"}],"responses":{"200":{"description":"The order has been deleted","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Orders.OrderResponse"}},"401":{"description":"Unauthorized access"},"404":{"description":"The order was not found"}}}},"/v2/orders/{token}":{"get":{"tags":["V2Orders"],"summary":"Gets an order","description":"","operationId":"V2Orders_GetSingleOrder","consumes":[],"produces":["application/json"],"parameters":[{"name":"token","in":"path","description":"The token referencing the order","required":true,"type":"string"}],"responses":{"401":{"description":"apiKey is unauthorized"},"404":{"description":"The order was not found"},"200":{"description":"The order object","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Orders.OrderResponse"}}}}},"/v2/orders/{token}/capture":{"get":{"tags":["V2Orders"],"summary":"Capture an order, that is in PendingCapture state.","operationId":"V2Orders_CaptureOrder","consumes":[],"produces":["application/json"],"parameters":[{"name":"token","in":"path","description":"identify the order","required":true,"type":"string"}],"responses":{"200":{"description":"The order has been captured, and is now processed","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Orders.OrderResponse"}},"401":{"description":"Unauthorized access"},"404":{"description":"The order could not be found"},"400":{"description":"Bad request, see violations returned"}}}},"/v2/orders/{token}/cancel":{"get":{"tags":["V2Orders"],"summary":"Cancel an order.","description":"When cancelled, all associated transactions can be rolled back, as long as the order\r\nhas not reach the finale Ok state.\r\nThe cancel will cancel the subsequent payment-mandates and authorizations.\r\nAs the cancel is performed from the API, the state of the order will change to PendingCancel instantly,\r\nand will forward transition to Cancelled, when the subsequent cancellation events have completed.","operationId":"V2Orders_CancelOrder","consumes":[],"produces":["application/json"],"parameters":[{"name":"token","in":"path","description":"identify the order","required":true,"type":"string"}],"responses":{"200":{"description":"The order has been captured, and is now processed","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Orders.OrderResponse"}},"401":{"description":"Unauthorized access"},"404":{"description":"The order could not be found"},"400":{"description":"Bad request, see violations returned"}}}},"/v2/payments":{"get":{"tags":["V2Payments"],"summary":"Get a list of payment references, based on the client id and client secret.\r\nRemark that the invoiceID and the payment dates are mutual exclusive.","description":"The payment types are:\r\n    FI = Paymentslip.\r\n    BS = Betalings service\r\n    LS = Leverandørservice\r\n    MPS = MobilePay Subscriptions\r\n    MPI = MobilePay Invoice\r\n    MRV = MínRokning Vinna\r\n    MRP = MínRokning Privat\r\n    card types are self explanatory.","operationId":"V2Payments_GetPayments","consumes":[],"produces":["application/json","application/xml"],"parameters":[{"name":"paymentDateFrom","in":"query","description":"The start invoice due date - Format is: 'YYYY-MM-DD'","required":false,"type":"string","format":"date-time"},{"name":"paymentDateTo","in":"query","description":"The end invoice due date - Format is: 'YYYY-MM-DD'","required":false,"type":"string","format":"date-time"},{"name":"invoiceId","in":"query","description":"Find all payments for a specific invoice with invoiceID","required":false,"type":"integer","format":"int32"},{"name":"refundId","in":"query","description":"Find the payment that is associated with the refundID","required":false,"type":"integer","format":"int32"},{"name":"paymentReference","in":"query","description":"Own reference","required":false,"type":"string"},{"name":"paymentType","in":"query","description":"Filter payment types: FI, BS, LS, Visa, MasterCard, Dankort, MPS, MPI, MRV, MRP","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The number of payments to retrieve - Default value is 100","required":false,"type":"integer","format":"int32"},{"name":"page","in":"query","description":"The page number - a 0-based page number, for retrieving larger quantities in chumps","required":false,"type":"integer","format":"int32"}],"responses":{"401":{"description":"apiKey is unauthorized"},"400":{"description":"Format date according to documentation 'YYYY-MM-DD' and let fromDate be less or equal toDate"},"204":{"description":"No payment status for invoices where found","schema":{"type":"array","items":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Payments.PaymentReferenceContainer"}}},"200":{"description":"Return a result with an enumeration of invoice' PaymentReferences","schema":{"type":"array","items":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Payments.PaymentReferenceContainer"}}}}}},"/v2/payments/{paymentId}":{"get":{"tags":["V2Payments"],"summary":"BETA - Show payment","description":"Show a specific payment, based on the invoiceId and the paymentId","operationId":"V2Payments_GetPayment","consumes":[],"produces":["application/json","application/xml"],"parameters":[{"name":"paymentId","in":"path","description":"unique reference to subsequent payments","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"A refunded payment","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Payments.PaymentReferenceContainer"}},"401":{"description":"apiKey is unauthorized"},"403":{"description":"Invoice not authorized"},"404":{"description":"Invoice not found"},"400":{"description":"Various errors, error codes are described in the code block"}}}},"/v2/payments/{paymentId}/refund":{"post":{"tags":["V2Payments"],"summary":"Refund partial or full amount, based on a previous payment.","description":"The amount cannot exceed the original amount, from the payment. But it can be refunded in\r\na small amount and repeated until there is nothing left to refund.","operationId":"V2Payments_RefundPayment","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"paymentId","in":"path","description":"The payment that is to be refunded","required":true,"type":"integer","format":"int32"},{"name":"refundRequest","in":"body","description":"Refund request","required":true,"schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Payments.PaymentRefundRequest"}}],"responses":{"200":{"description":"A refunded payment","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Payments.PaymentReferenceContainer"}},"401":{"description":"apiKey is unauthorized"},"400":{"description":"Bad request, various errors, see error codes\r\n            \r\n             HTTP_ERROR 400 details described below\r\n            \r\n             Error codes and description\r\n             -----------------------------\r\n             20012: No amount to refund\r\n             20013: No payments received\r\n             20014: Payment was not found\r\n             20050: Payment is not refundable\r\n            \r\n             The other errors are sent directly to the API\r\n             20040::PSP: nnnn:message from psp |Acquire: nnnn:message from acquirer"},"502":{"description":"Bad gateway. Error communicating with acquirer or merchant. Detailed error description is sent with\r\nerrorcode:errorDescription"}}}},"/v2/paymentsets":{"get":{"tags":["V2PaymentSets"],"summary":"Get a list of paymentsets, based on the presented criteria - PaymentType, fromDate and toDate.","description":"To retrieve a single day, please put the same dates in fromDate and toDate values,\r\nformatted YYYY-MM-DD.","operationId":"V2PaymentSets_GetPaymentSets","consumes":[],"produces":["application/json","application/xml"],"parameters":[{"name":"fromDate","in":"query","description":"The YYYY-MM-DD format will result in a timestamp at the beginning of the day - Otherwise add timestamp YYYY-MM-DD HH:MI:SS","required":false,"type":"string","format":"date-time"},{"name":"toDate","in":"query","description":"The YYYY-MM-DD format will result in a timestamp that is the last second of the day - Otherwise add timestamp YYYY-MM-DD HH:MI:SS","required":false,"type":"string","format":"date-time"}],"responses":{"401":{"description":"apiKey is unauthorized"},"400":{"description":"Format date according to documentation - 'YYYY-MM-DD', and keep the fromDate before or equal to the toDate"},"200":{"description":"List of PaymentSetReferences are returned","schema":{"type":"array","items":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.PaymentSets.PaymentSetReference"}}},"204":{"description":"No payments where found","schema":{"type":"array","items":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.PaymentSets.PaymentSetReference"}}}}}},"/v2/paymentsets/{paymentSetId}":{"get":{"tags":["V2PaymentSets"],"summary":"Get Payment Set details","description":"With the paymentSet reference, you will get a collection of payments that\r\nwhere received a specific day, and hold a specific payment type.","operationId":"V2PaymentSets_GetPaymentSet","consumes":[],"produces":["application/json"],"parameters":[{"name":"paymentSetId","in":"path","description":"the paymentSet reference","required":true,"type":"integer","format":"int32"}],"responses":{"401":{"description":"apiKey is unauthorized"},"200":{"description":"Gets a single PaymentReference","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.PaymentSets.PaymentSet"}}}}},"/v2/settings/metadata/version":{"get":{"tags":["V2Settings"],"summary":"Gets the version information for the API","operationId":"V2Settings_Version","consumes":[],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Settings.VersionDetails"}}}}},"/v2/subscriptions":{"get":{"tags":["V2Subscriptions"],"summary":"Get subscriptions","description":"Use the filter on subscriptionStatus and combine it with searchCriteria when you want to narrow the request","operationId":"V2Subscriptions_GetSubscriptions","consumes":[],"produces":["application/json","application/xml"],"parameters":[{"name":"subscriptionStatus","in":"query","description":"Optional value, that is default set to \"Active\" -\r\n            Valid values are:\r\n            * \"PendingApproval\"\r\n            * \"NotApproved\"\r\n            * \"Active\"\r\n            * \"Neglected\"\r\n            * \"Canceled\"","required":false,"type":"string"},{"name":"searchCriteria","in":"query","description":"Filter customer names or customer number","required":false,"type":"string"}],"responses":{"401":{"description":"apiKey is unauthorized"},"403":{"description":"unauthorized request"},"204":{"description":"No subscriptions available","schema":{"type":"array","items":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Subscriptions.SubscriptionReference"}}},"200":{"description":"List of subscriptions returned","schema":{"type":"array","items":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Subscriptions.SubscriptionReference"}}}}},"post":{"tags":["V2Subscriptions"],"summary":"Insert a subscription","description":"Based on a small subscription model, a new subscription is inserted into the FarPay.","operationId":"V2Subscriptions_InsertSubscription","consumes":["application/json","application/xml"],"produces":["application/json"],"parameters":[{"name":"subscription","in":"body","description":"The subscription model, containing information regarding: Subscription, SubscriptionPlan and Customer","required":true,"schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Subscriptions.SubscriptionRequest"}}],"responses":{"401":{"description":"apiKey is unauthorized"},"400":{"description":"Malformed request"},"200":{"description":"The subscription was successfully created","schema":{"type":"object"}}}}},"/v2/subscriptions/request":{"post":{"tags":["V2Subscriptions"],"summary":"Insert subscription request","description":"A subscription request, is a preliminary type, to send an request into\r\nFarPay, and later associate the request to strong types such as customer\r\nand plan.\r\nFor test purposes, mode=\"test\", can be set. Afterwards the method will return\r\nwith an registration of a single payment or with a subscription plan registration.","operationId":"V2Subscriptions_InsertSubscriptionRequestCard","consumes":["application/json","application/xml"],"produces":["application/json"],"parameters":[{"name":"subscriptionRequest","in":"body","description":"The subscription request details","required":true,"schema":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Subscriptions.SubscriptionRequest"}}],"responses":{"400":{"description":"Bad formed object - see details"},"403":{"description":"There is no card agreement available"},"200":{"description":"Get a details for a single subscription","schema":{"type":"object"}},"401":{"description":"apiKey is unauthorized"}}}},"/v2/subscriptions/{id}":{"get":{"tags":["V2Subscriptions"],"summary":"Gets a subscription","description":"Retrieves the subscription, the associated customer, and the general subscription plan, that this\r\nsubscription is based on.","operationId":"V2Subscriptions_GetSubscription","consumes":[],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Subscription id","required":true,"type":"integer","format":"int32"}],"responses":{"401":{"description":"apiKey is unauthorized"},"400":{"description":"The subscription was not found"},"200":{"description":"Get a details for a single subscription","schema":{"type":"object"}}}}}},"definitions":{"FarPay.FrontEnd.Models.v2.Agreements.Agreement":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Type":{"type":"string"},"Status":{"type":"string"},"CustomerNumber":{"type":"string"},"PayerID":{"type":"string"},"Details":{"type":"string"},"StartDate":{"format":"date-time","type":"string"},"ExpireDate":{"format":"date-time","type":"string"}}},"FarPay.FrontEnd.Models.v2.Agreements.AgreementCreate":{"type":"object","properties":{"BankRegNumber":{"type":"string"},"BankAccountNumber":{"type":"string"},"DebitorGroupNumber":{"type":"string"},"Id":{"format":"int32","type":"integer"},"Type":{"type":"string"},"Status":{"type":"string"},"CustomerNumber":{"type":"string"},"PayerID":{"type":"string"},"Details":{"type":"string"},"StartDate":{"format":"date-time","type":"string"},"ExpireDate":{"format":"date-time","type":"string"}}},"FarPay.FrontEnd.Models.v2.Customers.CustomerResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Created":{"format":"date-time","type":"string"},"Agreement":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Agreements.AgreementContainer"},"ExternalId":{"type":"string"},"CustomerNumber":{"type":"string"},"Name":{"type":"string"},"PoBox":{"type":"string"},"Email":{"type":"string"},"Street":{"type":"string"},"AdditionalStreet":{"type":"string"},"HouseNumber":{"type":"string"},"PostCode":{"type":"string"},"City":{"type":"string"},"PhoneNumber":{"type":"string"},"Country":{"type":"string"},"AttachPdfInvoice":{"type":"boolean"},"Language":{"enum":["English","Danish","Faroese","Norwegian","Greenlandish"],"type":"string"},"CompanyNo":{"type":"string"},"Gln":{"type":"string"}}},"FarPay.FrontEnd.Models.v2.Agreements.AgreementContainer":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Type":{"type":"string"},"StartDate":{"format":"date-time","type":"string"},"ExpireDate":{"format":"date-time","type":"string"},"Details":{"type":"string"},"Status":{"type":"string"}}},"FarPay.FrontEnd.Models.v2.Customers.CustomerInsert":{"type":"object","properties":{"CustomerNumber":{"type":"string"},"CompanyNo":{"type":"string"},"Gln":{"type":"string"},"Name":{"type":"string"},"Email":{"type":"string"},"PhoneNumber":{"type":"string"},"PoBox":{"type":"string"},"Street":{"type":"string"},"AdditionalStreet":{"type":"string"},"HouseNumber":{"type":"string"},"PostCode":{"type":"string"},"City":{"type":"string"},"Country":{"type":"string"},"Created":{"format":"date-time","type":"string"},"AttachPdfInvoice":{"type":"boolean"},"Language":{"enum":["English","Danish","Faroese","Norwegian","Greenlandish"],"type":"string"}}},"FarPay.FrontEnd.Models.v2.Customers.CustomerRequest":{"type":"object","properties":{"CustomerNumber":{"type":"string"},"Name":{"type":"string"},"PoBox":{"type":"string"},"Email":{"type":"string"},"Street":{"type":"string"},"AdditionalStreet":{"type":"string"},"HouseNumber":{"type":"string"},"PostCode":{"type":"string"},"City":{"type":"string"},"PhoneNumber":{"type":"string"},"Country":{"type":"string"},"AttachPdfInvoice":{"type":"boolean"},"Language":{"enum":["English","Danish","Faroese","Norwegian","Greenlandish"],"type":"string"},"CompanyNo":{"type":"string"},"Gln":{"type":"string"}}},"FarPay.FrontEnd.Models.v2.Deliveries.DeliveryReferenceContainer":{"type":"object","properties":{"DeliveryReferences":{"type":"array","items":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Deliveries.DeliveryReference"}},"Count":{"format":"int32","type":"integer"}}},"FarPay.FrontEnd.Models.v2.Deliveries.DeliveryReference":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Created":{"format":"date-time","type":"string"},"DeliveryType":{"type":"string"},"DeliveryStatus":{"type":"string"},"ErrorMessage":{"type":"string"},"FileUploadUri":{"type":"string"}}},"FarPay.FrontEnd.Models.v2.Deliveries.Delivery":{"type":"object","properties":{"DeliveryType":{"type":"string"},"DeliveryFormat":{"type":"string"},"File":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Deliveries.File"}}},"FarPay.FrontEnd.Models.v2.Deliveries.File":{"type":"object","properties":{"Filename":{"type":"string"},"Data":{"type":"string"}}},"FarPay.FrontEnd.Models.v2.Deliveries.DeliveryResponse":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"DeliveryFormat":{"type":"string"},"DeliveryStatus":{"type":"string"},"ErrorMessage":{"type":"string"},"DeliveryType":{"type":"string"},"InvoiceNumber":{"type":"string"},"File":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Deliveries.File"}}},"FarPay.FrontEnd.Models.v2.Deliveries.DeliveryUpdate":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"DeliveyStatus":{"type":"string"},"DeliveryType":{"type":"string"},"DeliveryFormat":{"type":"string"},"File":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Deliveries.File"}}},"FarPay.FrontEnd.Models.v2.Invoices.InvoiceReference":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"Token":{"type":"string"},"Created":{"format":"date-time","type":"string"},"InvoiceNumber":{"type":"string"},"PaymentDueDate":{"format":"date-time","type":"string"},"InvoiceAmount":{"format":"double","type":"number"},"ToBePaidAmount":{"format":"double","type":"number"},"PaymentStatus":{"enum":["NotPaid","Paid","Scheduled","Pending","Rejected","Chargeback","PaymentFailed","NA"],"type":"string"},"PaymentReferenceStatus":{"enum":["Ok","InstantPaymentNotPossible","AutomaticPaymentNotPossible"],"type":"string"},"PaymentType":{"type":"string"},"PaymentDetails":{"type":"string"},"InvoiceTypeCode":{"type":"string"},"AgreementType":{"type":"string"},"ErrorDescription":{"type":"string"},"Send":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.SendResponseContainer"},"MarkedAsPaid":{"format":"date-time","type":"string"}}},"FarPay.FrontEnd.Models.v2.Invoices.SendResponseContainer":{"type":"object","properties":{"SentDate":{"format":"date-time","type":"string"},"ErrorCode":{"format":"int32","type":"integer"},"ErrorDescription":{"type":"string"},"Channel":{"type":"string"},"Status":{"type":"string"},"ScheduleSendDate":{"format":"date-time","type":"string"},"ToAddress":{"type":"string"},"Note":{"type":"string"}}},"FarPay.FrontEnd.Models.v2.Invoices.InvoiceRequest":{"required":["InvoiceDate","InvoiceAmount","TaxAmount","ToBePaidAmount"],"type":"object","properties":{"InvoiceTypeCode":{"type":"string"},"InvoiceDate":{"type":"string"},"InvoiceAmount":{"format":"double","type":"number"},"TaxAmount":{"format":"double","type":"number"},"ToBePaidAmount":{"format":"double","type":"number"},"Ean":{"type":"string"},"InvoiceNote":{"type":"string"},"InvoiceWasPaidManually":{"format":"date-time","type":"string"},"InvoiceNumber":{"type":"string"},"PaymentDueDate":{"format":"date-time","type":"string"},"Currency":{"type":"string"},"Recepient":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.Recepient"},"Buyer":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.ApiPartyInfo"},"Destination":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.ApiPartyInfo"},"SchedulePayment":{"enum":["Default","Automatic","Manual","Instant"],"type":"string"},"PaymentReference":{"type":"string"},"PaymentStatus":{"enum":["NotPaid","Paid","Scheduled","Pending","Rejected","Chargeback","PaymentFailed","NA"],"type":"string"},"PaymentType":{"type":"string"},"InvoiceStatus":{"type":"string"},"PaymentRejectedBy":{"type":"string"},"PdfInvoice":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.PdfFile"},"PdfAttachments":{"type":"array","items":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.PdfFile"}},"InvoiceLines":{"type":"array","items":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.InvoiceLineRequest"}},"TextLines":{"type":"string"},"Template":{"type":"string"},"Send":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.SendRequestContainer"},"OrderToken":{"type":"string"}}},"FarPay.FrontEnd.Models.v2.Invoices.Recepient":{"required":["CustomerNumber"],"type":"object","properties":{"CustomerNumber":{"type":"string"},"CompanyNo":{"type":"string"},"Gln":{"type":"string"},"Name":{"type":"string"},"Email":{"type":"string"},"Street":{"type":"string"},"PostCode":{"type":"string"},"PoBox":{"type":"string"},"City":{"type":"string"},"Country":{"type":"string"},"ContactId":{"type":"string"},"ContactName":{"type":"string"},"ContactPhone":{"type":"string"},"ContactEmail":{"type":"string"}}},"FarPay.FrontEnd.Models.v2.Invoices.ApiPartyInfo":{"type":"object","properties":{"CompanyNo":{"type":"string"},"Gln":{"type":"string"},"Name":{"type":"string"},"Street":{"type":"string"},"PostCode":{"type":"string"},"City":{"type":"string"},"Country":{"type":"string"},"ContactInformation":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.ContactInformation"}}},"FarPay.FrontEnd.Models.v2.Invoices.PdfFile":{"type":"object","properties":{"Filename":{"type":"string"},"Data":{"type":"string"}}},"FarPay.FrontEnd.Models.v2.Invoices.InvoiceLineRequest":{"type":"object","properties":{"LineNumber":{"format":"int32","type":"integer"},"ProductNumber":{"type":"string"},"Description":{"type":"string"},"BasePrice":{"format":"double","type":"number"},"Quantity":{"format":"double","type":"number"},"UnitCode":{"type":"string"},"DiscountRate":{"format":"double","type":"number"},"DiscountedPrice":{"format":"double","type":"number"},"TaxRate":{"format":"double","type":"number"},"TaxAmount":{"format":"double","type":"number"},"Amount":{"format":"double","type":"number"}}},"FarPay.FrontEnd.Models.v2.Invoices.SendRequestContainer":{"type":"object","properties":{"Channel":{"type":"string"},"Status":{"type":"string"},"ScheduleSendDate":{"format":"date-time","type":"string"},"ToAddress":{"type":"string"},"Note":{"type":"string"}}},"FarPay.FrontEnd.Models.v2.Invoices.ContactInformation":{"type":"object","properties":{"Identifier":{"type":"string"},"Name":{"type":"string"},"Phone":{"type":"string"},"Email":{"type":"string"},"Role":{"type":"string"}}},"FarPay.FrontEnd.Models.v2.Invoices.InvoiceResponse":{"required":["InvoiceDate","InvoiceAmount","TaxAmount","ToBePaidAmount"],"type":"object","properties":{"Send":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.SendResponseContainer"},"Id":{"format":"int32","type":"integer"},"Token":{"type":"string"},"PaymentDetails":{"type":"string"},"MarkedAsPaid":{"format":"date-time","type":"string"},"Created":{"format":"date-time","type":"string"},"InvoiceTypeCode":{"type":"string"},"InvoiceDate":{"type":"string"},"InvoiceAmount":{"format":"double","type":"number"},"TaxAmount":{"format":"double","type":"number"},"ToBePaidAmount":{"format":"double","type":"number"},"Ean":{"type":"string"},"InvoiceNote":{"type":"string"},"InvoiceWasPaidManually":{"format":"date-time","type":"string"},"InvoiceNumber":{"type":"string"},"PaymentDueDate":{"format":"date-time","type":"string"},"Currency":{"type":"string"},"Recepient":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.Recepient"},"Buyer":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.ApiPartyInfo"},"Destination":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.ApiPartyInfo"},"SchedulePayment":{"enum":["Default","Automatic","Manual","Instant"],"type":"string"},"PaymentReference":{"type":"string"},"PaymentStatus":{"enum":["NotPaid","Paid","Scheduled","Pending","Rejected","Chargeback","PaymentFailed","NA"],"type":"string"},"PaymentType":{"type":"string"},"InvoiceStatus":{"type":"string"},"PaymentRejectedBy":{"type":"string"},"PdfInvoice":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.PdfFile"},"PdfAttachments":{"type":"array","items":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.PdfFile"}},"InvoiceLines":{"type":"array","items":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.InvoiceLineRequest"}},"TextLines":{"type":"string"},"Template":{"type":"string"},"OrderToken":{"type":"string"}}},"FarPay.FrontEnd.Models.v2.Invoices.InvoiceUpdateRequest":{"type":"object","properties":{"MarkedAsPaid":{"format":"date-time","type":"string"},"Send":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Invoices.SendRequestContainer"}}},"FarPay.FrontEnd.Models.v2.Invoices.RefundRequest":{"type":"object","properties":{"InvoiceId":{"format":"int32","type":"integer"},"InvoiceNumber":{"type":"string"},"Text":{"type":"string"},"Amount":{"format":"double","type":"number"}}},"FarPay.FrontEnd.Models.v2.Orders.OrderResponse":{"type":"object","properties":{"Status":{"type":"string"},"CaptureRequested":{"format":"date-time","type":"string"},"Token":{"type":"string"},"ExternalID":{"type":"string"},"AcceptUrl":{"type":"string"},"CancelUrl":{"type":"string"},"CallbackUrl":{"type":"string"},"UserInputUrl":{"type":"string"},"Domain":{"type":"string"},"Lang":{"type":"string"},"PaymentTypes":{"type":"string"},"Agreement":{"format":"int32","type":"integer"},"Attributes":{"type":"object"},"Customer":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Orders.OrderCustomer"},"Payment":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Orders.OrderPayment"},"Created":{"format":"date-time","type":"string"}}},"FarPay.FrontEnd.Models.v2.Orders.OrderCustomer":{"type":"object","properties":{"CustomerNumber":{"type":"string"},"Name":{"type":"string"},"Email":{"type":"string"},"Phone":{"type":"string"},"Street":{"type":"string"},"HouseNumber":{"type":"string"},"PostalCode":{"type":"string"},"PoBox":{"type":"string"},"AdditionalStreet":{"type":"string"},"City":{"type":"string"},"ExternalID":{"type":"string"}}},"FarPay.FrontEnd.Models.v2.Orders.OrderPayment":{"type":"object","properties":{"AutoCapture":{"type":"boolean"},"Amount":{"format":"double","type":"number"},"Currency":{"type":"string"},"Description":{"type":"string"},"Reference":{"type":"string"},"InvoiceId":{"format":"int32","type":"integer"},"InvoiceNumber":{"type":"string"}}},"FarPay.FrontEnd.Models.v2.Orders.OrderRequest":{"type":"object","properties":{"Token":{"type":"string"},"ExternalID":{"type":"string"},"AcceptUrl":{"type":"string"},"CancelUrl":{"type":"string"},"CallbackUrl":{"type":"string"},"UserInputUrl":{"type":"string"},"Domain":{"type":"string"},"Lang":{"type":"string"},"PaymentTypes":{"type":"string"},"Agreement":{"format":"int32","type":"integer"},"Attributes":{"type":"object"},"Customer":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Orders.OrderCustomer"},"Payment":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Orders.OrderPayment"},"Created":{"format":"date-time","type":"string"}}},"FarPay.FrontEnd.Models.v2.Orders.OrderUpdateCustomer":{"type":"object","properties":{"Token":{"type":"string"},"Customer":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.Orders.OrderCustomer"}}},"FarPay.FrontEnd.Models.v2.Payments.PaymentReferenceContainer":{"type":"object","properties":{"InvoiceId":{"format":"int32","type":"integer"},"PaymentDate":{"format":"date-time","type":"string"},"ToBePaidAmount":{"format":"double","type":"number"},"PaidAmount":{"format":"double","type":"number"},"PaymentType":{"type":"string"},"PaymentStatus":{"type":"string"},"ErrorDesription":{"type":"string"},"PaymentId":{"format":"int32","type":"integer"},"RefundId":{"format":"int32","type":"integer"},"PaymentSign":{"type":"string"},"PaymentInfo":{"type":"string"},"PaymentReference":{"type":"string"}}},"FarPay.FrontEnd.Models.v2.Payments.PaymentRefundRequest":{"type":"object","properties":{"Amount":{"format":"double","type":"number"}}},"FarPay.FrontEnd.Models.v2.PaymentSets.PaymentSetReference":{"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"PaymentDate":{"format":"date-time","type":"string"},"Amount":{"format":"double","type":"number"},"PaymentType":{"type":"string"},"PaymentStatus":{"type":"string"},"PaymentCount":{"format":"int32","type":"integer"}}},"FarPay.FrontEnd.Models.v2.PaymentSets.PaymentSet":{"type":"object","properties":{"PayeeParty":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.PaymentSets.PayeeParty"},"BankTotal":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.PaymentSets.BankTotal"},"Payments":{"type":"array","items":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.PaymentSets.Payment"}}}},"FarPay.FrontEnd.Models.v2.PaymentSets.PayeeParty":{"type":"object","properties":{"ID":{"$ref":"#/definitions/FarPay.FrontEnd.Models.v2.PaymentSets.PayeeID"}}},"FarPay.FrontEnd.Models.v2.PaymentSets.BankTotal":{"type":"object","properties":{"NumberOfPayments":{"format":"int32","type":"integer"},"Payment":{"format":"double","type":"number"}}},"FarPay.FrontEnd.Models.v2.PaymentSets.Payment":{"type":"object","properties":{"AgreementNumber":{"type":"string"},"PaymentType":{"type":"string"},"PaymentStatus":{"type":"string"},"PaymentSign":{"type":"string"},"Amount":{"format":"double","type":"number"},"PaymentReference":{"type":"string"},"PaymentDate":{"format":"date-time","type":"string"},"InvoiceNumber":{"type":"string"},"CustomerNumber":{"type":"string"},"InvoiceId":{"format":"int32","type":"integer"},"PaymentInfo":{"type":"string"},"PaymentId":{"format":"int32","type":"integer"}}},"FarPay.FrontEnd.Models.v2.PaymentSets.PayeeID":{"type":"object","properties":{"Value":{"type":"string"},"schemaID":{"type":"string"}}},"FarPay.FrontEnd.Models.v2.Settings.VersionDetails":{"type":"object","properties":{"Version":{"type":"string","readOnly":true},"Created":{"type":"string","readOnly":true}}},"FarPay.FrontEnd.Models.v2.Subscriptions.SubscriptionReference":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"PlanId":{"format":"int32","type":"integer"},"PlanTitle":{"type":"string"},"CustomerNumber":{"type":"string"},"CustomerName":{"type":"string"}}},"FarPay.FrontEnd.Models.v2.Subscriptions.SubscriptionRequest":{"type":"object","properties":{"token":{"type":"string"},"planID":{"format":"int32","type":"integer"},"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"amount":{"format":"int32","type":"integer"},"note":{"type":"string"},"ssn":{"type":"string"},"bank_reg":{"type":"string"},"bank_account":{"type":"string"},"acquirer":{"type":"string"},"mode":{"type":"string"}}}},"securityDefinitions":{"apiKey":{"type":"apiKey","description":"API Key Authentication","name":"X-API-KEY","in":"header"}}}