Skip to main content

APM Withdrawal Integration Guide

This document describes the end-to-end APM (Alternative Payment Method) Withdrawal flow, including prerequisites, API endpoints, request/response examples, and important behavioral notes. Follow the steps sequentially for a successful integration.

Overview​

Flow Summary​

  1. Get Active APM Solutions: Fetch available APM solutions for the merchant.
  2. Get APM PSP Required Fields: Retrieve PSP-specific required input fields.
  3. Create APM Account Token: Create a new customer and generate a token for future APM transactions.
  4. Get Customer Token: Retrieve existing customer tokens.
  5. Add New Customer Token: Create a new customer and generate a token.
  6. Refresh Customer Token: Regenerate an expired token.
  7. Create Payment Request (Deposit): Initiate a deposit required before withdrawal.
  8. Create Withdrawal Request (APM Payout): Initiate the APM payout.

Environment​

EnvironmentBase URL
Staginghttps://staging.paymid.com
Productionhttps://app.paymid.com

Authentication​

All endpoints require Basic Authentication using your App Key and Secret Key.