SmatPay Merchant Public Api
    SmatPay Merchant Public Api
    • Introduction to the SmatPay API
    • Integration Guide - Quick Start
    • Integration Guide - Payments
    • SmatPay WooCommerce
    • .NET SDK
    • 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 Innbucks Sandbox
      POST
    • Pay Innbucks Sandbox Bulk
      POST
    • Pay Innbucks Production
      POST
    • Pay Innbucks Production Bulk
      POST
    • Pay ZimSwitch Sandbox
      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
    • Pay ZimSwitch Sandbox Bulk
      POST
    • Pay ZimSwitch Production
      POST
    • Pay ZimSwitch Production Bulk
      POST
    • Pay Ecocash Sandbox
      POST
    • Pay Ecocash Sandbox Bulk
      POST
    • Bulk Payouts Sandbox
      POST
    • Bulk Payouts Production
      POST
    • Pay Ecocash Production
      POST
    • Pay Ecocash Production Bulk
      POST
    • Payment Status Innbucks Sandbox
      GET
    • Payment Status Innbucks Production
      GET
    • Payment Status Ecocash Sandbox
      GET
    • Payment Status Ecocash Production
      GET
    • Payment Status ZimSwitch Sandbox
      GET
    • Payment Status ZimSwitch Production
      GET
    • Payment Status Visa Sandbox
      GET
    • Payment Status MasterCard Sandbox Copy
      GET
    • Payment Status Visa Production
      GET
    • Payment Status Mastercard Production
      GET
    • Generate Recurring Payment Sandbox
      POST
    • Generate Payment Token Sandbox
      POST
    • Generate Payment Token With Payment Sandbox
      POST
    • Cancel Recurring Payment Sandbox
      POST
    • Fast Checkout
      POST
    • Fast Checkout Sandbox
      POST

      Generate Payment Token With Payment Sandbox

      POST
      /sandbox/api/requestPaymentTokenAndPay

      Request

      Authorization
      Provide your bearer token in the
      Authorization
      header when making requests to protected resources.
      Example:
      Authorization: Bearer ********************
      Body Params application/json
      merchantId
      string 
      required
      paymentTokenReferenceRequest
      string 
      required
      walletName
      string 
      required
      amount
      string 
      required
      paymentCurrency
      string 
      required
      paymentDescription
      string 
      required
      payerName
      string 
      required
      payerReference
      string 
      required
      payerAccountId
      integer 
      required
      profileId
      integer 
      required
      Example
      {
        "merchantId": "71722326657622",
        "paymentTokenReferenceRequest": "Payer0008",
        "walletName": "ZimSwitch",
        "amount": "120.50",
        "paymentCurrency": "USD",
        "paymentDescription": "School Fees FullPayment",
        "payerName": "Keith Chimeto",
        "payerReference": "1a1401fe-21cd-4111-a980-c0ecf6675951",
        "payerAccountId": 9,
        "profileId": 4
      }

      Request samples

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location --request POST 'https://live.smatpay.africa/sandbox/api/requestPaymentTokenAndPay' \
      --header 'Content-Type: application/json' \
      --data-raw '{
          "merchantId":"71722326657622",
          "paymentTokenReferenceRequest":"Payer0008",
          "walletName": "ZimSwitch",
          "amount": "120.50",
          "paymentCurrency": "USD",
          "paymentDescription": "School Fees FullPayment",
          "payerName": "Keith Chimeto",
          "payerReference": "1a1401fe-21cd-4111-a980-c0ecf6675951",
          "payerAccountId": 9,
          "profileId": 4
      }'

      Responses

      🟢200GeneratePaymentToken
      text/plain
      Body
      checkOutStatus
      string 
      required
      checkOutId
      string 
      required
      checkOutRedirectUrl
      string 
      required
      checkOutToken
      string 
      required
      Example
      {
        "checkOutStatus": "Success",
        "checkOutId": "FD5F75C50D264FF34D8BAB9797B3557C.uat01-vm-tx04",
        "checkOutRedirectUrl": "https://staging-payments.smatpay.africa?paymentCode=FD5F75C50D264FF34D8BAB9797B3557C.uat01-vm-tx04",
        "checkOutToken": ""
      }
      Modified at 2025-03-10 20:49:15
      Previous
      Generate Payment Token Sandbox
      Next
      Cancel Recurring Payment Sandbox
      Built with