Payflex direct integration

Accept Payflex payments from customers in South Africa through a direct integration with Payflex as the payment service provider (PSP). The customer selects Payflex, confirms the payment on the Payflex checkout page and returns to your site.

Supported workflows

Before you begin

Complete these steps before you send your first payment through Payflex:

Get your Payflex API credentials from Payflex: a Client ID and a Client Secret. To test your integration, follow the Payflex testing guide.
Set up a Payflex integration in your workspace with those credentials. Follow the Payflex integration setup guide.
In the Payrails Portal, go to Settings → Integrations, open your Payflex integration, select Payflex under Payment methods, and save.
Add Payflex as a payment option in your workflow.

Request fields for Payflex

Send these fields in the authorize request, in addition to the standard authorize fields. Required fields must be present for the payment to succeed. Payrails sends Optional fields to the PSP when you include them.

Field	Status	Description
`amount.currency`	Required	Must be `ZAR`. Payrails rejects other currencies.
`meta.customer.email`	Optional	Sent to Payflex as the consumer email.
`meta.customer.name`, `meta.customer.lastName`	Optional	Sent to Payflex as the consumer given names and surname.
`meta.customer.phone`	Optional	Sent to Payflex as the consumer phone number. Payrails joins the country code and the number.
`meta.order.lines`	Optional	Sent to Payflex as the order items, with each line’s `name`, `description`, `quantity` and `unitPrice`. A line with a `total` goes as one item at that price. Discount lines go with a negative price.
`meta.order.shipping`	Optional	Sent to Payflex as the shipping amount.
`meta.order.totalTax`	Optional	Sent to Payflex as the tax amount.

When you send meta.order, Payrails checks that the order lines, shipping, tax and discounts add up to the payment amount, and returns an error when they don’t.

Authorize a Payflex payment

Call authorize a payment with payflex as the paymentMethodCode. The response includes the redirect to the Payflex checkout page.

Authorize request

{
  "amount": {
    "value": "1500.00",
    "currency": "ZAR"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "payflex",
      "amount": {
        "value": "1500.00",
        "currency": "ZAR"
      }
    }
  ],
  "meta": {
    "customer": {
      "name": "Thandiwe",
      "lastName": "Mokoena",
      "email": "thandiwe.mokoena@example.com",
      "phone": {
        "countryCode": "+27",
        "number": "821234567"
      }
    },
    "order": {
      "lines": [
        {
          "name": "Running shoes",
          "description": "Trail running shoes, size 8",
          "quantity": 1,
          "unitPrice": {
            "value": "1500.00",
            "currency": "ZAR"
          }
        }
      ]
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}

After the customer confirms the payment, Payflex returns them to your success or error URL. Confirm the result through webhook notifications or the execution status before you fulfill the order.

How Payflex handles payments

On the Payflex checkout page, the customer signs in or checks out as a guest, then pays in full or chooses an installment plan.
Payflex captures the payment when the customer confirms it. Payrails records the capture from the Payflex status notification, so the payment completes in one step.
To return funds after a successful payment, refund it.

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

Payflex direct integration

Supported workflows

Before you begin

Request fields for Payflex

Authorize a Payflex payment

How Payflex handles payments

​Supported workflows

​Before you begin

​Request fields for Payflex

​Authorize a Payflex payment

​How Payflex handles payments

Supported workflows

Before you begin

Request fields for Payflex

Authorize a Payflex payment

How Payflex handles payments