Skip to main content

Create Application Processor

Overview​

Enable a Processor for an Application to allow provisioning of Merchant accounts on that processor. This endpoint establishes the connection between your Application and a specific payment processing platform.

Resource Access​

  • User Permissions: Admin users only
  • Endpoint: POST /applications/\{application_id}/processors

Arguments​

ParameterTypeRequiredDescription
application_idstringYesThe unique ID of the Application
typestringYesThe type of Processor to enable (DUMMY_V1, VANTIV_V1, MASTERCARD_V1, LITLE_V1)
configobjectNoConfiguration details specific to the Processor

Example Request​

curl -X POST \
  'https://api.ahrvo.network/payments/na/applications/APapplicationExample123/processors' \
  -u username:password \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "DUMMY_V1",
    "config": {
      "canDebitBankAccount": true,
      "enablePinDebit": false,
      "achSettlementDelayDays": 3,
      "allowSplitPayouts": true,
      "defaultCurrencies": ["USD"],
      "defaultLevelTwoLevelThreeDataEnabled": false
    }
  }'

Example Response​

{
  "id": "PRprocessorExample456",
  "created_at": "2023-06-15T10:30:00Z",
  "updated_at": "2023-06-15T10:30:00Z",
  "application": "APapplicationExample123",
  "processor": "DUMMY_V1",
  "enabled": true,
  "default_merchant_profile": null,
  "application_config": {
    "can_debit_bank_account": true,
    "enable_pin_debit": false,
    "ach_settlement_delay_days": 3,
    "allow_split_payouts": true,
    "default_currencies": ["USD"],
    "default_level_two_level_three_data_enabled": false
  },
  "config": {
    "canDebitBankAccount": true,
    "enablePinDebit": false,
    "achSettlementDelayDays": 3,
    "allowSplitPayouts": true
  },
  "system_config": null,
  "_links": {
    "self": {
      "href": "https://api.ahrvo.network/payments/na/processors/PRprocessorExample456"
    },
    "application": {
      "href": "https://api.ahrvo.network/payments/na/applications/APapplicationExample123"
    }
  }
}

Example Request (Production Processor)​

curl -X POST \
  'https://api.ahrvo.network/payments/na/applications/APapplicationExample123/processors' \
  -u username:password \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "LITLE_V1",
    "config": {
      "canDebitBankAccount": true,
      "enablePinDebit": true,
      "achSettlementDelayDays": 2,
      "allowSplitPayouts": false,
      "defaultCurrencies": ["USD", "CAD"],
      "defaultLevelTwoLevelThreeDataEnabled": true,
      "merchantId": "your-merchant-id",
      "username": "your-api-username",
      "password": "your-api-password"
    }
  }'

Additional Information​

  • Processor Types:
    • DUMMY_V1: Sandbox/testing processor for development and testing
    • LITLE_V1: Vantiv/Worldpay processor for production transactions
    • VANTIV_V1: Vantiv processor
    • MASTERCARD_V1: Mastercard processor
    • Additional processors available based on your platform agreement
  • Processor Enablement: Once enabled, you can:
    • Create Merchant accounts on this processor
    • Process transactions through this acquiring platform
    • Configure processor-specific settings
    • Set up merchant profiles with fee and payout configurations
  • Configuration Options:
    • canDebitBankAccount: Allow bank account debits for ACH transactions
    • enablePinDebit: Enable PIN debit card transactions
    • achSettlementDelayDays: Number of days to delay ACH settlements (0-7 typically)
    • allowSplitPayouts: Enable split transfers for marketplace scenarios
    • defaultCurrencies: List of supported currencies (e.g., USD, CAD, EUR)
    • defaultLevelTwoLevelThreeDataEnabled: Enable Level 2/3 data for B2B/B2G transactions
  • Processor Credentials: Production processors require additional configuration:
    • Merchant IDs or account identifiers
    • API credentials (username, password, or API keys)
    • Terminal IDs for card-present processing
    • These are typically provided by your processor relationship manager
  • Testing vs Production:
    • Use DUMMY_V1 for development and testing
    • Switch to production processors (LITLE_V1, etc.) for live transactions
    • Test thoroughly in sandbox before enabling production processors
  • One Processor Per Type: You can only enable one processor of each type per Application
  • Default Merchant Profile: After enabling the processor, you can create and link a default Merchant Profile that defines:
    • Fee structures and pricing
    • Settlement schedules
    • Risk thresholds
  • Multiple Processors: Enable multiple processors to:
    • Support different payment types (e.g., one for cards, one for ACH)
    • Route to different processors based on merchant, geography, or transaction type
    • Provide redundancy and failover capabilities
    • Optimize processing costs and performance
  • Processor-Specific Settings: Each processor type may support additional configuration options specific to that platform. Consult with your processor integration team for details
  • Enabled by Default: Newly created processors are enabled automatically
  • Prerequisites: Ensure you have:
    • Completed onboarding with the processor
    • Received necessary credentials and configuration details
    • Tested the integration in a sandbox environment