Generate Recurring Payment Sandbox

POST

/sandbox/api/addRecurringPayment

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

object {0}

Example

{
    "recurringMerchantId": "{{merchantId}}",
    "recurringIntervalId": "{{PaymentIntervalId}}",
    "recurringIntervalName": "{{PaymentIntervalName}}",
    "recurringPaymentToken": "{{Paymenttoken}}",
    "recurringReference": "{{Reference}}",
    "recurringDescription": "{{recurringDescription}}",
    "recurringPaymentProfileId": {{profileId}},
    "recurringPaymentAccountId": {{accountId}},
    "recurringStartDate": "{{StartDate}}",
    "recurringExpiryDate": "{{ExpiryDate}}",
    "recurringCurrency":"{{currency}}",
    "recurringAmount":"{{amount}}"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://live.smatpay.africa/sandbox/api/addRecurringPayment' \
--header 'Content-Type: application/json' \
--data-raw '{
    "recurringMerchantId": "{{merchantId}}",
    "recurringIntervalId": "{{PaymentIntervalId}}",
    "recurringIntervalName": "{{PaymentIntervalName}}",
    "recurringPaymentToken": "{{Paymenttoken}}",
    "recurringReference": "{{Reference}}",
    "recurringDescription": "{{recurringDescription}}",
    "recurringPaymentProfileId": {{profileId}},
    "recurringPaymentAccountId": {{accountId}},
    "recurringStartDate": "{{StartDate}}",
    "recurringExpiryDate": "{{ExpiryDate}}",
    "recurringCurrency":"{{currency}}",
    "recurringAmount":"{{amount}}"
}'

Responses

🟢200Generate Recurring Payment Sandbox

text/plain

Body

status

string

required

message

string

required

Example

{
  "status": "Success",
  "message": "Recurring payment added successfully"
}

Modified at 2025-03-10 20:49:15

Payment Status Mastercard Production

Generate Payment Token Sandbox