Global Payments

Market: UK, EU

Business Capabilities

Generate payment links through the Hosted Payments Page (HPP) service offered by Global Payments. Payment links direct customers to a secure, pre-built payment page hosted by Global Payments, removing the need to handle card data in your own application. Each link is single-use or multi-use, supports customizable expiration dates, and reports transaction results through the standard Data Core response format.

Exposed Endpoints

Generate a payment link: POST /api/global-payments/v1/payment-link

Vault Configuration

token.config - Access token configuration for the Global Payments API.
baseUrl - Base URL of the Global Payments API.

Request Structures and Samples

POST /api/global-payments/v1/payment-link

Creates a hosted payment page link. For complete input constraints, see the Global Payments HPP Guide.

Request structure:

Copy

{
    "account_name": "string",
    "type": "HOSTED_PAYMENT_PAGE",
    "name": "string",
    "description": "string",
    "usage_mode": "SINGLE",
    "usage_limit": "string",
    "reference": "string",
    "expiration_date": "string",
    "payer": {
        "status": "NEW",
        "id": "string",
        "name": "string",
        "language": "string",
        "email": "string",
        "mobile_phone": {
            "country_code": "string",
            "subscriber_number": "string"
        },
        "billing_address": {
            "line_1": "string",
            "line_2": "string",
            "line_3": "string",
            "city": "string",
            "postal_code": "string",
            "state": "string",
            "country": "string"
        }
    },
    "order": {
        "amount": "string",
        "currency": "string",
        "reference": "string",
        "transaction_configuration": {
            "channel": "string",
            "country": "string",
            "capture_mode": "AUTO",
            "currency_conversion_mode": true,
            "allowed_payment_methods": ["string"]
        },
        "payment_method_configuration": {
            "authentication": {
                "preference": "CHALLENGE_PREFERRED"
            },
            "apm": {
                "shipping_address_enabled": true,
                "address_override": true
            },
            "storage_mode": "ALWAYS"
        }
    },
    "notifications": {
        "return_url": "string",
        "status_url": "string"
    }
}

Sample request:

Copy

{
    "account_name": "transaction_processing",
    "type": "HOSTED_PAYMENT_PAGE",
    "name": "Bill Payment",
    "description": "February and March Invoice",
    "reference": "82c2dbd5-549d-4967-aeea-51b3f320046a",
    "payer": {
        "name": "James Mason",
        "language": "en",
        "email": "jamesmason@example.com",
        "mobile_phone": {
            "country_code": "44",
            "subscriber_number": "1801555888"
        },
        "billing_address": {
            "line_1": "Flat 456",
            "line_2": "House 456",
            "line_3": "Unit 4",
            "city": "Halifax",
            "postal_code": "44",
            "country": "GB"
        }
    },
    "order": {
        "amount": "1000",
        "currency": "EUR",
        "reference": "order-645",
        "transaction_configuration": {
            "channel": "CNP",
            "country": "IE",
            "capture_mode": "AUTO",
            "allowed_payment_methods": ["CARD"]
        },
        "payment_method_configuration": {
            "authentications": {
                "preference": "CHALLENGE_PREFERRED"
            }
        }
    },
    "notifications": {
        "return_url": "https://www.example.com/return_url",
        "status_url": "https://www.example.com/status_url"
    }
}

Sample response:

Copy

{
    "id": "LNK_ylMdPbDLvkKyg9LBPClUgE9qCYY9Za",
    "account_name": "transaction_processing",
    "url": "https://apis.sandbox.globalpay.com/ucp/hpp/redirect/f35d167a-6664-491d-aba7-ce08294e32f5",
    "status": "ACTIVE",
    "type": "HOSTED_PAYMENT_PAGE",
    "usage_mode": "SINGLE",
    "usage_limit": "1",
    "name": "Bill Payment",
    "description": "February and March Invoice",
    "expiration_date": "2025-01-15T06:47:38.054Z",
    "order": {
        "amount": "1000",
        "currency": "EUR",
        "reference": "order-645",
        "transaction_configuration": {
            "country": "IE",
            "channel": "CNP"
        }
    },
    "action": {
        "id": "ACT_ylMdPbDLvkKyg9LBPClUgE9qCYY9Za",
        "type": "LINK_CREATE",
        "time_created": "2025-01-14T06:47:38.054Z",
        "result_code": "SUCCESS",
        "app_id": "<app-id>",
        "app_name": "<app-name>"
    }
}

Error Codes

Errors follow the standard Data Core error response format:

Copy

{
  "status": 400,
  "title": "Bad Request",
  "detail": "Description of the error"
}

Status	Meaning	Triggered By
`400`	Bad Request	Invalid or missing fields in the request payload.
`401`	Unauthorized	Missing or invalid authentication token.
`502`	Bad Gateway	Global Payments API returned an error or is unreachable.
`503`	Service Unavailable	Connection to Global Payments could not be established.
`504`	Gateway Timeout	Global Payments API did not respond within the timeout period.