Fetch a Payout Profile

Overview

Retrieve the details of a previously created Payout Profile by its unique ID. Use this endpoint to view the complete settlement configuration for a merchant's payouts and fees.

Resource Access

• User Permissions: Admin users only
• Endpoint: GET /payout_profiles/\{payout_profile_id}

Arguments

Parameter	Type	Required	Description
payout_profile_id	string	Yes	The unique ID of the Payout Profile to retrieve

Example Request

curl -X GET \
  'https://api.ahrvo.network/payments/na/payout_profiles/PPpayoutProfile123' \
  -u username:password \
  -H 'Content-Type: application/json'

Example Response (NET Settlement)

{
  "id": "PPpayoutProfile123",
  "created_at": "2023-05-15T14:30:00Z",
  "updated_at": "2023-09-20T10:15:00Z",
  "linked_id": "MUmerchantExample456",
  "linked_type": "MERCHANT",
  "type": "NET",
  "tags": {
    "merchant_name": "Acme Corp",
    "settlement_type": "standard"
  },
  "net": {
    "frequency": "DAILY",
    "rail": "NEXT_DAY_ACH",
    "payment_instrument_id": "PIpaymentInstrument789",
    "submission_delay_days": 1,
    "start_time": 18,
    "time_zone": "America/New_York",
    "day_of_month": null,
    "funding_requirement": "DEFAULT"
  },
  "gross": null,
  "_links": {
    "self": {
      "href": "https://api.ahrvo.network/payments/na/payout_profiles/PPpayoutProfile123"
    },
    "merchant": {
      "href": "https://api.ahrvo.network/payments/na/merchants/MUmerchantExample456"
    },
    "payment_instrument": {
      "href": "https://api.ahrvo.network/payments/na/payment_instruments/PIpaymentInstrument789"
    }
  }
}

Example Response (GROSS Settlement)

{
  "id": "PPpayoutProfile456",
  "created_at": "2023-06-10T09:00:00Z",
  "updated_at": "2023-10-05T16:45:00Z",
  "linked_id": "MUmerchantExample789",
  "linked_type": "MERCHANT",
  "type": "GROSS",
  "tags": {
    "merchant_name": "Big Shop LLC",
    "settlement_type": "premium"
  },
  "net": null,
  "gross": {
    "payouts": {
      "frequency": "WEEKLY",
      "rail": "SAME_DAY_ACH",
      "payment_instrument_id": "PIpaymentInstrument111",
      "submission_delay_days": 0,
      "start_time": 10,
      "time_zone": "America/Los_Angeles",
      "day_of_month": null,
      "funding_requirement": "DEFAULT"
    },
    "fees": {
      "frequency": "MONTHLY",
      "rail": "NEXT_DAY_ACH",
      "payment_instrument_id": "PIpaymentInstrument222",
      "submission_delay_days": 2,
      "start_time": 14,
      "time_zone": "America/Los_Angeles",
      "day_of_month": 1,
      "funding_requirement": "DEFAULT"
    }
  },
  "_links": {
    "self": {
      "href": "https://api.ahrvo.network/payments/na/payout_profiles/PPpayoutProfile456"
    },
    "merchant": {
      "href": "https://api.ahrvo.network/payments/na/merchants/MUmerchantExample789"
    },
    "payout_payment_instrument": {
      "href": "https://api.ahrvo.network/payments/na/payment_instruments/PIpaymentInstrument111"
    },
    "fee_payment_instrument": {
      "href": "https://api.ahrvo.network/payments/na/payment_instruments/PIpaymentInstrument222"
    }
  }
}

Additional Information

• Settlement Types:
  • NET Settlement (type: "NET"):
    • Fees are automatically deducted from payouts
    • Results in a single net transfer to the merchant
    • The net object contains the schedule configuration
    • Simpler accounting for merchants
    • Example: Merchant receives $950 if they earned $1,000 and owe $50 in fees
  • GROSS Settlement (type: "GROSS"):
    • Payouts and fees are separate transactions
    • The gross object contains separate payouts and fees schedules
    • Provides more transparency and detailed reporting
    • Allows different frequencies and rails for payouts vs fees
    • Example: Merchant receives $1,000 payout, then separately pays $50 in fees
• Schedule Fields:
  • frequency: Settlement frequency
    • DAILY: Settles every day
    • WEEKLY: Settles once per week
    • MONTHLY: Settles once per month on specified day
  • rail: Payment rail for the transfer
    • NEXT_DAY_ACH: Standard ACH, funds arrive next business day
    • SAME_DAY_ACH: Expedited ACH, funds arrive same business day (higher cost)
    • PUSH_TO_CARD: Send to debit card, typically instant (for payouts only)
  • payment_instrument_id: The bank account or card ID for the transfer
    • Must be verified before use
    • For NET, one payment instrument for combined settlement
    • For GROSS, separate instruments for payouts and fees (can be the same or different)
  • submission_delay_days: Number of days to delay settlement after calculation
    • 0 = settle immediately when scheduled
    • 1+ = hold for specified days before submitting
    • Used for risk management or merchant preferences
  • start_time: Hour of day (0-23) when settlement window opens
    • Example: 18 = 6:00 PM in the specified time zone
  • time_zone: IANA time zone for scheduling
    • Example: America/New_York, America/Los_Angeles, America/Chicago
    • Ensures consistent settlement times across regions
  • day_of_month: For MONTHLY frequency, which day to process
    • Required when frequency is MONTHLY
    • Range: 1-31 (28-31 may vary by month)
    • Example: 1 = first day of each month
  • funding_requirement: Funding mechanism (typically DEFAULT)
• Linked Resources:
  • linked_id: The Merchant ID this profile belongs to
  • linked_type: Always "MERCHANT"
• Use Cases:
  • Review merchant settlement configuration before processing payouts
  • Verify payment instruments and schedules are correctly configured
  • Troubleshoot settlement timing or delivery issues
  • Audit merchant payout settings for compliance
  • Determine when next settlement will occur
• Automatic Creation: Payout Profiles are automatically created when a Merchant is onboarded
• Configuration Updates: Use PUT /payout_profiles/{payout_profile_id} to modify settlement configuration
• Related Resources: Use the _links object to navigate to:
  • The Merchant this profile belongs to
  • Payment Instruments used for payouts and fees