AApt Commerce
Sign inGet started
Show for

Partner API

Programmatically manage sub-merchants and onboarding as a platform partner.

Endpoints

POST
/api/v1/partner/merchants
GET
/api/v1/partner/merchants
GET
/api/v1/partner/merchants/:id
PATCH
/api/v1/partner/merchants/:id
POST
/api/v1/partner/merchants/:id/activate
GET
/api/v1/partner/reports/volume
GET
/api/v1/partner/reports/payouts

Creating a Sub-Merchant

const merchant = await apt.partner.merchants.create({
  business_name: 'Coffee Shop LLC',
  business_type: 'llc',
  contact: {
    name: 'Jane Doe',
    email: 'jane@coffeeshop.com',
    phone: '+1-555-0123',
  },
  address: {
    line1: '123 Main St',
    city: 'Portland',
    state: 'OR',
    postal_code: '97201',
    country: 'US',
  },
  processing: {
    methods: ['card', 'ach'],
    monthly_volume: 50000,
    average_ticket: 25,
  },
});

console.log(merchant.id);     // "merch_abc123"
console.log(merchant.status); // "pending_review"

Merchant Lifecycle

draftMerchant created, onboarding incomplete.
pending_reviewSubmitted for compliance review.
activeApproved and able to process payments.
suspendedAccount suspended due to compliance or risk issues.

Access

Partner API access requires an Enterprise plan. Apply to become a partner.