Fiserv APEX XP2

Category: Core Connectors

Market: US

Overview

The Fiserv APEX XP2 connector exposes a REST API (/apex/v1/...) that translates inbound JSON requests from Data Core into SOAP operations against APEX XP2 Member, Financial, and Lending services.

The connector provides:

• Member and individual operations (lookup, retrieval, updates, membership management)
• Account operations (creation, update, history summary, overdraft protection)
• ACH operations (allocations, payees, pending transactions)
• Card operations (assign, update, lookup)
• Alerts and stops management
• System details retrieval
• Financial transaction submission with multiple transaction unit types

The connector handles SOAP routing and WS-Security authentication using Vault-provided configuration.

Vault Configuration

Example Vault Configuration

{
                "memberServicesUrl": "https://<host>/<member-path>",
                "financialServicesUrl": "https://<host>/<financial-path>",
                "lendingServicesUrl": "https://<host>/<lending-path>",
                "securityConfig": {
                "licenseKey": "string",
                "creditUnionId": "string",
                "operatorId": "string",
                "password": "string",
                "workstation": "string"
                }
        }

The SOAP username is built as: licenseKey.creditUnionId.operatorId.workstation.

Member Services

Member services allow you to look up and manage individuals and memberships, create and update accounts, manage overdraft protection, issue and update plastic cards, manage ACH payees and allocations, and create alerts and stops.

Individuals and Membership

Individual Lookup

POST /apex/v1/individuals/lookup

{
  "lookupFields": {}
}

Sample response:

{
  "individualLookupData1": {
    "individualId": 281528,
    "individualType": "Individual"
  },
  "totalRecords": 1
}

Get Individual

GET /apex/v1/individuals/{individualId}

Sample response:

{
  "individualDetail5": {
    "individualId": 281528,
    "lastName": "Smith",
    "firstName": "John"
  }
}

Create Member

POST /apex/v1/members

{
  "assignMembership": {
    "primaryIndividualId": 12345
  },
  "overrideData": {}
}

Sample response:

{
  "transactionResult": {},
  "errorMessage": null
}

Update Member

PUT /apex/v1/members/{memberId}

{
  "memberId": 13245
}

PATCH /apex/v1/members/{memberId} (partial update)

{
  "memberId": 13245,
  "affiliation": "Primary",
  "pin": "1234"
}

Validation: The memberId in the URL must match the memberId in the request body.

Accounts and Overdraft Protection

Create Account

POST /apex/v1/accounts

{
  "effectiveDate": "2026-06-16T00:00:00Z",
  "accountCreationDetail3": [{}],
  "overrideData": {}
}

Sample response:

{
  "transactionResult": {},
  "accountDetail3": {
    "accountId": 54321,
    "accountType": "CHECKING"
  }
}

Update Account

PUT /apex/v1/accounts/{accountId}

{
  "accountId": 54321,
  "memberId": 67890
}

Validation: The accountId in the URL must match the accountId in the request body.

Account History Summary

POST /apex/v1/members/{memberId}/accounts/{accountId}/history/summary

{
  "individualId": 16,
  "fromDate": "2024-01-01T00:00:00Z",
  "toDate": "2024-12-31T00:00:00Z",
  "pageNumber": 1,
  "itemCount": 10,
  "order": "Ascending | Descending"
}

Validation:

• fromDate and toDate are required.
• pageNumber must be at least 1.
• itemCount must be between 1 and 100.

Overdraft Protection

POST /apex/v1/members/{memberId}/accounts/{accountId}/odp

{
  "odpSourceUpdate": [],
  "overdraftDrainMethodType": "DRAIN_IN_ORDER",
  "overrideData": {}
}

DELETE /apex/v1/members/{memberId}/accounts/{accountId}/odp

{
  "odpSourceUpdate": [],
  "overrideData": {}
}

Cards

Assign Card

POST /apex/v1/members/{memberId}/cards

