Payment Link through XML API

XML API can be used for creation and/or dispatching of a payment link. That solution serves merchants that already use their own systems to transact with their customers and want to be able to consume Payment Link service through that same system.

Details regarding the structure of the respective XM request can be found at https://developer.cardlink.gr/api_products_categories/direct-integration/#VPOS-XML-2.1/4.1.

Below you may find sample requests for various cases.

Create and send Payment Link for payment

Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<VPOS xmlns="http://www.modirum.com/schemas/vposxmlapi41" xmlns:ns2="http://www.w3.org/2000/09/xmldsig#">
    <Message version="2.1" messageId="M1728981255715" timeStamp="2024-10-15T11:34:15.715+03:00">
        <PaymentLinkRequest>
            <Authentication>
                <Mid>90006064</Mid>
            </Authentication>
            <OrderInfo>
                <OrderId>1728981205998</OrderId>
                <OrderDesc>
                </OrderDesc>
                <OrderAmount>3.0</OrderAmount>
                <Currency>EUR</Currency>
                <PayerEmail>simos.siatis@worldline.com</PayerEmail>
                <BillingAddress>
                <country>GR</country>
                <state>
                </state>
                <zip>12345</zip>
                <city>Athens</city>
                <address>Test</address>
                </BillingAddress>
            </OrderInfo>
            <PaymentInfo/>
            <TxType>PAYMENT</TxType>
            <LinkValidityDays>5</LinkValidityDays>
            <MailLinkIfValidMail>true</MailLinkIfValidMail>
        </PaymentLinkRequest>
    </Message>
    <Digest>1yidVqPYsqK+lyy/3cCwsLAha1ksQhgYbStfQH17OuA=</Digest>
</VPOS>

Canonicalized part

<Message xmlns="http://www.modirum.com/schemas/vposxmlapi41" xmlns:ns2="http://www.w3.org/2000/09/xmldsig#" messageId="M1728981255715" timeStamp="2024-10-15T11:34:15.715+03:00" version="2.1">
    <PaymentLinkRequest>
        <Authentication>
            <Mid>90006064</Mid>
        </Authentication>
        <OrderInfo>
            <OrderId>1728981205998</OrderId>
            <OrderDesc>
            </OrderDesc>
            <OrderAmount>3.0</OrderAmount>
            <Currency>EUR</Currency>
            <PayerEmail>simos.siatis@worldline.com</PayerEmail>
            <BillingAddress>
            <country>GR</country>
            <state>
            </state>
            <zip>12345</zip>
            <city>Athens</city>
            <address>Test</address>
            </BillingAddress>
        </OrderInfo>
        <PaymentInfo>
        </PaymentInfo>
        <TxType>PAYMENT</TxType>
        <LinkValidityDays>5</LinkValidityDays>
        <MailLinkIfValidMail>true</MailLinkIfValidMail>
    </PaymentLinkRequest>
</Message>

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<VPOS xmlns="http://www.modirum.com/schemas/vposxmlapi41" xmlns:ns2="http://www.w3.org/2000/09/xmldsig#">
    <Message version="2.1" messageId="M1728981255715" timeStamp="2024-10-15T11:34:15.975+03:00">
        <PaymentLinkResponse>
            <OrderId>1728981205998</OrderId>
            <OrderAmount>3.0</OrderAmount>
            <Currency>EUR</Currency>
            <PaymentTotal>3.0</PaymentTotal>
            <Status>EXECWAIT</Status>
            <TxId>92639555657341</TxId>
            <Description>OK, link created mailed</Description>
            <PaymentLink>https://eurocommerce-test.cardlink.gr/vpos/Paylink/b033573194386268462f9034e0391f36</PaymentLink>
            <LinkMailed>true</LinkMailed>
        </PaymentLinkResponse>
    </Message>
    <Digest>IwQfgRMoiKvklLjzFBD+GphxTJDewH1beTcxNf+no6Y=</Digest>
</VPOS>

Create Payment Link for installment payment without sending it

Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<VPOS
	xmlns="http://www.modirum.com/schemas/vposxmlapi41"
	xmlns:ns2="http://www.w3.org/2000/09/xmldsig#">
	<Message version="2.1" messageId="M1751528174293" timeStamp="2025-07-03T10:36:14.293+03:00">
		<PaymentLinkRequest>
			<Authentication>
				<Mid>0101118297</Mid>
			</Authentication>
			<OrderInfo>
				<OrderId>1751528090098</OrderId>
				<OrderDesc></OrderDesc>
				<OrderAmount>4.0</OrderAmount>
				<Currency>EUR</Currency>
				<PayerEmail>simos.siatis@worldline.com</PayerEmail>
			</OrderInfo>
			<PaymentInfo>
				<InstallmentParameters>
					<ExtInstallmentoffset>0</ExtInstallmentoffset>
					<ExtInstallmentperiod>2</ExtInstallmentperiod>
				</InstallmentParameters>
			</PaymentInfo>
			<TxType>PAYMENT</TxType>
			<LinkValidityDays>7</LinkValidityDays>
		</PaymentLinkRequest>
	</Message>
	<Digest>mCBXS7PUq+wpIOPLv3GW4CZagiBUvPfv7WoqUVH41Tg=</Digest>
</VPOS>

Canonicalized part

<Message xmlns="http://www.modirum.com/schemas/vposxmlapi41" xmlns:ns2="http://www.w3.org/2000/09/xmldsig#" messageId="M1751528174293" timeStamp="2025-07-03T10:36:14.293+03:00" version=""2.1"">
	<PaymentLinkRequest>
		<Authentication>
			<Mid>0101118297</Mid>
		</Authentication>
		<OrderInfo>
			<OrderId>1751528090098</OrderId>
			<OrderDesc></OrderDesc>
			<OrderAmount>4.0</OrderAmount>
			<Currency>EUR</Currency>
			<PayerEmail>simos.siatis@worldline.com</PayerEmail>
		</OrderInfo>
		<PaymentInfo>
			<InstallmentParameters>
				<ExtInstallmentoffset>0</ExtInstallmentoffset>
				<ExtInstallmentperiod>2</ExtInstallmentperiod>
			</InstallmentParameters>
		</PaymentInfo>
		<TxType>PAYMENT</TxType>
		<LinkValidityDays>7</LinkValidityDays>
	</PaymentLinkRequest>
</Message>

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<VPOS
	xmlns="http://www.modirum.com/schemas/vposxmlapi41"
	xmlns:ns2="http://www.w3.org/2000/09/xmldsig#">
	<Message version="2.1" messageId="M1751528174293" timeStamp="2025-07-03T10:36:14.599+03:00">
		<PaymentLinkResponse>
			<OrderId>1751528090098</OrderId>
			<OrderAmount>4.0</OrderAmount>
			<Currency>EUR</Currency>
			<PaymentTotal>4.0</PaymentTotal>
			<Status>EXECWAIT</Status>
			<TxId>92639558771301</TxId>
			<Description>OK, link created</Description>
			<PaymentLink>https://ecommerce-test.cardlink.gr/vpos/Paylink/88a87e6c16f9734a6895551a4aec2038</PaymentLink>
			<LinkMailed>false</LinkMailed>
		</PaymentLinkResponse>
	</Message>
	<Digest>iUFIjvb2bHhp9PCS29Yj6923p7zh8hp2/Uv4m7umKd4=</Digest>
</VPOS>