Flexibuild - API Documentation

Live

https://flexibuild.co.za/payment/initiate

Test

https://flexibuild.co.za/test/payment/initiate

Required headers

Accept: application/json
Content-Type: application/json

Parameter	Type	Requirement	Description
`public_key`	string	Required	Housing partner API key for checkout mode authentication.
`identifier`	string (40)	Required	Your unique order/transaction reference.
`products`	array	Required	List of purchased items.
`products.*.name`	string (255)	Required	Display name of each product.
`products.*.price`	number	Required	Per-unit product price.
`products.*.quantity`	integer	Required	Quantity for each product line.
`total_amount`	number	Required	Total payable amount (must match product sum).
`ipn_url`	url	Required	Webhook URL for payment notifications.
`success_url`	url	Required	Redirect URL after successful payment.
`cancel_url`	url	Required	Redirect URL when payment is cancelled.
`site_name`	string (40)	Required	Housing partner/business name shown on checkout.
`site_logo`	url	Optional	Optional logo URL shown on checkout.
`customer`	array	Required	Customer identity and contact object.
`customer.first_name`	string (40)	Required	Customer first name.
`customer.last_name`	string (40)	Required	Customer last name.
`customer.email`	email	Required	Customer email for verification/contact.
`customer.phone`	string	Required	Customer phone number.
`shipping_info`	array	Optional	Optional shipping address object.
`shipping_info.address`	string (255)	Optional	Shipping street address.
`shipping_info.city`	string (40)	Optional	Shipping city name.
`shipping_info.state`	string (40)	Optional	Shipping state/division.
`shipping_info.postal_code`	string	Optional	Shipping ZIP/postal code.
`shipping_info.country`	string	Optional	Shipping country code (ISO-style).
`billing_info`	array	Optional	Optional billing address object.
`billing_info.address`	string (255)	Optional	Billing street address.
`billing_info.city`	string (40)	Optional	Billing city name.
`billing_info.state`	string (40)	Optional	Billing state/division.
`billing_info.postal_code`	string	Optional	Billing ZIP/postal code.
`billing_info.country`	string	Optional	Billing country code (ISO-style).

<?php
$parameters = [
    'public_key' => 'pk_live_xxxxxxxxx',
    'identifier' => 'ORDER-1001',
    'products' => [
        [
            'name' => 'Laptop Bag',
            'price' => 50,
            'quantity' => 1,
        ],
        [
            'name' => 'Mouse',
            'price' => 20,
            'quantity' => 2,
        ],
    ],
    'total_amount' => 90,
    'ipn_url' => 'https://merchant.test/ipn',
    'success_url' => 'https://merchant.test/success',
    'cancel_url' => 'https://merchant.test/cancel',
    'site_name' => 'Merchant Shop',
    'site_logo' => 'https://merchant.test/logo.png',
    'customer' => [
        'first_name' => 'John',
        'last_name' => 'Doe',
        'email' => 'john@example.com',
        'phone' => '+15550123',
    ],
    'shipping_info' => [
        'address' => 'Road 01',
        'city' => 'Washington DC',
        'state' => 'Washington DC',
        'postal_code' => '1207',
        'country' => 'USA',
    ],
    'billing_info' => [
        'address' => 'Road 09',
        'city' => 'Washington DC',
        'state' => 'Washington DC',
        'postal_code' => '1212',
        'country' => 'USA',
    ],
];

$ch = curl_init('https://flexibuild.co.za/payment/initiate');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($parameters));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Accept: application/json',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

curl --request POST 'https://flexibuild.co.za/payment/initiate' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "public_key":"pk_live_xxxxxxxxx",
    "identifier":"ORDER-1001",
    "products":[{"name":"Item","price":120,"quantity":1}],
    "total_amount":120,
    "ipn_url":"https://merchant.test/ipn",
    "success_url":"https://merchant.test/success",
    "cancel_url":"https://merchant.test/cancel",
    "site_name":"Merchant Shop",
    "customer":{
      "first_name":"John",
      "last_name":"Doe",
      "email":"john@example.com",
      "phone":"+15550123"
    }
  }'

API Documentation

Initiate Payment

Required headers

Ready to build your path to home ownership?