Skip to main content

APM Payment with Token

Process an APM payment using a saved customer token.

Endpoint Information

Name: S2S APM Payment with Customer Token
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

{
"customerToken": "4fd158b995xxxxxxxxxed981020f",
"reference": "XYOCJXEBFJACK0002",
"merchantAccountId": "{{your_account_no}}",
"currency": "KES",
"amount": "20",
"ttl": "10",
"solutionUniqueId": ["f5a112d7-77f6-4573-8b54-1a3d9d59f750"],
"additionalInfo": {
"ewallet_account_id": "+254111111111",
"document": "11111111111"
}
}

Key Parameters

ParameterTypeRequiredDescription
customerTokenstringYesThe saved customer token
solutionUniqueIdarrayYesThe APM solution ID
additionalInfoobjectYesRequired dynamic fields

Response

Success Response

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