Creating a Payment Method

This page describes how to add a payment method for an ICHRA enrolling member

Checklist

• Identify Member & Coverage

• Create Associated Payment Method

• Store Response Id

Components

Identify Member & Coverage

In the Platform system, elections are underway for a given set of members.

After creating members, verify presence of an id and verify their current state in the Ideon system.

For any created member, you can use their id to create a payment method. This payment method will be used to initiate a binder payment, and set up automatic payments.

Create Associated Payment Method

Description

For a relevant member, construct a POST Request to the endpoint:

• /members/{id}/payment_methods

Determine what type of payment method is to be created:

• a Card (debit, credit, etc.)

• a Bank Account (ACH, EFT, etc.)

Gather details for each field of the Payment Method. See a full Mapping Guide here for details on each field in the request.

Request

Create Payment Method
{
 "payment_method": {
   "payment_type": "card",
   "card_number": "999943434343433",
   "security_code": "999",
   "expiration_date": "2026-07-01",
   "first_name": "Joe",
   "last_name": "Doe",
   "billing_address": {
    "address_line_1": "123 Main Ave",
    "address_line_2": "Suite 1",
    "city": "Anytown",
    "zip": "12345",
    "fips_county_code": "34567"
 }
}

Store Response Id

In order to refer to this payment method later your system should save the successful response body and store the id associated with the payment method. See Payment Examples for full response and further request examples.

If no id is present, check the Status of the request to determine if you received an Error on formatting or content of the request.

An error that requires you to update the request body content or format is generally listed as Status 422

• Save and analyze response

• Confirm Success Status

  • If Failure, Store and Address this Failure

  • Once addressed, Retry the Request

• Store the Response payload, particularly the id for later use