Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.1.0",
"info": {
"title": "payments-api-v2-1",
"version": "2"
},
"servers": [
{
"url": "https://test.api.interchecks.io"
}
],
"components": {
"securitySchemes": {
"sec0": {
"type": "oauth2",
"flows": {}
}
}
},
"security": [
{
"sec0": []
}
],
"paths": {
"/api/v2/oauth2/token": {
"post": {
"summary": "Get Access Token",
"description": "Generate an OAuth 2.0 access token in the form of a JWT. The `access_token` returned in the response is to be used when authenticating API calls as the Authentication `Bearer` value.",
"operationId": "get-access-token",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "`Basic` authorization header with `clientId:secret` base64 encoded.",
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string",
"default": "application/x-www-form-urlencoded"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"grant_type": {
"type": "string",
"default": "client_credentials"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"access_token\": \"eyJraWQiOiI1N0ZlMz....\",\n \"expires_in\": 900,\n \"token_type\": \"Bearer\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"access_token": {
"type": "string",
"example": "eyJraWQiOiI1N0ZlMz...."
},
"expires_in": {
"type": "integer",
"example": 900,
"default": 0
},
"token_type": {
"type": "string",
"example": "Bearer"
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Invalid Client ID or Secret": {
"value": "{\n \"error\": \"invalid_client\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "invalid_client"
}
}
}
}
}
}
},
"deprecated": false,
"x-readme": {
"code-samples": [
{
"language": "curl",
"code": "curl -X POST -u \"clientId:secret\" \\\n-d \"grant_type=client_credentials\" \\\n--url https://test.api.interchecks.io/oauth2/token"
}
],
"samples-languages": [
"curl"
]
}
}
},
"/api/v2/{payer_id}/recipients": {
"post": {
"summary": "Create Recipient",
"description": "Create Individual or Company\n\n`201` - Created, will include a `Location` response header\n`400` - Bad Request, missing or invalid parameters\n`409` - Recipient already exists",
"operationId": "create-recipient",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Recipient email"
},
"first_name": {
"type": "string",
"description": "Recipient first name (required for individual)"
},
"last_name": {
"type": "string",
"description": "Recipient last name (required for individual)"
},
"company_name": {
"type": "string",
"description": "Recipient company name (required if recipient is not an individual)"
},
"reference_id": {
"type": "string",
"description": "Recipient reference ID for payer (optional)"
},
"dob": {
"type": "string",
"description": "Recipient date of birth (optional)",
"format": "date"
}
}
},
"examples": {
"Recipient - Individual": {
"value": {
"email": "sherlock@example.com",
"first_name": "Sherlock",
"last_name": "Holmes",
"reference_id": "payee-123"
}
},
"Recipient - Company": {
"value": {
"email": "sherlock.llc@example.com",
"company_name": "Sherlock and Watson, LLC",
"reference_id": "payee-456"
}
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/json": {
"examples": {
"Created Individual": {
"value": "{\n \"recipient_id\": \"REejizS5fnTLiQYhGTKYXZaQ==\",\n \"reference_id\": \"payee-123\",\n \"email\": \"sherlock@example.com\",\n \"first_name\": \"Sherlock\",\n \"last_name\": \"Holmes\"\n}"
},
"Created Company": {
"value": "{\n \"recipient_id\": \"REsuhBF74VRkGNYf-fmrCYeA==\",\n \"reference_id\": \"payee-456\",\n \"email\": \"sherlock.llc@example.com\",\n \"company_name\": \"Sherlock and Watson, LLC\"\n}"
}
},
"schema": {
"oneOf": [
{
"title": "Created Individual",
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
},
"reference_id": {
"type": "string",
"example": "payee-123"
},
"email": {
"type": "string",
"example": "sherlock@example.com"
},
"first_name": {
"type": "string",
"example": "Sherlock"
},
"last_name": {
"type": "string",
"example": "Holmes"
}
}
},
{
"title": "Created Company",
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"example": "REsuhBF74VRkGNYf-fmrCYeA=="
},
"reference_id": {
"type": "string",
"example": "payee-456"
},
"email": {
"type": "string",
"example": "sherlock.llc@example.com"
},
"company_name": {
"type": "string",
"example": "Sherlock and Watson, LLC"
}
}
}
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 400,\n \"error_code\": \"ERR_INVALID_PARAMETER\",\n \"error_message\": \"Missing or invalid request parameters\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 400,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_PARAMETER"
},
"error_message": {
"type": "string",
"example": "Missing or invalid request parameters"
}
}
}
}
}
},
"409": {
"description": "409",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"recipient_id\": \"REejizS5fnTLiQYhGTKYXZaQ==\",\n \"reference_id\": \"payee-123\",\n \"email\": \"sherlock@example.com\",\n \"first_name\": \"Sherlock\",\n \"last_name\": \"Holmes\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
},
"reference_id": {
"type": "string",
"example": "payee-123"
},
"email": {
"type": "string",
"example": "sherlock@example.com"
},
"first_name": {
"type": "string",
"example": "Sherlock"
},
"last_name": {
"type": "string",
"example": "Holmes"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/recipients/{recipient_id}": {
"put": {
"summary": "Update Recipient",
"description": "Update Recipient profile. A full request object is required, as the Recipient record will be overwritten with the supplied parameters.\n\n`200` - Request succeeded\n`400` - Bad Request, missing or invalid parameters\n`404` - Recipient ID not found\n`409` - Recipient email already exists for another profile",
"operationId": "update-recipient",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "recipient_id",
"in": "path",
"description": "Recipient ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Recipient email"
},
"first_name": {
"type": "string",
"description": "Recipient first name (required for individual)"
},
"last_name": {
"type": "string",
"description": "Recipient last name (required for individual)"
},
"company_name": {
"type": "string",
"description": "Recipient company name (required if recipient is not an individual)"
},
"reference_id": {
"type": "string",
"description": "Recipient reference ID for payer"
},
"dob": {
"type": "string",
"description": "Recipient date of birth (optional)",
"format": "date"
}
}
},
"examples": {
"Recipient - Individual": {
"value": {
"email": "sherlock@example.com",
"first_name": "Sherlock",
"last_name": "Holmes",
"reference_id": "payee-123"
}
},
"Recipient - Company": {
"value": {
"email": "sherlock.llc@example.com",
"company_name": "Sherlock and Watson, LLC",
"reference_id": "payee-456"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Individual": {
"value": "{\n \"recipient_id\": \"REejizS5fnTLiQYhGTKYXZaQ==\",\n \"reference_id\": \"payee-123\",\n \"email\": \"sherlock@example.com\",\n \"first_name\": \"Sherlock\",\n \"last_name\": \"Holmes\"\n}"
},
"Company": {
"value": "{\n \"recipient_id\": \"REsuhBF74VRkGNYf-fmrCYeA==\",\n \"reference_id\": \"payee-456\",\n \"email\": \"sherlock.llc@example.com\",\n \"company_name\": \"Sherlock and Watson, LLC\"\n}"
}
},
"schema": {
"oneOf": [
{
"title": "Individual",
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
},
"reference_id": {
"type": "string",
"example": "payee-123"
},
"email": {
"type": "string",
"example": "sherlock@example.com"
},
"first_name": {
"type": "string",
"example": "Sherlock"
},
"last_name": {
"type": "string",
"example": "Holmes"
}
}
},
{
"title": "Company",
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"example": "REsuhBF74VRkGNYf-fmrCYeA=="
},
"reference_id": {
"type": "string",
"example": "payee-456"
},
"email": {
"type": "string",
"example": "sherlock.llc@example.com"
},
"company_name": {
"type": "string",
"example": "Sherlock and Watson, LLC"
}
}
}
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 400,\n \"error_code\": \"ERR_INVALID_PARAMETER\",\n \"error_message\": \"Missing or invalid request parameters\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 400,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_PARAMETER"
},
"error_message": {
"type": "string",
"example": "Missing or invalid request parameters"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 404,\n \"error_code\": \"ERR_INVALID_RECIPIENT_ID\",\n \"error_message\": \"Invalid recipient ID\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 404,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_RECIPIENT_ID"
},
"error_message": {
"type": "string",
"example": "Invalid recipient ID"
}
}
}
}
}
},
"409": {
"description": "409",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 409,\n \"error_code\": \"ERR_EMAIL_IN_USE\",\n \"error_message\": \"Recipient email is assigned to another profile\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 409,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_EMAIL_IN_USE"
},
"error_message": {
"type": "string",
"example": "Recipient email is assigned to another profile"
}
}
}
}
}
}
},
"deprecated": false
},
"patch": {
"summary": "Patch Recipient",
"description": "Patch Recipient profile. Parameters included in the request will be applied to the Recipient. Omitted parameters will not be changed.\n\n`200` - Request succeeded\n`400` - Bad Request, missing or invalid parameters\n`404` - Recipient ID not found\n`409` - Recipient email already exists for another profile",
"operationId": "patch-recipient",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "recipient_id",
"in": "path",
"description": "Recipient ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Recipient email"
},
"first_name": {
"type": "string",
"description": "Recipient first name (required for individual)"
},
"last_name": {
"type": "string",
"description": "Recipient last name (required for individual)"
},
"company_name": {
"type": "string",
"description": "Recipient company name (required if recipient is not an individual)"
},
"reference_id": {
"type": "string",
"description": "Recipient reference ID for payer (optional)"
},
"dob": {
"type": "string",
"description": "Recipient date of birth",
"format": "date"
}
}
},
"examples": {
"Recipient - Individual": {
"value": {
"email": "sherlock@example.com",
"first_name": "Sherlock",
"last_name": "Holmes",
"reference_id": "payee-123"
}
},
"Recipient - Company": {
"value": {
"email": "sherlock.llc@example.com",
"company_name": "Sherlock and Watson, LLC",
"reference_id": "payee-456"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Individual": {
"value": "{\n \"recipient_id\": \"REejizS5fnTLiQYhGTKYXZaQ==\",\n \"reference_id\": \"payee-123\",\n \"email\": \"sherlock@example.com\",\n \"first_name\": \"Sherlock\",\n \"last_name\": \"Holmes\"\n}"
},
"Company": {
"value": "{\n \"recipient_id\": \"REsuhBF74VRkGNYf-fmrCYeA==\",\n \"reference_id\": \"payee-456\",\n \"email\": \"sherlock.llc@example.com\",\n \"company_name\": \"Sherlock and Watson, LLC\"\n}"
}
},
"schema": {
"oneOf": [
{
"title": "Individual",
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
},
"reference_id": {
"type": "string",
"example": "payee-123"
},
"email": {
"type": "string",
"example": "sherlock@example.com"
},
"first_name": {
"type": "string",
"example": "Sherlock"
},
"last_name": {
"type": "string",
"example": "Holmes"
}
}
},
{
"title": "Company",
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"example": "REsuhBF74VRkGNYf-fmrCYeA=="
},
"reference_id": {
"type": "string",
"example": "payee-456"
},
"email": {
"type": "string",
"example": "sherlock.llc@example.com"
},
"company_name": {
"type": "string",
"example": "Sherlock and Watson, LLC"
}
}
}
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 400,\n \"error_code\": \"ERR_INVALID_PARAMETER\",\n \"error_message\": \"Missing or invalid request parameters\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 400,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_PARAMETER"
},
"error_message": {
"type": "string",
"example": "Missing or invalid request parameters"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 404,\n \"error_code\": \"ERR_INVALID_RECIPIENT_ID\",\n \"error_message\": \"Invalid recipient ID\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 404,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_RECIPIENT_ID"
},
"error_message": {
"type": "string",
"example": "Invalid recipient ID"
}
}
}
}
}
},
"409": {
"description": "409",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 409,\n \"error_code\": \"ERR_EMAIL_IN_USE\",\n \"error_message\": \"Recipient email is assigned to another profile\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 409,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_EMAIL_IN_USE"
},
"error_message": {
"type": "string",
"example": "Recipient email is assigned to another profile"
}
}
}
}
}
}
},
"deprecated": false
},
"get": {
"summary": "Get Recipient",
"description": "Retrieve Recipient by ID.\n\n`200` - Request succeeded\n`404` - Recipient ID not found",
"operationId": "get-recipient-by-id",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "recipient_id",
"in": "path",
"description": "Recipient ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Individual": {
"value": "{\n \"recipient_id\": \"REejizS5fnTLiQYhGTKYXZaQ==\",\n \"reference_id\": \"payee-123\",\n \"email\": \"sherlock@example.com\",\n \"first_name\": \"Sherlock\",\n \"last_name\": \"Holmes\"\n}"
},
"Company": {
"value": "{\n \"recipient_id\": \"REsuhBF74VRkGNYf-fmrCYeA==\",\n \"reference_id\": \"payee-456\",\n \"email\": \"sherlock.llc@example.com\",\n \"company_name\": \"Sherlock and Watson, LLC\"\n}"
}
},
"schema": {
"oneOf": [
{
"title": "Individual",
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
},
"reference_id": {
"type": "string",
"example": "payee-123"
},
"email": {
"type": "string",
"example": "sherlock@example.com"
},
"first_name": {
"type": "string",
"example": "Sherlock"
},
"last_name": {
"type": "string",
"example": "Holmes"
}
}
},
{
"title": "Company",
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"example": "REsuhBF74VRkGNYf-fmrCYeA=="
},
"reference_id": {
"type": "string",
"example": "payee-456"
},
"email": {
"type": "string",
"example": "sherlock.llc@example.com"
},
"company_name": {
"type": "string",
"example": "Sherlock and Watson, LLC"
}
}
}
]
}
}
}
},
# --- truncated at 32 KB (335 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/interchecks/refs/heads/main/openapi/interchecks-payments-api-v2.json