Payer and Recipient Information

Parameters

payer_id

• Type: string
• Required: Yes
• Description: Payer ID

recipient_id

• Type: string
• Required: Yes
• Description: Recipient ID

email

• Type: string
• Description: Recipient email

first_name

• Type: string
• Required: Yes (for individual)
• Description: Recipient first name

last_name

• Type: string
• Required: Yes (for individual)
• Description: Recipient last name

company_name

• Type: string
• Required: Yes (if recipient is not an individual)
• Description: Recipient company name

reference_id

• Type: string
• Description: Recipient reference ID for payer

dob

• Type: date
• Description: Recipient date of birth (optional)

HTTP Response Codes

200

• Description: Success Response

400

• Description: Bad Request

404

• Description: Not Found

409

• Description: Conflict

Example Request

Curl Command

curl --request PUT \
     --url https://test.api.interchecks.io/api/v2/payer_id/recipients/recipient_id \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Example Response

Application/json

200 - Individual
200 - Company
400 - Result
404 - Result
409 - Result