Skip to main content

Fetch Application Processor

Overview​

Get the details of a specific Processor enabled for an Application by type. Use this endpoint to retrieve configuration settings and status for a particular processor.

Resource Access​

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

Arguments​

ParameterTypeRequiredDescription
application_idstringYesThe unique ID of the Application
typestringYesThe type of Processor (e.g., DUMMY_V1, LITLE_V1, VANTIV_V1)

Example Request​

curl -X GET \
  'https://api.ahrvo.network/payments/na/applications/APapplicationExample123/processors/DUMMY_V1' \
  -u username:password \
  -H 'Content-Type: application/json'

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": "MPprofileExample789",
  "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,
    "defaultCurrencies": ["USD"]
  },
  "system_config": null,
  "_links": {
    "self": {
      "href": "https://api.ahrvo.network/payments/na/processors/PRprocessorExample456"
    },
    "application": {
      "href": "https://api.ahrvo.network/payments/na/applications/APapplicationExample123"
    },
    "default_merchant_profile": {
      "href": "https://api.ahrvo.network/payments/na/merchant_profiles/MPprofileExample789"
    }
  }
}

Example Response (Production Processor)​

{
  "id": "PRprocessorLitle123",
  "created_at": "2023-03-20T14:15:00Z",
  "updated_at": "2023-09-10T09:30:00Z",
  "application": "APapplicationExample123",
  "processor": "LITLE_V1",
  "enabled": true,
  "default_merchant_profile": "MPprofileLitle456",
  "application_config": {
    "can_debit_bank_account": true,
    "enable_pin_debit": true,
    "ach_settlement_delay_days": 2,
    "allow_split_payouts": false,
    "default_currencies": ["USD", "CAD"],
    "default_level_two_level_three_data_enabled": true
  },
  "config": {
    "merchantId": "your-merchant-id",
    "canDebitBankAccount": true,
    "enablePinDebit": true,
    "achSettlementDelayDays": 2,
    "allowSplitPayouts": false,
    "defaultCurrencies": ["USD", "CAD"],
    "defaultLevelTwoLevelThreeDataEnabled": true
  },
  "system_config": {
    "internal_processor_id": "12345",
    "routing_priority": 1
  },
  "_links": {
    "self": {
      "href": "https://api.ahrvo.network/payments/na/processors/PRprocessorLitle123"
    },
    "application": {
      "href": "https://api.ahrvo.network/payments/na/applications/APapplicationExample123"
    },
    "default_merchant_profile": {
      "href": "https://api.ahrvo.network/payments/na/merchant_profiles/MPprofileLitle456"
    }
  }
}

Additional Information​

  • Processor Status: The enabled field indicates whether the processor is currently active:
    • true: Processor is active and can be used for merchant onboarding and transaction processing
    • false: Processor is disabled and cannot process transactions
  • Default Merchant Profile: The processor can reference a default Merchant Profile that defines:
    • Fee structures and pricing for merchants
    • Settlement schedules and payout configurations
    • Risk profiles and velocity limits
    • This profile is used as a template when creating new merchants
  • Application Configuration: The application_config object contains settings specific to how this processor operates within the Application:
    • can_debit_bank_account: Whether bank account debits (ACH) are allowed
    • enable_pin_debit: Whether PIN debit transactions are enabled
    • ach_settlement_delay_days: Number of days to delay ACH settlements (0-7 typically)
    • allow_split_payouts: Whether split transfers/marketplace payouts are allowed
    • default_currencies: Supported currencies (USD, CAD, EUR, etc.)
    • default_level_two_level_three_data_enabled: Whether Level 2/3 data processing is enabled by default
  • Config Object: The config object contains:
    • Processor-specific configuration
    • API credentials (sanitized in responses)
    • Integration settings
    • Feature flags
  • System Config: The system_config object contains internal platform settings:
    • Typically managed by the platform
    • Not user-editable
    • May include routing rules, priority settings, etc.
  • Processor Types:
    • DUMMY_V1: Sandbox processor for testing
    • LITLE_V1: Vantiv/Worldpay production processor
    • VANTIV_V1: Vantiv production processor
    • MASTERCARD_V1: Mastercard production processor
  • Use Cases:
    • Verify processor configuration before onboarding merchants
    • Check which features are enabled (PIN debit, ACH, split payouts)
    • Retrieve the default merchant profile for creating new merchants
    • Audit processor settings and capabilities
    • Troubleshoot processing issues by reviewing configuration
  • Security: Sensitive credentials in the config object are typically masked or omitted in API responses
  • Related Resources: Use the _links object to navigate to:
    • The Application this processor is enabled for
    • The default Merchant Profile used by this processor
  • Configuration Updates: While this endpoint retrieves processor details, configuration updates may be available through a separate PUT endpoint or require platform support