API Reference

Input parameters

The merchant data is sent as an additional input parameter:

ParameterTypeValue
merchantbase64Base64 encoded Merchant XML message.

❗️

Warning

Please ensure that the data provided is accurate and in English. Non-mappable characters may be contributing to the rejection of payment method registrations, particularly for products that require an IBAN, such as iDEAL and EPS.

amend

The Element types are specified in the submit call.

ElementTypeQuantityValue
Referenceascii1[A-Z0-9]{1,32}
Unique merchant reference, assigned by the submitting partner.
This reference is used in all method calls regarding the merchant.
NotificationURLascii1URL notifications are posted to when there is a status change.
BusinessDetailsBusinessDetails1Business details of the merchant.
LegalEntityLegalEntity1Legal entity containing the merchant information.
PricingGroupPricingGroup0..1he pricing group to be used for this merchant. This shall not be used in case the merchant is associated to a platform, i.e. it has a non-empty PlatformReference field.

Example Request

<Merchant>
    <Reference>MERCHANT0001</Reference>
    <NotificationUrl>https://notify.url</NotificationUrl>
    <BusinessDetails>
        <MerchantCategoryCode>742</MerchantCategoryCode>
        <PaymentDescriptor>Musical Instruments</PaymentDescriptor>
        <TradeName>MusicInstr</TradeName>
        <Websites>
            <Website>https://www.example.com</Website>
            <Website>https://www.exampleABC.com</Website>
        </Websites>
        <MonthlyTransactions>
            <Count>100</Count>
            <AverageValue>10</AverageValue>
            <Currency>EUR</Currency>
        </MonthlyTransactions>
    </BusinessDetails>
    <LegalEntity>
        <Individual>
        <Name>Any Artist Name</Name>
        <Residence>
            <Address>
                <AddressLine>Any Street 888</AddressLine>
            </Address>
            <ZipCode>12345</ZipCode>
            <City>Any City</City>
            <State>Any State</State>
            <Country>GB</Country>
        </Residence>
        <Person>
            <Name>
                <FirstName>John</FirstName>
                <LastName>Smith</LastName>
            </Name>
            <DateOfBirth>
                <Year>1950</Year>
                <Month>1</Month>
                <Day>1</Day>
            </DateOfBirth>
            <Residence>
                <Address>
                    <AddressLine>Any Street 123</AddressLine>
                </Address>
                <ZipCode>12345</ZipCode>
                <City>Any City</City>
                <State>Any State</State>
                <Country>GB</Country>
            </Residence>
        </Person>
    </Individual>
    </LegalEntity>
</Merchant>