{
  "cardBin": "string",
  "binExtension": "string",
  "cardCust": "string",
  "plasticFamilyClass": "CREDIT | DEBIT",
  "purchaseAccount": 1,
  "creditDebitDetail": {},
  "cardHolder1": {},
  "cardDetail": {},
  "overrideData": {}
}

Validation: plasticFamilyClass and purchaseAccount are required.

Update Card

POST /apex/v1/members/{memberId}/cards/update

{
  "cardBin": "string",
  "cardCust": "string",
  "purchaseAccount": 1,
  "cardDetail": {},
  "cardHolder": {},
  "atmAccess": [],
  "debitCardPeriodicFees": {},
  "overrideData": {}
}

Validation: purchaseAccount is required.

Lookup Cards

GET /apex/v1/members/{memberId}/cards/lookup

ACH

Add Allocation

POST /apex/v1/ach/allocation

{
  "allocationData": {}
}

Sample response:

{
  "memberNumber": 1234
}

Add Payee

POST /apex/v1/ach/payees

{
  "payeeData": {}
}

Sample response:

{
  "payeeNumber": 123
}

Get Pending Transactions

GET /apex/v1/members/{memberId}/ach/pending-transactions

Validation: pageNumber and itemCount must not exceed 10.

Alerts

Get Alerts

GET /apex/v1/alerts

Validation: memberId and individualId are mutually exclusive. Providing both returns a 400 error.

Create/Delete Alert

POST / DELETE /apex/v1/alerts

{
  "stopAlertType": "Membership",
  "memberId": 67890
}

System Details

Exposes a single endpoint that routes to the selected APEX SOAP service and returns system metadata.

GET /apex/v1/system-details

Financial Services

Submit financial transactions containing one or more transaction units (deposits, withdrawals, fees, loan operations, GL transactions, payroll groups).

POST /apex/v1/financial/transaction

{
  "effectiveDate": "2026-06-16T00:00:00Z",
  "printReceipt": false,
  "forcePost": false,
  "isTotalFeeRequired": false,
  "customerName": "string",
  "postInSuppliedOrder": false,
  "timeStamp": "string",
  "transactionUnits": [
    {
      "accountDeposit": {},
      "accountFee": {},
      "accountFeeReversal": {},
      "accountWithdrawal": {},
      "fundsDisbursed": {},
      "fundsReceived": {},
      "loanAddon": {},
      "loanPayment": {},
      "loanPayoff": {},
      "couplet": {},
      "merchandiseReturn": {},
      "merchandiseSell": {},
      "miscellaneousFee": {},
      "generalLedger": {},
      "externalMortgagePayment": {},
      "loanAdjustment": {},
      "payrollGroup": {}
    }
  ],
  "overrideData": {}
}

Sample response:

{
  "totalFee": 1234
}

Error Handling

Errors follow the platform-standard problem JSON format. The connector handles request validation errors locally. The Data Core platform classifies transport, timeout, and dependency failures.

Error Response Format

{
  "status": 502,
  "title": "Bad Gateway",
  "detail": "Dependency failure",
  "code": "Server",
  "instance": "/apex/v1/members/67890",
  "timestamp": "2026-06-17T09:10:00Z",
  "dependency": {
    "status": 500,
    "title": "Server was unable to process request.",
    "detail": "..."
  }
}

• code carries the upstream SOAP fault code when present (for example, Server); otherwise it contains the mapped HTTP status.
• dependency is present only for upstream/transport failures, not for client validation or 500 errors.

HTTP Status Codes

Dependency Status Mapping

Connector-Level Validation

The following scenarios return a 400 Bad Request:

• Path/body identity mismatch: PUT /apex/v1/members/{memberId}, PATCH /apex/v1/members/{memberId}, and PUT /apex/v1/accounts/{accountId} require the ID in the URL to match the ID in the request body.
• Invalid effective date format: The effectiveDate parameter must follow yyyy-MM-dd format.
• Mutually exclusive query parameters: On /apex/v1/alerts, providing both memberId and individualId returns an error.
• Out-of-range constrained fields: ACH paging limits and account-history constraints.