Skip to content
APIs/Card Payments/
/
Payment Facilitators (Pay...

Payment Facilitators (PayFacs)

PayFacs are intermediaries that offer payment services for their clients (known as sub-merchants) and can process payments through us. When a cardholder completes a payment, the sub-merchant forwards the details to the PayFac, who then submits the compliant payment to us. We settle the funds with the PayFac, who subsequently distributes the payment to the respective sub-merchant.

PayFacs must provide detailed information that clearly identifies both themselves and the sub-merchant for each payment.

Parameters

You can submit PayFac specific fields in the merchant.paymentFacilitator object for both Customer Initiated Transactions and Merchant Initiated Transactions.

schemeIdstring[ 1 .. 11 ] characters[0-9]*$required

Your payment facilitator ID received from Visa, Mastercard, or Amex.

independentSalesOrganizationIdstring[ 1 .. 11 ] characters[0-9]*$
subMerchantobjectrequired
subMerchant.​namestring[ 1 .. 25 ] characters^(?!\s*$)[A-Za-z0-9 ]*$required
subMerchant.​referencestringrequired
subMerchant.​addressobjectrequired
subMerchant.​address.​postalCodestring[ 1 .. 10 ] characters^(?!\s*$)[a-zA-Z0-9\s]*$required
Example: "SW1 1AA"
subMerchant.​address.​streetstring[ 1 .. 50 ] characters^(?!\s*$)[A-Za-z0-9\s]*$required
Example: "221B Baker Street"
subMerchant.​address.​citystring[ 1 .. 13 ] characters^(?!\s*$)[A-Za-z\s-]*$required
Example: "London"
subMerchant.​address.​statestring[ 1 .. 3 ] characters^[a-zA-Z0-9]*$

The state code of the subMerchant in ISO-3166-2 format.

subMerchant.​address.​countryCodestring= 2 characters^[A-Z]*$required
subMerchant.​phoneNumberstring[ 4 .. 20 ] characters^(?!\s*$)[0-9\s()+-/.x]*$
subMerchant.​taxReferencestring[ 1 .. 20 ] characters^(?!\s*$)[a-zA-Z0-9\s-]*$
subMerchant.​emailstring[ 4 .. 20 ] characters
subMerchant.​urlstring[ 1 .. 255 ] characters^[a-zA-Z0-9@!£*#$)(+-_=.,/;:]*$

Example request

{
    "transactionReference": "abc-123",
    "channel": "ecom",
    "merchant": {
        "entity": "default",
        "paymentFacilitator": {
            "schemeId": "1111",
            "independentSalesOrganizationId": "222",
            "subMerchant": {
                "name": "ABC Name",
                "reference": "abc123",
                "address": {
                    "postalCode": "SM8989",
                    "street": "SMLondon",
                    "city": "London",
                    "state": "WSM",
                    "countryCode": "GB"
                },
                "phoneNumber": "079707281345",
                "email": "email@example.com",
                "url": "https://www.website.com",
                "taxReference": "54282949242"
            }
        }
    },
    "instruction": {
        "requestAutoSettlement": {
            "enabled": false
        },
        "debtRepayment": true,
        "narrative": {
            "line1": "Test1"
        },
        "value": {
            "currency": "GBP",
            "amount": 650
        },
        "paymentInstrument": {
            "type": "card/plain",
            "cardNumber": "4444333322221111",
            "cardHolderName": "Sherlock Holmes",
            "expiryDate": {
                "month": 9,
                "year": 2029
            }
        }
    }
}