Skip to content

Pay a batch's premium

POST
/credit-life/schedules/{scheduleId}/pay

Mobile money or card only. The gateway is resolved from your account — do not send one. Returns while the payment is pending; the receipt is applied on confirmation.

Authorizations

BearerAuth
Type
HTTP (bearer)

Parameters

Path Parameters

scheduleId*
Type
string
Required

Request Body

application/json
JSON
{
  
"reference": "string",
  
"mobileMoneyAccountNumber": "string",
  
"cardDetails": {
  
  
"city": "string",
  
  
"country": "string",
  
  
"address": "string",
  
  
"zip": 0
  
}
}

Responses

Pending while the payer approves on their handset. Poll GET /payments/transactions/{reference}/status — the premium is receipted automatically once the gateway confirms, not here.

application/json
JSON
{
  
"status": "string",
  
"message": "string",
  
"txnId": "string",
  
"referenceId": "string",
  
"redirectUrl": "string",
  
"warnings": [
  
  
"string"
  
]
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Built with ❤️ by Hobbiton Technologies