Benefit via Checkout.com

​

Supported workflows

​

Before you begin

1. Set up a Checkout.com integration in your workspace. Follow the Checkout.com integration setup guide if you don’t have one yet.
2. Ask Checkout.com support to enable Benefit on your Checkout.com account.
3. In the Payrails Portal, go to Settings → Integrations, open your Checkout.com integration, select Benefit under Payment methods, and save.
4. Add Benefit as a payment option in your workflow.

​

Request fields for Checkout.com

​

Authorize a Benefit payment

{
  "amount": {
    "value": "10.000",
    "currency": "BHD"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "benefit",
      "amount": {
        "value": "10.000",
        "currency": "BHD"
      }
    }
  ],
  "meta": {
    "customer": {
      "email": "maryam.alkhalifa@example.com",
      "name": "Maryam",
      "lastName": "Al-Khalifa"
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}

​

How Checkout.com handles Benefit

• Payrails creates the Benefit payment through the Checkout.com Payment Setup API. Checkout.com needs no payment token for Benefit.
• Benefit rejects references that contain spaces, dashes, or underscores. Payrails strips every character that isn’t a letter or a digit from the reference before it calls Checkout.com, so order-1234_A becomes order1234A.
• If Checkout.com doesn’t return a redirect for a pending Benefit payment, Payrails fails the payment, because the customer can’t complete it.
• Each Benefit payment is a new customer-initiated payment.