Create Subscription
To complete this transaction, merchant is expected to redirect to the 3DSecure site via the redirect URL provided with the response below. However if the redirect url is not returned and the code is S20 and the message is transaction is pending, the Validate OTP endpoint should be called as the customer would have received a token either by email or sms on the customers' phone.
To get the subscription created or the status of a subscription for the customer, the GET Subscription endpoint is called by passing the paymentReference as billingId.
Authentication
Request body
Response body
curl -X POST
URL: https://seerbitapi.com/api/v2/recurring/subscribes
Authorization: Bearer {Token}
"Content-Type: application/json"
{
"publicKey":"SBTEST**************************viTF",
"paymentReference":"WQ6676yPOpr12348o",
"planId":"",
"cardNumber":"2223000000000007",
"expiryMonth":"05",
"callbackUrl":"https://checkout.seerbitapi.com",
"expiryYear":"21",
"cvv":"100",
"pin":"1234",
"amount":"20",
"currency":"NGN",
"productDescription":"Test Token",
"productId":"Terrain",
"country":"NG",
"startDate":"2019-01-11 00:00:00",
"cardName":"Bola Olat",
"billingCycle":"DAILY",
"email":"[email protected]",
"mobileNumber":"09022323537",
"billingPeriod":"4",
"subscriptionAmount": false
}
{
"status": "SUCCESS",
"data": {
"code": "S20",
"payments": {
"paymentReference": "WQ6676yPOpr12348o",
"linkingReference": "F194900041578648252258",
"redirectUrl": "https://staging.seerbitapigateway.com/seerbit/card-dispatch?sredref=F194900041578648252258"
},
"message": "Transaction is pending"
}
}
Plan intervals we have are : DAILY, WEEKLY, MONTHLY and ANNUALLY.
Parameter
Description
Type
publicKey
this is the merchant public key
string
required
paymentReference
this is the uniques identifier for a transaction to be generated by the merchant
string
required
planId
the planId represents a product of the merchant that the customer wants to pay for e.g DSTV bouqet.
string
optional
cardNumber
the debit card number
string
required
expiryMonth
this is the card's expiry month
string
required
callbackUrl
this is the callback url supplied by the merchant so that SeerBit can redirect back to it
string
required
expiryYear
this is the card's expiry year
string
required
cvv
this is the 3 digit code behind the debit card
string
required
amount
this is the amount to be paid
string
required
currency
this is the currency the transaction is to be carried out in
string
required
productDescription
this is the product description supplied by the merchant
string
optional
productId
this is the productId entered bu the merchant
string
optional
country
this is the country the customer is doing the transaction from
string
required
startDate
this is the day to commence billing of customers
string
required
cardName
this is the name of the cardholder
strung
optional
billingCycle
this is the rate of reoccurrence of the charge to the tokenized card
string
required
subscriptionAmount
this is passed as true if the subscription amount is to be charged at the point of creating subscription. It is passed as false if the default amount of SeerBit is to be charged at the point of creating subscription.
boolean
optional
email
this is the email of the customer
string
required
mobileNumber
this is the customer's phone number
string
optional
customerId
this is the reference unique to the customers
string
billingPeriod
this is the number of times seerBit will do a recurrent billing
string
required
redirectUrl
this is returned when the payment link service is called
string
optional
linkingReference
this is the internal gateway response
string
optional
Copy link