List Payment Packages

Partner API

GET/v1/partner/packages

Returns every payment package in the API key's corporate Package Settings view, including catalog status, subscription usability, payment methods, debit accounts, and effective settings.

Auth

Header: x-api-key

Use the bank-provisioned partner API key for authentication.

Usage Notes

Header: x-api-key
No initiatedByUserId or corporate identifiers are accepted
Legacy or system-created keys without an eligible creator fail closed
effectiveConfiguration is null when subscriptionStatus is not_subscribed

Request Fields

limitstringoptional

Number of packages per page. Default 50; maximum 100.

afterstringoptional

Opaque cursor returned by pagination.nextCursor.

x-api-keystringrequired

Payments-scoped partner key whose creator currently has Settings view, edit, or approve permission.

GET /v1/partner/packages?limit=50
x-api-key: fp_test_51H8xKlMnOpQrStUv

Sample Success Response

{
  "items": [{
    "packageId": "PKG-VENPAY-001",
    "packageCode": "VENPAY",
    "name": "Vendor Payments",
    "description": "Package for domestic vendor payments",
    "catalogStatus": "active",
    "subscriptionStatus": "active",
    "isUsable": true,
    "originSide": "corporate_native",
    "catalogConfiguration": {
      "autoApprovalEnabled": false,
      "bulkApprovalEnabled": true,
      "maskConfidentialDetails": true,
      "maxPaymentsPerBatch": 1000,
      "allowedDebitModes": ["single", "multi"],
      "defaultDebitMode": "single",
      "allowedFileRejectionModes": ["fail_full_file", "reject_invalid_rows"],
      "defaultFileRejectionMode": "fail_full_file",
      "allowedPaymentMethods": [{
        "paymentMethodCode": "NEFT",
        "minimumAmount": 1,
        "maximumAmount": 100000000
      }],
      "defaultPaymentMethodCode": "NEFT",
      "debitAccounts": [{
        "debitAccountId": "DA-LOCAL-001",
        "accountName": "Local Operating Account",
        "accountNumber": "123456789012",
        "ifscCode": "HDFC0001234",
        "status": "active",
        "allowedPaymentMethodCodes": ["NEFT"],
        "isDefault": true
      }],
      "defaultDebitAccountId": "DA-LOCAL-001"
    },
    "effectiveConfiguration": {
      "effectiveDebitMode": "single",
      "effectiveFileRejectionMode": "fail_full_file",
      "autoApprovalEnabled": false,
      "bulkApprovalEnabled": true,
      "maskConfidentialDetails": true,
      "maxPaymentsPerBatch": 500,
      "allowedPaymentMethods": [{
        "paymentMethodCode": "NEFT",
        "minimumAmount": 1,
        "maximumAmount": 50000000
      }],
      "defaultPaymentMethodCode": "NEFT",
      "defaultDebitAccountId": "DA-LOCAL-001"
    },
    "attachedBeneficiariesCount": 12,
    "attachedRolesCount": 3,
    "createdAt": 1785995834650,
    "updatedAt": 1785996834650
  }],
  "pagination": {
    "limit": 50,
    "hasMore": false,
    "nextCursor": null
  }
}

Sample Error Response

{
  "error": {
    "code": "FORBIDDEN",
    "message": "The API key is not authorized to view payment packages."
  }
}