Overførselsservice

The purpose of the Bill format is to encapsulate the data of a bill, that is to be sent to the receiver.
Further more to express a payout by using a bill, that is compatible with Overførselsservice.

Requirements

Requirement	Description
`X-API-KEY`	Merchant API key, aquired from the FarPay settings page.
Document body	The document is expresed as a standard bill. This document will express the requirements to the document

Bill example

The following XSD document, governs the structure of the Bill XML document.
Remarks that current version of the API only supports bulk insert of the <Bills> tag.

This means that you must create a delivery, without any file content. Hence you will receive a result containing a
LOB storage, that is available for 30 minutes, where you have the capability of pushing the file into that link.

    https://app.farpay.io/xsd/bills/bills.xsd

<?xml version="1.0" encoding="UTF-8"?>
<FarPayXml xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://app.farpay.io/xsd/bills.xsd">
    <Delivery>
        <Count>1</Count>
    </Delivery>
    <Bills>
        <Bill>
            <InvoiceTypeCode>PCM</InvoiceTypeCode>
            <InvoiceNumber>INV-12345</InvoiceNumber>
            <EncodedDocument>JVBERi0xLjcNCiW1t......olJUVPRg==</EncodedDocument>
            <CustomerNumber>CUST-67890</CustomerNumber>
            <Name>John Doe</Name>
            <Street>Main Street</Street>
            <HouseNumber>42</HouseNumber>
            <PostalZone>12345</PostalZone>
            <CityName>Example City</CityName>
            <Country>CountryName</Country>
            <EmailAddress>[email protected]</EmailAddress>
            <PaymentDueDate>2025-02-01</PaymentDueDate>
            <Currency>DKK</Currency>
            <ToBePayedAmount>123.45</ToBePayedAmount>
            <PaymentMeans>
                <TypeCodeID>BankTransfer</TypeCodeID>
                <PaymentChannelCode>OVERFØRSELSSERVICE</PaymentChannelCode>
                <ExtensibleContent>
                    <FarPay>
                        <PaymentMethod>Payout</PaymentMethod>
                        <Payout>
                            <SenderIdentifier scheme="BANK">rrrr:nnnnnnnn</SenderIdentifier>
                            <ReceiverIdentifier scheme="BANK">rrrr:nnnnnnnn</ReceiverIdentifier>
                        </Payout>                         
                    </FarPay>
                </ExtensibleContent>
            </PaymentMeans>
        </Bill>
    </Bills>
</FarPayXml>

Payout Identifier Schemes

Scheme	Description	Format	Example
`BANK`	Bank account details	`rrrr:aaaaaaaa`	`1234:12345678`
`CVR`	Company registration number	8 digits	`12345678`
`CPR`	Personal identification number	10 digits	`0102889999`

Payout Details

SenderIdentifier: Optional - specify if you have multiple Overførselsservice creditors
ReceiverIdentifier: Required - specifies where to send the money
Scheme: Determines the format of the identifier