Documentation

amount

-

number

Required

-

Decimal, 2 places

Minimum 10.00 ZAR. No Rapyd maximum (Payflex decides per shopper).

Payment amount in ZAR.

250.00

Merchant

currency

-

string

Required

-

ZAR

ISO 4217

Payment currency.

ZAR

Merchant

payment_method

-

object

Required

-

-

-

Payment method object.

{"type": "za_payflex_ewallet", "fields": {}}

Merchant

type

payment_method

string

Required

-

za_payflex_ewallet

-

Payment method type.

za_payflex_ewallet

Merchant

fields

payment_method

object

Optional

{}

Empty object

No fields are defined for this PMT (required_fields = []).

Payment-method-specific fields. None for Payflex.

{}

Merchant

customer

-

object

Required

-

-

Must contain name, email and phone_number.

Shopper details used by Payflex for identity, credit and OTP checks.

{"name": "Thabo Nkosi", "email": "thabo@example.com", "phone_number": "27821234567"}

Merchant

name

customer

string

Required

-

Letters and spaces

Regex ^[a-zA-ZÀ-ÿ ]{1,100}$

Shopper full name.

Thabo Nkosi

Merchant

email

customer

string

Required

-

-

Regex (?=.{4,100}$)[a-zA-Z0-9À-ÿ._%+-]+@[a-zA-Z0-9À-ÿ.-]+[.][a-zA-ZÀ-ÿ]{2,}$

Shopper email.

thabo@example.com

Merchant

phone_number

customer

string

Required

-

Digits only

Production and Sandbox regex ^[0-9]{1,15}$ (no plus sign).

Shopper mobile number. Payflex uses it for OTP.

27821234567

Merchant

complete_payment_url

-

string

Required

-

URL

HTTPS required in production. No localhost.

Where the shopper returns after approving the Payflex payment.

https://merchant.example/return

Merchant

error_payment_url

-

string

Required

-

URL

HTTPS required in production. No localhost.

Where the shopper returns if they cancel or are declined.

https://merchant.example/cancel

Merchant

merchant_reference_id

-

string

Optional

-

-

-

Merchant's own order reference.

MERCH-REF-0001

Merchant

description

-

string

Optional

-

-

-

Payment description.

Order 1234

Merchant

expiration

-

number

Optional

Now + 3600 seconds

Unix timestamp (seconds)

PMT maximum expiration is 3600 seconds.

When the payment expires if the shopper does not complete it.

1780398761

Merchant

metadata

-

object

Optional

-

-

-

Merchant-defined key/value data.

{"order": "1234"}

Merchant

id

data

string

payment_...

Rapyd payment ID. Also sent to Payflex as merchantReference and used for reconciliation.

payment_77465d3aeaa6eb6dedf34d4552a76fdd

Rapyd

status

data

string

ACT, CLO, ERR, EXP

Payment status. ACT on creation; CLO when Payflex approves; ERR when Payflex declines, the shopper abandons, or order creation fails; EXP after 60 minutes.

ACT

Rapyd

redirect_url

data

string

URL

Payflex checkout page. Send the shopper here.

https://checkout.payflex.co.za/embedded/v2?orderId=22ba200f-8d69-496a-97ec-d0a1a0dd038c

Gateway

amount

data

number

-

Amount paid. 0 while ACT; equals original_amount once CLO.

0

Rapyd

original_amount

data

number

-

Requested amount.

250

Carried over

currency_code

data

string

ZAR

Currency.

ZAR

Carried over

country_code

data

string

ZA

Country of the payment method.

ZA

Rapyd

merchant_reference_id

data

string

-

Echo of the merchant reference.

MERCH-REF-0001

Carried over

payment_method_type

data

string

za_payflex_ewallet

Payment method type.

za_payflex_ewallet

Rapyd

payment_method_type_category

data

string

ewallet

PMT category.

ewallet

Rapyd

next_action

data

string

pending_confirmation, not_applicable

What the merchant should do next. pending_confirmation means redirect the shopper.

pending_confirmation

Rapyd

instructions

data

array

-

Shopper instructions from the PMT configuration.

[{"name": "instructions", "steps": [{"step1": "You will be redirected to the Payflex login page to complete your payment.", "step2": "Once in the Payflex environment, select your preferred payment plan and complete your payment."}]}]

Rapyd

complete_payment_url

data

string

-

Echo.

https://merchant.example/return

Carried over

error_payment_url

data

string

-

Echo.

https://merchant.example/cancel

Carried over

expiration

data

number

-

Expiry time (Unix seconds).

1780398761

Rapyd

paid

data

boolean

true, false

true once the payment is CLO.

false

Rapyd

failure_code

data

string

Payflex error code, for example CRM005, VALIDATION_ERROR, UNAUTHORISED

Failure code when order creation fails at Payflex.

-

Gateway

failure_message

data

string

-

Failure message from Payflex.

-

Gateway

textual_codes

data

object

-

Not used by this connector (always empty).

{}

Rapyd

customer_token

data

string

cus_...

Rapyd customer created from the inline customer.

cus_8c94d097e831e530763f2e5b3462e568

Rapyd

payment

-

string

Required

-

payment_...

Payment must be CLO.

ID of the Payflex payment to refund.

payment_77465d3aeaa6eb6dedf34d4552a76fdd

Merchant

amount

-

number

Optional

Full remaining amount

Decimal

Cannot exceed the remaining refundable amount.

Refund amount. Partial refunds are supported.

100.00

Merchant

currency

-

string

Optional

Payment currency

ZAR

Must match the payment currency.

Refund currency.

ZAR

Merchant

merchant_reference_id

-

string

Optional

-

-

-

Merchant's own refund reference.

REFUND-0001

Merchant

reason

-

string

Optional

-

-

-

Reason for the refund.

Customer returned item

Merchant

metadata

-

object

Optional

-

-

-

Merchant-defined data.

{}

Merchant

id

data

string

refund_...

Rapyd refund ID. Sent to Payflex as merchantRefundReference.

refund_5a1b2c3d4e5f60718293a4b5c6d7e8f9

Rapyd

status

data

string

Completed, Error

Final refund status. Completed only when the Payflex refund lookup returns 'Completed'.

Completed

Rapyd

amount

data

number

-

Refunded amount as returned by Payflex.

100

Gateway

payment

data

string

payment_...

Original payment ID.

payment_77465d3aeaa6eb6dedf34d4552a76fdd

Carried over

currency

data

string

ZAR

Refund currency.

ZAR

Carried over

failure_reason

data

string

-

Why the refund failed. Either the Payflex error message, or 'Refund lookup returned unexpected status: <status>'.

-

Gateway

merchant_reference_id

data

string

-

Echo of the merchant refund reference.

REFUND-0001

Carried over

payment_method_type

data

string

za_payflex_ewallet

PMT of the refunded payment.

za_payflex_ewallet

Rapyd

created_at

data

number

-

Creation time (Unix seconds).

1780400000

Rapyd