APM Payments API

Process alternative payment methods (APM) including PayPal, Apple Pay, Google Pay, and more.

APM Payment (Production)

POST/api/v1/production/apm

Requires API Key

Processes Alternative Payment Method payment (PayPal, Apple Pay, Google Pay, etc.)

Request Body

{
  "orderId": "ORD-12345",
  "amount": 100.50,
  "currency": "USD",
  "merchantProfileId": 1,
  "paymentMethod": "paypal",
  "returnUrl": "https://your-domain.com/return",
  "webhookUrl": "https://your-domain.com/webhook"
}

Request Parameters

Parameter	Type	Required	Description
orderId	string	Yes	Unique order identifier
amount	number	Yes	Payment amount (minimum 0.01)
currency	string	Yes	Currency code (3 letters)
merchantProfileId	number	No	Merchant Profile ID. Defaults to PRIMARY if not provided
paymentMethod	string	Yes	Payment method: paypal, apple_pay, google_pay, etc.
returnUrl	string	No	URL to redirect after payment
webhookUrl	string	No	Webhook URL for transaction notifications

Supported Payment Methods

paypal - PayPal
apple_pay - Apple Pay
google_pay - Google Pay
Additional methods may be available based on your merchant configuration

Success Response

200

{
  "success": true,
  "data": {
    "transactionId": "TXN-20240101-ABC123",
    "orderId": "ORD-12345",
    "status": "REDIRECT",
    "redirectUrl": "https://paypal.com/checkout/...",
    "amount": 100.5,
    "currency": "USD"
  }
}

APM payments typically redirect users to the payment provider's page. Use the redirectUrlfrom the response to redirect the customer.

APM Payment (Sandbox)

POST/api/v1/sandbox/apm

Requires API Key

Processes APM payment in sandbox mode for testing.

Request Body

Same request body as production endpoint.

{
  "orderId": "ORD-12345",
  "amount": 100.50,
  "currency": "USD",
  "merchantProfileId": 1,
  "paymentMethod": "paypal",
  "returnUrl": "https://your-domain.com/return",
  "webhookUrl": "https://your-domain.com/webhook"
}