X-Pay Merchant Public Api
  1. XPayMerchant Public API
X-Pay Merchant Public Api
  • Payments
    • Introduction to the X-Pay API
    • Integration Guide - Quick Start
    • Integration Guide - Payments
    • X-Pay WooCommerce
    • X-Pay Flutter Plugin
    • .NET SDK
  • XPayMerchant Public API
    • Get Token Sandbox
      POST
    • Get Token Production
      POST
    • Get Currencies
      GET
    • Get Banks
      GET
    • Get Payment intervals
      GET
    • Payment Calculator
      POST
    • Test Webhook Sandbox
      POST
    • Test Webhook Production
      POST
    • Pay Visa Sandbox
      POST
    • Pay Visa Production
      POST
    • Pay Mastercard Sandbox
      POST
    • Pay Mastercard Production
      POST
    • Pay Mastercard Sandbox Bulk
      POST
    • Pay Mastercard Production Bulk
      POST
    • Pay Visa Sandbox Bulk
      POST
    • Pay Visa Production Bulk
      POST
    • Payment Status Visa Sandbox
      GET
    • Payment Status MasterCard Sandbox
      GET
    • Payment Status Visa Production
      GET
    • Payment Status Mastercard Production
      GET
    • Generate Payment Token Sandbox
      POST
    • Generate Payment Token Production
      POST
    • Card Token Payment Sandbox
      POST
    • Card Token Payment Production
      POST
    • Delete Card Token Sandbox
      DELETE
    • Fast Checkout
      POST
    • Fast Checkout Sandbox
      POST
  1. XPayMerchant Public API

Fast Checkout

POST
/api/merchant/fastCheckOut
Fast Checkout types ONCE_OFF_FIXED,OPEN_FIXED_AMOUNT,OPEN_DYNAMIC_AMOUNT

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params multipart/form-data

Responses

🟢200Fast Checkout
text/plain
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/merchant/fastCheckOut' \
--header 'Authorization: Bearer <token>' \
--form 'id=""' \
--form 'paymentLinkName="{{name}}"' \
--form 'paymentLinkDescription="{{Description}}"' \
--form 'paymentLinkReference="{{Reference}}"' \
--form 'paymentLinkAmount="{{Amount}}"' \
--form 'paymentLinkType="ONCE_OFF_FIXED"' \
--form 'paymentLinkImageType="NEW"' \
--form 'paymentLinkProfileId="{{profileId}}"' \
--form 'paymentLinkStartDate="{{startDate}}"' \
--form 'paymentLinkEndDate="{{endDate}}"' \
--form 'paymentLinkCurrency="{{currency}}"' \
--form 'paymentLinkCurrencyId="{{currencyId}}"' \
--form 'paymentLinkOtherCurrencies="{{true or false}}"' \
--form 'paymentLinkCustomerRedirectUrl="{{url}}"' \
--form 'paymentCustomerFailRedirectUrl="{{url}}"' \
--form 'paymentLinkEmail="{{email}}"' \
--form 'paymentLinkImage=@""' \
--form 'paymentPayerFullNames="{{Payer Names}}"' \
--form 'paymentPayerEmailAddress="{{Payer Email Address}}"' \
--form 'paymentPayerAddress="{{Payer Address }}"' \
--form 'paymentPayerMobile="{{Payer Mobile}}"'
Response Response Example
{
    "status": "Success",
    "paymentLink": {
        "paymentProfileName": "Church Offering",
        "paymentProfileDescription": "Offering for every Sunday Service",
        "paymentLinkReference": "Pay00001",
        "paymentLinkUrl": "https://staging-payments.smatpay.africa/global?token=yr1d_ljcPzFpHV3eRRP57rbwvdj7mITG",
        "paymentLinkAmount": 10.0,
        "paymentLinkType": "ONCE_OFF_FIXED",
        "paymentLinkToken": "yr1d_ljcPzFpHV3eRRP57rbwvdj7mITG",
        "paymentLinkImageUrl": "https://smatpay.s3.af-south-1.amazonaws.com/20240805150004-VPN.png",
        "paymentLinkStartDate": "2024-07-26T00:00:00.000+00:00",
        "paymentLinkEndDate": "2024-07-26T00:00:00.000+00:00",
        "paymentLinkIsActive": true,
        "createdAt": "2024-08-05T15:00:05.045+00:00",
        "id": 14
    },
    "message": "Payment link created successfully! Image URL: https://smatpay.s3.af-south-1.amazonaws.com/20240805150004-VPN.png"
}
Modified at 2025-11-17 18:54:15
Previous
Delete Card Token Sandbox
Next
Fast Checkout Sandbox
Built with