APM Required Fields

Get dynamic fields required for an APM Server-to-Server payment.

Endpoint Information

Name: Get Direct Server to Server APM Payments Required Fields
Method: GET
URL: {{base_url}}/api/v1/get-apm-s2s-requirement/{{solutionUuid}}?merchantAccountId={{your_account_no}}&type=payin

Description

Different Alternative Payment Methods (e.g., PIX, MPESA) require different customer details. Use this endpoint to fetch the required schema.

Authentication

Type: Basic Auth

• Username: App Key
• Password: Secret Key

Query Parameters

Parameter	Type	Required	Description
merchantAccountId	string	Yes	Your merchant account ID
type	string	Yes	payin or payout

Response

Success Response

{
  "success": true,
  "message": "success.",
  "data": [
    {
      "name": "Ewallet Account",
      "type": "text",
      "value": null,
      "required": "true",
      "input_name": "ewallet_account_id"
    }
  ]
}