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

string

required

Id of payment Link when updating

paymentLinkName

string

required

Name of Payment Link

Example:

paymentLinkDescription

string

required

Description of payments

Example:

paymentLinkReference

string

required

Example:

paymentLinkAmount

string

required

Default Amount

Example:

paymentLinkType

string

required

ONCE_OFF_FIXED,OPEN_FIXED_AMOUNT,OPE

Example:

ONCE_OFF_FIXED

paymentLinkImageType

string

required

Image Attachment

Example:

NEW

paymentLinkProfileId

string

required

NEW/UPDATE/NONE

Example:

paymentLinkStartDate

string

required

Payment profile Id

Example:

paymentLinkEndDate

string

required

Start Date formart yyyy-MM-dd

Example:

paymentLinkCurrency

string

required

End Date formart yyyy-MM-dd

Example:

paymentLinkCurrencyId

string

required

Example:

paymentLinkOtherCurrencies

string

required

Example:

paymentLinkCustomerRedirectUrl

string

required

Example:

paymentCustomerFailRedirectUrl

string

required

Image Attachment

Example:

paymentLinkEmail

string

required

Example:

paymentLinkImage

file

required

Image Attachment

paymentPayerFullNames

string

required

Example:

paymentPayerEmailAddress

string

required

Example:

paymentPayerAddress

string

required

Example:

paymentPayerMobile

string

required

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://live.smatpay.africa/api/merchant/fastCheckOut' \
--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}}"'

Responses

🟢200Fast Checkout

text/plain

Body

status

string

required

paymentLink

object

required

paymentProfileName

string

required

paymentProfileDescription

string

required

paymentLinkReference

string

required

paymentLinkUrl

string

required

paymentLinkAmount

integer

required

paymentLinkType

string

required

paymentLinkToken

string

required

paymentLinkImageUrl

string

required

paymentLinkStartDate

string

required

paymentLinkEndDate

string

required

paymentLinkIsActive

boolean

required

createdAt

string

required

integer

required

message

string

required

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,
    "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-03-10 20:49:15

Cancel Recurring Payment Sandbox

Fast Checkout Sandbox