Payflex · Example Payload

Create Order Request

Order from Example Store

BNPLBuy Now Pay LaterPaymentsInstallmentsSouth AfricaFintechE-commerce

Create Order Request is an example object payload from Payflex, with 11 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

amountconsumerbillingshippingdescriptionitemsmerchantmerchantReferencetaxAmountshippingAmountmerchantSystemInformation

Example Payload

{
  "amount": "299.99",
  "consumer": {
    "phoneNumber": "+27821234567",
    "givenNames": "Jane",
    "surname": "Smith",
    "email": "jane.smith@example.com"
  },
  "billing": {
    "addressLine1": "12 Main Street",
    "addressLine2": "Apt 3",
    "suburb": "Cape Town",
    "postcode": "8001"
  },
  "shipping": {
    "addressLine1": "12 Main Street",
    "addressLine2": "Apt 3",
    "suburb": "Cape Town",
    "postcode": "8001"
  },
  "description": "Order from Example Store",
  "items": [
    {
      "name": "Blue T-Shirt",
      "sku": "SKU-001",
      "quantity": "2",
      "price": "99.99"
    },
    {
      "name": "Denim Jeans",
      "sku": "SKU-002",
      "quantity": "1",
      "price": "100.01"
    }
  ],
  "merchant": {
    "redirectConfirmUrl": "https://example.com/checkout/confirm?order_id=12345&status=confirmed&wc-api=WC_Gateway_PartPay",
    "redirectCancelUrl": "https://example.com/checkout/cancel?status=cancelled"
  },
  "merchantReference": "12345",
  "taxAmount": 0,
  "shippingAmount": 0,
  "merchantSystemInformation": {
    "plugin_version": "2.7.0",
    "php_version": "8.1.0",
    "ecommerce_platform": "WordPress 6.4, WooCommerce 8.2",
    "total_plugin_modules": "25",
    "active_plugin_modules": "12"
  }
}