Skip to main content

APM Payment

Process an APM payment via Server-to-Server.

Endpoint Information

Name: S2S APM Payment Process
Method: POST
URL: {{base_url}}/api/v1/payment/process-apm-transaction

Authentication

Type: Basic Auth

  • Username: App Key
  • Password: Secret Key

Request Body

Content-Type: application/json

{
"firstName": "Danny",
"lastName": "Jack",
"reference": "XYOCJXEBFJACK0001",
"email": "[email protected]",
"dob": "1994-12-20",
"contactNumber": "01234567890",
"merchantAccountId": "{{your_account_no}}",
"country": "Kenya",
"currency": "KES",
"amount": "30",
"ttl": "10",
"solutionUniqueId": ["f5a112d7-77f6-4573-8b54-1a3d9d59f750"],
"additionalInfo": {
"ewallet_account_id": "+254111111111",
"document": "11111111111"
}
}

Key Parameters

ParameterTypeRequiredDescription
solutionUniqueIdarrayYesThe ID of the specific APM solution
additionalInfoobjectYesDynamic fields fetched from APM Required Fields

Response

Success Response

{
"success": true,
"message": "Payment initiated",
"data": {
"payment_url": "https://sandbox.cardpay.com/MI/payments/redirect?token=AB5106c2HDBe0c44f3cF7DF5",
"reference": "XYOCJXEBFJACK0002"
}
}