Skip to main content

HF Process APM with Payment Token

Process an Alternative Payment Method (APM) transaction using a payment token.

Endpoint Information​

Name: Hosted Fields Process APM Transaction with Payment Token
Method: POST
URL: {{BASE_URL}}/api/v1/payment/process-apm-transaction

Authentication​

Type: Basic Auth

  • Username: App Key
  • Password: Secret Key

Request Body​

Content-Type: application/json

{
    "amount": "25",
    "currency": "EUR",
    "reference": "JYDFOOWSBJL",
    "customerIP": "81.38.67.137",
    "successUrl": "https://example.com/transaction-result/redirect",
    "webhookUrl": "https://example.com/transaction-result/webhook?operatorId=301&paymentGatewayId=HDPlNDeqRQSZfFg5aTm7nA&locale=en",
    "paymentToken": "9b33a6a1-6a9d-4e43-bee6-9b86ceab208d",
    "customerToken": "2e7dcfb6fb2d84d1c7740bc5fef2e3aa",
    "solutionUniqueId": [
        "2c032c79-dbb5-47b3-a575-c4098e687226"
    ],
    "merchantAccountId": "100643",
    "merchantAaccountId": "100643", // Alternative parameter name (typo in original API)
    "customerBrowserUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/144.0.0.0 Safari/537.36"
}
{
    "success": true,
    "message": "APM payment initiated",
    "data": {
        "reference": "JYDFOOWSBJL",
        "status": "Pending",
        "redirectUrl": "https://apm-provider.com/checkout?token=xyz123",
        "paymentToken": "9b33a6a1-6a9d-4e43-bee6-9b86ceab208d",
        "transactionId": "txn_apm_456789",
        "amount": "25.00",
        "currency": "EUR",
        "createdAt": "2025-12-28 11:15:30"
    }
}
warning

Note: The paymentToken is generated during the initial APM setup. The customer will be redirected to the APM provider's page to complete the payment. Webhook notifications will be sent to the specified webhookUrl upon transaction completion.