YKB WorldPay via Craftgate

​

Supported workflows

​

Before you begin

1. Set up a Craftgate integration in your workspace. Follow the Craftgate integration setup guide if you don’t have one yet.
2. Ask Craftgate to enable YKB WorldPay on your Craftgate merchant account.
3. In the Payrails Portal, go to Settings → Integrations, open your Craftgate integration, and fill in the APM Callback Key with the merchant callback key from the Craftgate merchant panel. Payrails uses it to verify the YKB WorldPay result that Craftgate sends back.
4. In the same integration, select YKB WorldPay under Payment methods, and save.
5. Add YKB WorldPay as a payment option in your workflow, with instant capture.

​

Request fields for Craftgate

​

Authorize a YKB WorldPay payment

{
  "amount": {
    "value": "150.00",
    "currency": "TRY"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "ykbWorldPay",
      "amount": {
        "value": "150.00",
        "currency": "TRY"
      }
    }
  ],
  "meta": {
    "clientContext": {
      "ipAddress": "203.0.113.10"
    },
    "order": {
      "description": "Order 1234"
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}

• QR code page: the action has no redirect URL. Its provider data holds htmlContent, a base64-encoded HTML page with a QR code. Decode it and show it to the customer, who scans the QR code with the WorldPay app.
• App link: the action has a redirectUrl that opens the WorldPay app. Send the customer to it.

​

How Craftgate handles YKB WorldPay

• Payrails starts the payment with Craftgate’s point-of-sale APM API and captures it in the same step.
• Payrails verifies the result that Craftgate sends back with your APM Callback Key, then reads the final payment status from Craftgate.
• The QR code is valid for a limited time. If the customer doesn’t scan it in time, the payment fails and you start a new one.
• You can refund the full amount or part of it.