{
"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"
}
}
}
]
}
}
}
},
"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"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/recipients/reference/{reference_id}": {
"get": {
"summary": "Get Recipient by Reference ID",
"description": "Retrieve Recipient by Reference ID.\n\n`200` - Request succeeded\n`404` - Recipient Reference ID not found",
"operationId": "get-recipient-by-reference-id",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "reference_id",
"in": "path",
"description": "Recipient reference 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"
}
}
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 404,\n \"error_code\": \"ERR_INVALID_RECIPIENT_REFERENCE_ID\",\n \"error_message\": \"Recipient reference ID not found\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 404,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_RECIPIENT_REFERENCE_ID"
},
"error_message": {
"type": "string",
"example": "Recipient reference ID not found"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/recipients/email/{email}": {
"get": {
"summary": "Get Recipient by Email",
"description": "Retrieve Recipient by email.\n\n`200` - Request succeeded\n`404` - Email address not found",
"operationId": "get-recipient-by-email",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "email",
"in": "path",
"description": "Recipient email address",
"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"
}
}
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 404,\n \"error_code\": \"ERR_RECIPIENT_NOT_FOUND\",\n \"error_message\": \"Recipient email not found\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 404,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_RECIPIENT_NOT_FOUND"
},
"error_message": {
"type": "string",
"example": "Recipient email not found"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/recipients/{recipient_id}/address": {
"post": {
"summary": "Add Address",
"description": "Set address for Recipient. If Recipient already has an address, the POST method will overwrite.\n\n`200` - Request Succeeded\n`400` - Bad Request, missing or invalid parameters\n`404` - Recipient ID not found",
"operationId": "add-address",
"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": {
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2 (optional)"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
}
}
},
"examples": {
"Address": {
"value": {
"address_1": "123 MAIN STREET",
"city": "BROOKLYN",
"state": "NY",
"zip": "11249",
"country": "US"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"address_1\": \"123 MAIN STREET\",\n \"city\": \"BROOKLYN\",\n \"state\": \"NY\",\n \"zip\": \"11249\",\n \"country\": \"US\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"address_1": {
"type": "string",
"example": "123 MAIN STREET"
},
"city": {
"type": "string",
"example": "BROOKLYN"
},
"state": {
"type": "string",
"example": "NY"
},
"zip": {
"type": "string",
"example": "11249"
},
"country": {
"type": "string",
"example": "US"
}
}
}
}
}
}
},
"deprecated": false
},
"get": {
"summary": "Get Address",
"description": "Get address for Recipient.\n\n`200` - Request Succeeded\n`404` - Recipient ID not found",
"operationId": "get-address",
"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": {
"Result": {
"value": "{\n \"address_1\": \"123 MAIN STREET\",\n \"city\": \"BROOKLYN\",\n \"state\": \"NY\",\n \"zip\": \"11249\",\n \"country\": \"US\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"address_1": {
"type": "string",
"example": "123 MAIN STREET"
},
"city": {
"type": "string",
"example": "BROOKLYN"
},
"state": {
"type": "string",
"example": "NY"
},
"zip": {
"type": "string",
"example": "11249"
},
"country": {
"type": "string",
"example": "US"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/recipients/{recipient_id}/emails": {
"post": {
"summary": "Add Email",
"description": "Add an email as primary/non-primary for Recipient. Adding a primary email address will demote the current primary to a secondary address. Recipients can receive payments at any active email address on record, but will only receive notifications to their primary email address.\n\n`200` - Request Succeeded\n`400` - Bad Request, missing or invalid parameters\n`404` - Recipient ID not found\n`409` - Email assigned to another Recipient profile",
"operationId": "add-email",
"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"
},
"primary": {
"type": "boolean",
"description": "Indicates if email is set as primary"
}
}
},
"examples": {
"Email": {
"value": {
"email": "sherlock.2@example.com",
"primary": "false"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
}
},
"deprecated": false
},
"get": {
"summary": "Get Emails",
"description": "Retrieves an array of `email` objects for the Recipient.\n\n`200` - Request Succeeded\n`404` - Recipient ID not found",
"operationId": "get-emails",
"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": {
"Result": {
"value": "[\n {\n \"email\": \"sherlock@example.com\",\n \"primary\": true,\n \"invalid\": false\n },\n {\n \"email\": \"sherlock.2@example.com\",\n \"primary\": false,\n \"invalid\": false\n }\n]"
}
},
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"example": "sherlock@example.com"
},
"primary": {
"type": "boolean",
"example": true,
"default": true
},
"invalid": {
"type": "boolean",
"example": false,
"default": true
}
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/recipients/{recipient_id}/verification": {
"post": {
"summary": "Verify TIN",
"description": "TIN Verification will return the `verification_status`. To view the full details of the TIN Verification, invoke the `GET` method.\n\n`200` - Request Succeeded\n`400` - Bad Request, missing or invalid parameters\n`403` - Payer not enabled for Verification\n`404` - Recipient not found",
"operationId": "verify-recipient-tin",
"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": {
"tin": {
"type": "string",
"description": "Recipient TIN - 9 digits, no spaces or dashes"
},
"legal_entity_type": {
"type": "string",
"description": "Legal declaration of entity",
"enum": [
"INDIVIDUAL",
"SOLE_PROPRIETOR",
"LLC",
"CORPORATION",
"GENERAL_PARTNERSHIP",
"LIMITED_PARTNERSHIP",
"LIMITED_LIABILITY_PARTNERSHIP"
]
}
}
},
"examples": {
"Request Example": {
"value": {
"tin": "123456789",
"legal_entity_type": "INDIVIDUAL"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"verification_status\": \"PASS\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"verification_status": {
"type": "string",
"example": "PASS"
}
}
}
}
}
}
},
"deprecated": false
},
"get": {
"summary": "Get TIN Verification",
"description": "Get TIN Verification detail for Recipient.\n\n`200` - Request Succeeded\n`403` - Payer not enabled for Verification\n`404` - Recipient not found",
"operationId": "get-tin-verification",
"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": {
"Result": {
"value": "{\n \"tin\": \"123456789\",\n \"tin_verification_status\": \"PASS\",\n \"tin_verified_date\": \"2021-10-14T12:10:06.666Z\",\n \"legal_entity_type\": \"INDIVIDUAL\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"tin": {
"type": "string",
"example": "123456789"
},
"tin_verification_status": {
"type": "string",
"example": "PASS"
},
"tin_verified_date": {
"type": "string",
"example": "2021-10-14T12:10:06.666Z"
},
"legal_entity_type": {
"type": "string",
"example": "INDIVIDUAL"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/accounts/{recipient_id}/banks": {
"post": {
"summary": "Add Bank Account",
"description": "Add a Bank Account for Recipient.\n\n`201` - Created, will include a Location response header\n`400` - Bad Request, missing or invalid parameters\n`404` - Recipient ID not found",
"operationId": "add-bank-account",
"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": {
"account_number": {
"type": "string",
"description": "Bank account number"
},
"routing_number": {
"type": "string",
"description": "Bank routing number"
},
"account_type": {
"type": "string",
"description": "Bank account type",
"enum": [
"CHECKING",
"SAVINGS",
"BUSINESS"
]
},
"account_name": {
"type": "string",
"description": "Bank account name - only required for business accounts"
}
}
},
"examples": {
"Request Example": {
"value": {
"account_number": "123456789",
"routing_number": "021502011",
"account_type": "CHECKING"
}
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"account_id\": \"RPA-L2NW6S4ASIeaKqeP4JmocA==\",\n \"description\": \"CHECKING 1****6789\",\n \"created_date\": \"2021-11-09T13:52:55.330Z\",\n \"account_name\": \"Sherlock Holmes\",\n \"account_number\": \"123456789\",\n \"account_type\": \"CHECKING\",\n \"bank_name\": \"BANCO POPULAR\",\n \"routing_number\": \"021502011\",\n \"rtp_status\": \"DISABLED\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-L2NW6S4ASIeaKqeP4JmocA=="
},
"description": {
"type": "string",
"example": "CHECKING 1****6789"
},
"created_date": {
"type": "string",
"example": "2021-11-09T13:52:55.330Z"
},
"account_name": {
"type": "string",
"example": "Sherlock Holmes"
},
"account_number": {
"type": "string",
"example": "123456789"
},
"account_type": {
"type": "string",
"example": "CHECKING"
},
"bank_name": {
"type": "string",
"example": "BANCO POPULAR"
},
"routing_number": {
"type": "string",
"example": "021502011"
},
"rtp_status": {
"type": "string",
"example": "DISABLED"
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 404,\n \"error_code\": \"ERR_INVALID_ROUTING_NUMBER\",\n \"error_message\": \"Invalid Routing Number\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 404,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_ROUTING_NUMBER"
},
"error_message": {
"type": "string",
"example": "Invalid Routing Number"
}
}
}
}
}
}
},
"deprecated": false
},
"get": {
"summary": "Get Bank Accounts",
"description": "Get Bank Accounts for Recipient.\n\n`200` - Request Succeeded\n`404` - Recipient ID or Account ID not found",
"operationId": "get-bank-accounts",
"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
},
{
"name": "maskAccount",
"in": "query",
"description": "Limits the `account_number` value to last 4 digits",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "[\n {\n \"account_id\": \"RPA-L2NW6S4ASIeaKqeP4JmocA==\",\n \"description\": \"CHECKING 1****6789\",\n \"created_date\": \"2021-11-09T13:52:55.330Z\",\n \"account_name\": \"Sherlock Holmes\",\n \"account_number\": \"123456789\",\n \"account_type\": \"CHECKING\",\n \"bank_name\": \"BANCO POPULAR\",\n \"routing_number\": \"021502011\",\n \"rtp_status\": \"DISABLED\"\n\t}\n]"
}
},
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-L2NW6S4ASIeaKqeP4JmocA=="
},
"description": {
"type": "string",
"example": "CHECKING 1****6789"
},
"created_date": {
"type": "string",
"example": "2021-11-09T13:52:55.330Z"
},
"account_name": {
"type": "string",
"example": "Sherlock Holmes"
},
"account_number": {
"type": "string",
"example": "123456789"
},
"account_type": {
"type": "string",
"example": "CHECKING"
},
"bank_name": {
"type": "string",
"example": "BANCO POPULAR"
},
"routing_number": {
"type": "string",
"example": "021502011"
},
"rtp_status": {
"type": "string",
"example": "DISABLED"
}
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/accounts/{recipient_id}/banks/{account_id}": {
"get": {
"summary": "Get Bank Account",
"description": "Get Bank Account for Recipient.\n\n`200` - Request Succeeded\n`404` - Recipient ID or Account ID not found",
"operationId": "get-bank-account",
"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
},
{
"name": "account_id",
"in": "path",
"description": "Payment Account ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "maskAccount",
"in": "query",
"description": "Limits the `account_number` value to last 4 digits",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"account_id\": \"RPA-L2NW6S4ASIeaKqeP4JmocA==\",\n \"description\": \"CHECKING 1****6789\",\n \"created_date\": \"2021-11-09T13:52:55.330Z\",\n \"account_name\": \"Sherlock Holmes\",\n \"account_number\": \"123456789\",\n \"account_type\": \"CHECKING\",\n \"bank_name\": \"BANCO POPULAR\",\n \"routing_number\": \"021502011\",\n \"rtp_status\": \"DISABLED\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-L2NW6S4ASIeaKqeP4JmocA=="
},
"description": {
"type": "string",
"example": "CHECKING 1****6789"
},
"created_date": {
"type": "string",
"example": "2021-11-09T13:52:55.330Z"
},
"account_name": {
"type": "string",
"example": "Sherlock Holmes"
},
"account_number": {
"type": "string",
"example": "123456789"
},
"account_type": {
"type": "string",
"example": "CHECKING"
},
"bank_name": {
"type": "string",
"example": "BANCO POPULAR"
},
"routing_number": {
"type": "string",
"example": "021502011"
},
"rtp_status": {
"type": "string",
"example": "DISABLED"
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 400,\n \"error_code\": \"ERR_INVALID_RECIPIENT_ID\",\n \"error_message\": \"Invalid Recipient ID\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 400,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_RECIPIENT_ID"
},
"error_message": {
"type": "string",
"example": "Invalid Recipient ID"
}
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete Bank Account",
"description": "Delete Bank Account for Recipient.\n\n`200` - Request Succeeded\n`404` - Recipient ID or Account ID not found",
"operationId": "delete-bank-account",
"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
},
{
"name": "account_id",
"in": "path",
"description": "Payment Account ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/accounts/{recipient_id}/cards": {
"post": {
"summary": "Add Card Account",
"description": "Add a Card Account for a Recipient.",
"operationId": "add-card-account",
"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": {
"card_number": {
"type": "string",
"description": "Card number - 16 digits no spaces or dashes"
},
"exp_date": {
"type": "string",
"description": "Card expiration date formatted as YYYY-MM"
},
"account_name": {
"type": "string",
"description": "Card account name - only required for business accounts"
},
"cvv": {
"type": "string",
"description": "Card account CVV code (optional)"
},
"address": {
"properties": {
"address_1": {
"type": "string",
"description": "Address line 1"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
}
},
"required": [],
"type": "object"
}
}
},
"examples": {
"Create Card Account": {
"value": {
"card_number": "4515300011000167",
"exp_date": "2026-08"
}
},
"Create Card Account with Account Verification": {
"value": {
"card_number": "4515300011000167",
"exp_date": "2026-08",
"cvv": "123"
}
},
"Create Card Account with Address Verification": {
"value": {
"card_number": "4515300011000167",
"exp_date": "2026-08",
"cvv": "123",
"address": {
"address_1": "123 Main St.",
"city": "Miami",
"state": "FL",
"zip": "33333"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Failed Creation": {
"value": "{\n \"http_status\": 200,\n \"error_code\": \"ERR_CARD_INELIGIBLE\",\n \"error_message\": \"Card ineligible\"\n}"
},
"Verification Result for No Match": {
"value": "{\n\t\t\"error_response_code\": \"ERR_CARD_PAV_FAILURE\",\n \"error_message\": \"Card account validation failed\",\n \"account_id\": \"RPA-f9Qe4Pm_THaw7uDTqck4IQ==\",\n \"description\": \"Visa Debit 0167\",\n \"created_date\": \"2021-11-09T14:47:42.843Z\",\n \"bank_name\": \"Banco Popular\",\n \"card_number\": \"451530XXXXXX0167\",\n \"card_type\": \"DEBIT\",\n \"exp_date\": \"2026-08\",\n \"verification_result\": {\n \"network\": \"VISA\",\n \"pan\": \"MATCH\",\n \"cvv\": \"MATCH\",\n \"avs\": {\n \"street\": \"MATCH\",\n \"zip\": \"NO_MATCH\"\n },\n \"ani\": {\n \"first_name\": \"MATCH\",\n \"last_name\": \"PARTIAL\"\n }\n }\n}"
}
},
"schema": {
"oneOf": [
{
"title": "Failed Creation",
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 200,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_CARD_INELIGIBLE"
},
"error_message": {
"type": "string",
"example": "Card ineligible"
}
}
},
{
"title": "Verification Result for No Match",
"type": "object",
"properties": {
"error_response_code": {
"type": "string",
"example": "ERR_CARD_PAV_FAILURE"
},
"error_message": {
"type": "string",
"example": "Card account validation failed"
},
"account_id": {
"type": "string",
"example": "RPA-f9Qe4Pm_THaw7uDTqck4IQ=="
},
"description": {
"type": "string",
"example": "Visa Debit 0167"
},
"created_date": {
"type": "string",
"example": "2021-11-09T14:47:42.843Z"
},
"bank_name": {
"type": "string",
"example": "Banco Popular"
},
"card_number": {
"type": "string",
"example": "451530XXXXXX0167"
},
"card_type": {
"type": "string",
"example": "DEBIT"
},
"exp_date": {
"type": "string",
"example": "2026-08"
},
"verification_result": {
"type": "object",
"properties": {
"network": {
"type": "string",
"example": "VISA"
},
"pan": {
"type": "string",
"example": "MATCH"
},
"cvv": {
"type": "string",
"example": "MATCH"
},
"avs": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "MATCH"
},
"zip": {
"type": "string",
"example": "NO_MATCH"
}
}
},
"ani": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"example": "MATCH"
},
"last_name": {
"type": "string",
"example": "PARTIAL"
}
}
}
}
}
}
}
]
}
}
}
},
"201": {
"description": "201",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"account_id\": \"RPA-f9Qe4Pm_THaw7uDTqck4IQ==\",\n \"description\": \"Visa Debit 0167\",\n \"created_date\": \"2021-11-09T14:47:42.843Z\",\n \"bank_name\": \"Banco Popular\",\n \"card_number\": \"451530XXXXXX0167\",\n \"card_type\": \"DEBIT\",\n \"exp_date\": \"2026-08\",\n \"verification_result\": {\n \"network\": \"VISA\",\n \"pan\": \"MATCH\",\n \"cvv\": \"MATCH\",\n \"avs\": {\n \"street\": \"MATCH\",\n \"zip\": \"MATCH\"\n },\n \"ani\": {\n \"first_name\": \"MATCH\",\n \"last_name\": \"PARTIAL\"\n }\n }\n}"
}
},
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-f9Qe4Pm_THaw7uDTqck4IQ=="
},
"description": {
"type": "string",
"example": "Visa Debit 0167"
},
"created_date": {
"type": "string",
"example": "2021-11-09T14:47:42.843Z"
},
"bank_name": {
"type": "string",
"example": "Banco Popular"
},
"card_number": {
"type": "string",
"example": "451530XXXXXX0167"
},
"card_type": {
"type": "string",
"example": "DEBIT"
},
"exp_date": {
"type": "string",
"example": "2026-08"
}
}
},
{
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-f9Qe4Pm_THaw7uDTqck4IQ=="
},
"description": {
"type": "string",
"example": "Visa Debit 0167"
},
"created_date": {
"type": "string",
"example": "2021-11-09T14:47:42.843Z"
},
"bank_name": {
"type": "string",
"example": "Banco Popular"
},
"card_number": {
"type": "string",
"example": "451530XXXXXX0167"
},
"card_type": {
"type": "string",
"example": "DEBIT"
},
"exp_date": {
"type": "string",
"example": "2026-08"
},
"verification_result": {
"type": "object",
"properties": {
"network": {
"type": "string",
"example": "VISA"
},
"pan": {
"type": "string",
"example": "MATCH"
},
"cvv": {
"type": "string",
"example": "MATCH"
},
"avs": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "MATCH"
},
"zip": {
"type": "string",
"example": "MATCH"
}
}
},
"ani": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"example": "MATCH"
},
"last_name": {
"type": "string",
"example": "PARTIAL"
}
}
}
}
}
}
}
]
}
}
}
},
"409": {
"description": "409",
"content": {
"application/json": {
"examples": {
"Card Exists": {
"value": "{\n \"account_id\": \"RPA-f9Qe4Pm_THaw7uDTqck4IQ==\",\n \"description\": \"Visa Debit 0167\",\n \"created_date\": \"2021-11-09T14:47:42.843Z\",\n \"bank_name\": \"Banco Popular\",\n \"card_number\": \"451530XXXXXX0167\",\n \"card_type\": \"DEBIT\",\n \"exp_date\": \"2026-08\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-f9Qe4Pm_THaw7uDTqck4IQ=="
},
"description": {
"type": "string",
"example": "Visa Debit 0167"
},
"created_date": {
"type": "string",
"example": "2021-11-09T14:47:42.843Z"
},
"bank_name": {
"type": "string",
"example": "Banco Popular"
},
"card_number": {
"type": "string",
"example": "451530XXXXXX0167"
},
"card_type": {
"type": "string",
"example": "DEBIT"
},
"exp_date": {
"type": "string",
"example": "2026-08"
}
}
}
}
}
}
},
"deprecated": false
},
"get": {
"summary": "Get Card Accounts",
"description": "Get Card Accounts for Recipient.\n\n`200` - Request Succeeded\n`404` - Recipient ID or Account ID not found",
"operationId": "get-card-accounts",
"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": {
"Result": {
"value": "[\n {\n \"account_id\": \"RPA-f9Qe4Pm_THaw7uDTqck4IQ==\",\n \"description\": \"Visa Debit 0167\",\n \"created_date\": \"2021-11-09T14:47:42.843Z\",\n \"bank_name\": \"Banco Popular\",\n \"card_number\": \"451530XXXXXX0167\",\n \"card_type\": \"DEBIT\",\n \"exp_date\": \"2026-08\"\n\t}\n] "
}
},
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-f9Qe4Pm_THaw7uDTqck4IQ=="
},
"description": {
"type": "string",
"example": "Visa Debit 0167"
},
"created_date": {
"type": "string",
"example": "2021-11-09T14:47:42.843Z"
},
"bank_name": {
"type": "string",
"example": "Banco Popular"
},
"card_number": {
"type": "string",
"example": "451530XXXXXX0167"
},
"card_type": {
"type": "string",
"example": "DEBIT"
},
"exp_date": {
"type": "string",
"example": "2026-08"
}
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/accounts/{recipient_id}/cards/{account_id}": {
"get": {
"summary": "Get Card Account",
"description": "Get Card Account for Recipient.\n\n`200` - Request Succeeded\n`404` - Recipient ID or Account ID not found",
"operationId": "get-card-account",
"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
},
{
"name": "account_id",
"in": "path",
"description": "Payment Account ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"account_id\": \"RPA-f9Qe4Pm_THaw7uDTqck4IQ==\",\n \"description\": \"Visa Debit 0167\",\n \"created_date\": \"2021-11-09T14:47:42.843Z\",\n \"bank_name\": \"Banco Popular\",\n \"card_number\": \"451530XXXXXX0167\",\n \"card_type\": \"DEBIT\",\n \"exp_date\": \"2026-08\"\n}"
},
"Get Card Account with Verification": {
"value": "{\n \"account_id\": \"RPA-f9Qe4Pm_THaw7uDTqck4IQ==\",\n \"description\": \"Visa Debit 0167\",\n \"created_date\": \"2021-11-09T14:47:42.843Z\",\n \"bank_name\": \"Banco Popular\",\n \"card_number\": \"451530XXXXXX0167\",\n \"card_type\": \"DEBIT\",\n \"exp_date\": \"2026-08\",\n \"verification_status\": \"VERIFIED\",\n\t\t\"verification_result\": {\n \t\"network\": \"VISA\",\n \"pan\": \"MATCH\",\n \"cvv\": \"MATCH\",\n \"avs\": {\n \t\"street\": \"MATCH\",\n \t\"zip\": \"MATCH\"\n },\n \t\"ani\": {\n \t\"first_name\": \"MATCH\",\n \"last_name\": \"MATCH\"\n }\n }\n}\n"
}
},
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-f9Qe4Pm_THaw7uDTqck4IQ=="
},
"description": {
"type": "string",
"example": "Visa Debit 0167"
},
"created_date": {
"type": "string",
"example": "2021-11-09T14:47:42.843Z"
},
"bank_name": {
"type": "string",
"example": "Banco Popular"
},
"card_number": {
"type": "string",
"example": "451530XXXXXX0167"
},
"card_type": {
"type": "string",
"example": "DEBIT"
},
"exp_date": {
"type": "string",
"example": "2026-08"
}
}
},
{
"title": "Get Card Account with Verification",
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-f9Qe4Pm_THaw7uDTqck4IQ=="
},
"description": {
"type": "string",
"example": "Visa Debit 0167"
},
"created_date": {
"type": "string",
"example": "2021-11-09T14:47:42.843Z"
},
"bank_name": {
"type": "string",
"example": "Banco Popular"
},
"card_number": {
"type": "string",
"example": "451530XXXXXX0167"
},
"card_type": {
"type": "string",
"example": "DEBIT"
},
"exp_date": {
"type": "string",
"example": "2026-08"
},
"verification_status": {
"type": "string",
"example": "VERIFIED"
},
"verification_result": {
"type": "object",
"properties": {
"network": {
"type": "string",
"example": "VISA"
},
"pan": {
"type": "string",
"example": "MATCH"
},
"cvv": {
"type": "string",
"example": "MATCH"
},
"avs": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "MATCH"
},
"zip": {
"type": "string",
"example": "MATCH"
}
}
},
"ani": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"example": "MATCH"
},
"last_name": {
"type": "string",
"example": "MATCH"
}
}
}
}
}
}
}
]
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete Card Account",
"description": "Delete Card Account for Recipient.\n\n`200` - Request Succeeded\n`404` - Recipient ID or Account ID not found",
"operationId": "delete-card-account",
"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
},
{
"name": "account_id",
"in": "path",
"description": "Payment Account ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/accounts/{recipient_id}/cards/{account_id}/verification": {
"post": {
"summary": "Verify Card Account",
"description": "Card Account Verification for Account Name and/or Address on an existing active Card account",
"operationId": "verify-card-account",
"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
},
{
"name": "account_id",
"in": "path",
"description": "Account ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"description": "First Name (optional)"
},
"last_name": {
"type": "string",
"description": "Last Name (optional)"
},
"address": {
"properties": {
"address_1": {
"type": "string",
"description": "Address line 1 (optional)"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code (optional)"
}
},
"required": [],
"type": "object",
"description": "Address (optional)"
},
"verification_options": {
"properties": {
"require_match": {
"type": "boolean",
"description": "Enforce matching logic required for funding transactions. If there is a non-match, and error code/message will be returned.",
"default": false
}
},
"required": [],
"type": "object",
"description": "Verification options"
}
}
},
"examples": {
"Verification for Name": {
"value": {
"first_name": "John",
"last_name": "Smith"
}
},
"Verification for Address": {
"value": {
"address": {
"address_1": "123 Main St",
"zip": "11249"
}
}
},
"Verification for Name & Address": {
"value": {
"first_name": "John",
"last_name": "Smith",
"address": {
"address_1": "123 Main St",
"city": "Brooklyn",
"state": "NY",
"zip": "11249"
}
}
},
"Verification for Name & Address with Required match": {
"value": {
"first_name": "John",
"last_name": "Smith",
"address": {
"address_1": "123 Main St",
"city": "Brooklyn",
"state": "NY",
"zip": "11249"
},
"verification_options": {
"require_match": true
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Verification response for Name": {
"value": "{\n \"verification_id\": \"PAV-V5jn9KH5RDWWxdX4AkzMdA==\",\n \"network\": \"VISA\",\n \"pan\": \"MATCH\",\n \"cvv\": \"NOT_PROCESSED\",\n \"avs\": {\n \"street\": \"NOT_PROCESSED\",\n \"zip\": \"NOT_PROCESSED\"\n },\n \"ani\": {\n \"first_name\": \"MATCH\",\n \"last_name\": \"MATCH\"\n },\n \"created_date\": \"2024-03-01T15:18:57.464Z\"\n}"
},
"Verification response for Address": {
"value": "{\n \"verification_id\": \"PAV-V5jn9KH5RDWWxdX4AkzMdA==\",\n \"network\": \"VISA\",\n \"pan\": \"MATCH\",\n \"cvv\": \"NOT_PROCESSED\",\n \"avs\": {\n \"street\": \"MATCH\",\n \"zip\": \"MATCH\"\n },\n \"created_date\": \"2024-03-01T15:18:57.464Z\"\n}"
},
"Verification Response for Name & Address": {
"value": "{\n \"verification_id\": \"PAV-V5jn9KH5RDWWxdX4AkzMdA==\",\n \"network\": \"VISA\",\n \"pan\": \"MATCH\",\n \"cvv\": \"NOT_PROCESSED\",\n \"avs\": {\n \"street\": \"MATCH\",\n \"zip\": \"MATCH\"\n },\n \"ani\": {\n \"first_name\": \"MATCH\",\n \"last_name\": \"MATCH\"\n },\n \"created_date\": \"2024-03-01T15:18:57.464Z\"\n}"
},
"Verification Response for Name & Address with required match": {
"value": "{\n \"http_status\": 200,\n \"error_code\": \"ERR_CARD_PAV_FAILURE\",\n \"error_message\": \"Card account validation failed\",\n\t\t\"verification_id\": \"PAV-V5jn9KH5RDWWxdX4AkzMdA==\",\n \"network\": \"VISA\",\n \"pan\": \"MATCH\",\n \"cvv\": \"NOT_PROCESSED\",\n \"avs\": {\n \"street\": \"MATCH\",\n \"zip\": \"NO_MATCH\"\n },\n \"ani\": {\n \"first_name\": \"MATCH\",\n \"last_name\": \"MATCH\"\n },\n \"created_date\": \"2024-03-01T15:18:57.464Z\"\n}"
}
},
"schema": {
"oneOf": [
{
"title": "Verification response for Name",
"type": "object",
"properties": {
"verification_id": {
"type": "string",
"example": "PAV-V5jn9KH5RDWWxdX4AkzMdA=="
},
"network": {
"type": "string",
"example": "VISA"
},
"pan": {
"type": "string",
"example": "MATCH"
},
"cvv": {
"type": "string",
"example": "NOT_PROCESSED"
},
"avs": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "NOT_PROCESSED"
},
"zip": {
"type": "string",
"example": "NOT_PROCESSED"
}
}
},
"ani": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"example": "MATCH"
},
"last_name": {
"type": "string",
"example": "MATCH"
}
}
},
"created_date": {
"type": "string",
"example": "2024-03-01T15:18:57.464Z"
}
}
},
{
"title": "Verification response for Address",
"type": "object",
"properties": {
"verification_id": {
"type": "string",
"example": "PAV-V5jn9KH5RDWWxdX4AkzMdA=="
},
"network": {
"type": "string",
"example": "VISA"
},
"pan": {
"type": "string",
"example": "MATCH"
},
"cvv": {
"type": "string",
"example": "NOT_PROCESSED"
},
"avs": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "MATCH"
},
"zip": {
"type": "string",
"example": "MATCH"
}
}
},
"created_date": {
"type": "string",
"example": "2024-03-01T15:18:57.464Z"
}
}
},
{
"title": "Verification Response for Name & Address",
"type": "object",
"properties": {
"verification_id": {
"type": "string",
"example": "PAV-V5jn9KH5RDWWxdX4AkzMdA=="
},
"network": {
"type": "string",
"example": "VISA"
},
"pan": {
"type": "string",
"example": "MATCH"
},
"cvv": {
"type": "string",
"example": "NOT_PROCESSED"
},
"avs": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "MATCH"
},
"zip": {
"type": "string",
"example": "MATCH"
}
}
},
"ani": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"example": "MATCH"
},
"last_name": {
"type": "string",
"example": "MATCH"
}
}
},
"created_date": {
"type": "string",
"example": "2024-03-01T15:18:57.464Z"
}
}
},
{
"title": "Verification Response for Name & Address with required match",
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 200,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_CARD_PAV_FAILURE"
},
"error_message": {
"type": "string",
"example": "Card account validation failed"
},
"verification_id": {
"type": "string",
"example": "PAV-V5jn9KH5RDWWxdX4AkzMdA=="
},
"network": {
"type": "string",
"example": "VISA"
},
"pan": {
"type": "string",
"example": "MATCH"
},
"cvv": {
"type": "string",
"example": "NOT_PROCESSED"
},
"avs": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "MATCH"
},
"zip": {
"type": "string",
"example": "NO_MATCH"
}
}
},
"ani": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"example": "MATCH"
},
"last_name": {
"type": "string",
"example": "MATCH"
}
}
},
"created_date": {
"type": "string",
"example": "2024-03-01T15:18:57.464Z"
}
}
}
]
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/accounts/{recipient_id}/cards/{account_id}/verification/{verification_id}": {
"get": {
"summary": "Get Card Account Verification",
"description": "Get Card Account Verification response",
"operationId": "get-card-account-verify",
"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
},
{
"name": "account_id",
"in": "path",
"description": "Account ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "verification_id",
"in": "path",
"description": "Verification ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Verification response for Name": {
"value": "{\n \"verification_id\": \"PAV-V5jn9KH5RDWWxdX4AkzMdA==\",\n \"network\": \"VISA\",\n \"pan\": \"MATCH\",\n \"cvv\": \"NOT_PROCESSED\",\n \"avs\": {\n \"street\": \"NOT_PROCESSED\",\n \"zip\": \"NOT_PROCESSED\"\n },\n \"ani\": {\n \"first_name\": \"MATCH\",\n \"last_name\": \"MATCH\"\n },\n \"created_date\": \"2024-03-01T15:18:57.464Z\"\n}"
},
"Verification response for Address": {
"value": "{\n \"verification_id\": \"PAV-V5jn9KH5RDWWxdX4AkzMdA==\",\n \"network\": \"VISA\",\n \"pan\": \"MATCH\",\n \"cvv\": \"NOT_PROCESSED\",\n \"avs\": {\n \"street\": \"MATCH\",\n \"zip\": \"MATCH\"\n },\n \"created_date\": \"2024-03-01T15:18:57.464Z\"\n}"
},
"Verification Response for Name & Address": {
"value": "{\n \"verification_id\": \"PAV-V5jn9KH5RDWWxdX4AkzMdA==\",\n \"network\": \"VISA\",\n \"pan\": \"MATCH\",\n \"cvv\": \"NOT_PROCESSED\",\n \"avs\": {\n \"street\": \"MATCH\",\n \"zip\": \"MATCH\"\n },\n \"ani\": {\n \"first_name\": \"MATCH\",\n \"last_name\": \"MATCH\"\n },\n \"created_date\": \"2024-03-01T15:18:57.464Z\"\n}"
}
},
"schema": {
"oneOf": [
{
"title": "Verification response for Name",
"type": "object",
"properties": {
"verification_id": {
"type": "string",
"example": "PAV-V5jn9KH5RDWWxdX4AkzMdA=="
},
"network": {
"type": "string",
"example": "VISA"
},
"pan": {
"type": "string",
"example": "MATCH"
},
"cvv": {
"type": "string",
"example": "NOT_PROCESSED"
},
"avs": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "NOT_PROCESSED"
},
"zip": {
"type": "string",
"example": "NOT_PROCESSED"
}
}
},
"ani": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"example": "MATCH"
},
"last_name": {
"type": "string",
"example": "MATCH"
}
}
},
"created_date": {
"type": "string",
"example": "2024-03-01T15:18:57.464Z"
}
}
},
{
"title": "Verification response for Address",
"type": "object",
"properties": {
"verification_id": {
"type": "string",
"example": "PAV-V5jn9KH5RDWWxdX4AkzMdA=="
},
"network": {
"type": "string",
"example": "VISA"
},
"pan": {
"type": "string",
"example": "MATCH"
},
"cvv": {
"type": "string",
"example": "NOT_PROCESSED"
},
"avs": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "MATCH"
},
"zip": {
"type": "string",
"example": "MATCH"
}
}
},
"created_date": {
"type": "string",
"example": "2024-03-01T15:18:57.464Z"
}
}
},
{
"title": "Verification Response for Name & Address",
"type": "object",
"properties": {
"verification_id": {
"type": "string",
"example": "PAV-V5jn9KH5RDWWxdX4AkzMdA=="
},
"network": {
"type": "string",
"example": "VISA"
},
"pan": {
"type": "string",
"example": "MATCH"
},
"cvv": {
"type": "string",
"example": "NOT_PROCESSED"
},
"avs": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "MATCH"
},
"zip": {
"type": "string",
"example": "MATCH"
}
}
},
"ani": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"example": "MATCH"
},
"last_name": {
"type": "string",
"example": "MATCH"
}
}
},
"created_date": {
"type": "string",
"example": "2024-03-01T15:18:57.464Z"
}
}
}
]
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/accounts/{recipient_id}/cards/{account_id}/verifications": {
"get": {
"summary": "Get Card Account Verifications",
"description": "Get Account Verifications for Card account",
"operationId": "get-card-account-verifications",
"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
},
{
"name": "account_id",
"in": "path",
"description": "Account ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "[\n\t{\n \"verification_id\": \"PAV-V5jn9KH5RDWWxdX4AkzMdA==\",\n \"network\": \"VISA\",\n \"pan\": \"MATCH\",\n \"cvv\": \"NOT_PROCESSED\",\n \"avs\": {\n \"street\": \"MATCH\",\n \"zip\": \"MATCH\"\n },\n \"ani\": {\n \"first_name\": \"MATCH\",\n \"last_name\": \"MATCH\"\n },\n \"created_date\": \"2024-03-01T15:18:57.464Z\"\n },\n\t{\n \"verification_id\": \"PAV-YrnKElsGHh6svaerKRlHA==\",\n \"network\": \"VISA\",\n \"pan\": \"MATCH\",\n \"cvv\": \"NOT_PROCESSED\",\n \"avs\": {\n \"street\": \"MATCH\",\n \"zip\": \"NO_MATCH\"\n },\n \"ani\": {\n \"first_name\": \"MATCH\",\n \"last_name\": \"MATCH\"\n },\n \"created_date\": \"2024-03-01T15:20:57.464Z\"\n\t}\n]\n"
}
},
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"verification_id": {
"type": "string",
"example": "PAV-V5jn9KH5RDWWxdX4AkzMdA=="
},
"network": {
"type": "string",
"example": "VISA"
},
"pan": {
"type": "string",
"example": "MATCH"
},
"cvv": {
"type": "string",
"example": "NOT_PROCESSED"
},
"avs": {
"type": "object",
"properties": {
"street": {
"type": "string",
"example": "MATCH"
},
"zip": {
"type": "string",
"example": "MATCH"
}
}
},
"ani": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"example": "MATCH"
},
"last_name": {
"type": "string",
"example": "MATCH"
}
}
},
"created_date": {
"type": "string",
"example": "2024-03-01T15:18:57.464Z"
}
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/accounts/{recipient_id}/paypal": {
"post": {
"summary": "Add PayPal Account",
"description": "Add a PayPal Account for Recipient.\n\n`201` - Created, will include a Location response header\n`400` - Bad Request, missing or invalid parameters\n`404` - Recipient ID not found",
"operationId": "add-paypal-account",
"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": "Paypal email address"
}
}
},
"examples": {
"Request Example": {
"value": {
"email": "sherlock@example.com"
}
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/json": {
"examples": {
"Created": {
"value": "{\n \"account_id\": \"RPA-MESt9UKeR6-IkNMdNRM7qg==\",\n \"description\": \"sherlock@example.com\",\n \"created_date\": \"2021-11-09T14:19:39.349Z\",\n \"email\": \"sherlock@example.com\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-MESt9UKeR6-IkNMdNRM7qg=="
},
"description": {
"type": "string",
"example": "sherlock@example.com"
},
"created_date": {
"type": "string",
"example": "2021-11-09T14:19:39.349Z"
},
"email": {
"type": "string",
"example": "sherlock@example.com"
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 400,\n \"error_code\": \"ERR_INVALID_EMAIL\",\n \"error_message\": \"Invalid email\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 400,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_EMAIL"
},
"error_message": {
"type": "string",
"example": "Invalid email"
}
}
}
}
}
}
},
"deprecated": false
},
"get": {
"summary": "Get PayPal Accounts",
"description": "Get PayPal Accounts for Recipient.\n\n`200` - Request Succeeded\n`404` - Recipient ID or Account ID not found",
"operationId": "get-paypal-accounts",
"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": {
"Result": {
"value": "[\n {\n \"account_id\": \"RPA-MESt9UKeR6-IkNMdNRM7qg==\",\n \"description\": \"sherlock@example.com\",\n \"created_date\": \"2021-11-09T14:19:39.349Z\",\n \"email\": \"sherlock@example.com\"\n\t}\n]"
}
},
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-MESt9UKeR6-IkNMdNRM7qg=="
},
"description": {
"type": "string",
"example": "sherlock@example.com"
},
"created_date": {
"type": "string",
"example": "2021-11-09T14:19:39.349Z"
},
"email": {
"type": "string",
"example": "sherlock@example.com"
}
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/accounts/{recipient_id}/paypal/{account_id}": {
"get": {
"summary": "Get PayPal Account",
"description": "Get PayPal Account for Recipient.\n\n`200` - Request Succeeded\n`404` - Recipient ID or Account ID not found",
"operationId": "get-paypal-account",
"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
},
{
"name": "account_id",
"in": "path",
"description": "Payment Account ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"account_id\": \"RPA-MESt9UKeR6-IkNMdNRM7qg==\",\n \"description\": \"sherlock@example.com\",\n \"created_date\": \"2021-11-09T14:19:39.349Z\",\n \"email\": \"sherlock@example.com\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-MESt9UKeR6-IkNMdNRM7qg=="
},
"description": {
"type": "string",
"example": "sherlock@example.com"
},
"created_date": {
"type": "string",
"example": "2021-11-09T14:19:39.349Z"
},
"email": {
"type": "string",
"example": "sherlock@example.com"
}
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete PayPal Account",
"description": "Delete PayPal Account for Recipient.\n\n`200` - Request Succeeded\n`404` - Recipient ID or Account ID not found",
"operationId": "delete-paypal-account",
"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
},
{
"name": "account_id",
"in": "path",
"description": "Payment Account ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/accounts/{recipient_id}/prepaid": {
"post": {
"summary": "Create Prepaid Account",
"description": "Creates a Prepaid account for a Recipient.\n\n`201` - Created, will include a Location response header\n`200` - Request Succeeded, but entity not created\n`400` - Bad Request, missing or invalid parameters\n`404` - Recipient ID not found\n`422` - Account exists or locked due identity verification failure",
"operationId": "create-prepaid-account",
"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": {
"first_name": {
"type": "string",
"description": "Account first name"
},
"last_name": {
"type": "string",
"description": "Account last name"
},
"dob": {
"type": "string",
"description": "Date of birth",
"format": "date"
},
"tin": {
"type": "string",
"description": "TIN - 9 digits, no spaces or dashes"
},
"address": {
"properties": {
"address_1": {
"type": "string",
"description": "Address line 1"
},
"address_2": {
"type": "string",
"description": "Address line 2 (optional)"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State abbreviation"
},
"zip": {
"type": "string",
"description": "Zip code"
}
},
"required": [],
"type": "object"
}
}
},
"examples": {
"Request Example": {
"value": {
"first_name": "Sherlock",
"last_name": "Holmes",
"dob": "2000-01-01",
"tin": "123456789",
"address": {
"address_1": "123 MAIN STREET",
"city": "BROOKLYN",
"state": "NY",
"zip": "11249"
}
}
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"account_id\": \"RPA-XUhOc4RzTuGVBGb93EKPRg==\",\n \"description\": \"Visa\u00ae Prepaid Card\",\n \"created_date\": \"2022-11-03T23:36:55.732Z\",\n \"prepaid_account_type\": \"PHYSICALCARD_VISA\",\n \"prepaid_account_status\": \"PROCESSING\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-XUhOc4RzTuGVBGb93EKPRg=="
},
"description": {
"type": "string",
"example": "Visa\u00ae Prepaid Card"
},
"created_date": {
"type": "string",
"example": "2022-11-03T23:36:55.732Z"
},
"prepaid_account_type": {
"type": "string",
"example": "PHYSICALCARD_VISA"
},
"prepaid_account_status": {
"type": "string",
"example": "PROCESSING"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/accounts/{recipient_id}/prepaid/{account_id}": {
"get": {
"summary": "Get Prepaid Account",
"description": "Get Prepaid Account for Recipient.\n\n`200` - Request Succeeded\n`404` - Recipient ID or Account ID not found",
"operationId": "get-prepaid-account",
"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
},
{
"name": "account_id",
"in": "path",
"description": "Account ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"account_id\": \"RPA-4P-bqWs8STOOC-uzI6T5Yw\",\n \"description\": \"Visa\u00ae Prepaid Card 5586\",\n \"created_date\": \"2021-07-28T20:51:13.831Z\",\n \"prepaid_account_type\": \"PHYSICALCARD_VISA\",\n \"prepaid_account_status\": \"ACTIVE\",\n \"prepaid_account_balance\": 0.0,\n \"prepaid_card_number\": \"4***********5586\",\n \"prepaid_dda_number\": \"913406491642945\",\n \"prepaid_routing_number\": \"073972181\",\n \"prepaid_account_max_load\": 1000.00,\n \"prepaid_account_security_code\": \"058042\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-4P-bqWs8STOOC-uzI6T5Yw"
},
"description": {
"type": "string",
"example": "Visa\u00ae Prepaid Card 5586"
},
"created_date": {
"type": "string",
"example": "2021-07-28T20:51:13.831Z"
},
"prepaid_account_type": {
"type": "string",
"example": "PHYSICALCARD_VISA"
},
"prepaid_account_status": {
"type": "string",
"example": "ACTIVE"
},
"prepaid_account_balance": {
"type": "integer",
"example": 0,
"default": 0
},
"prepaid_card_number": {
"type": "string",
"example": "4***********5586"
},
"prepaid_dda_number": {
"type": "string",
"example": "913406491642945"
},
"prepaid_routing_number": {
"type": "string",
"example": "073972181"
},
"prepaid_account_max_load": {
"type": "integer",
"example": 1000,
"default": 0
},
"prepaid_account_security_code": {
"type": "string",
"example": "058042"
}
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete Prepaid Account",
"description": "`200` - Request Succeeded\n`404` - Recipient ID or Account ID not found",
"operationId": "delete-prepaid-account",
"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
},
{
"name": "account_id",
"in": "path",
"description": "Account ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
}
},
"deprecated": false
},
"patch": {
"summary": "Update Prepaid Account",
"description": "Updates a Prepaid account based on action.\n\n`200` - Request Succeeded\n`400` - Bad Request, missing or invalid parameters\n`404` - Recipient ID or Account ID not found",
"operationId": "update-prepaid-account",
"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
},
{
"name": "account_id",
"in": "path",
"description": "Account ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"account_action": {
"type": "string",
"description": "Account action",
"enum": [
"ACTIVATE"
]
},
"security_code": {
"type": "string",
"description": "Account security code"
}
}
},
"examples": {
"Request Example": {
"value": {
"account_action": "ACTIVATE",
"security_code": "867530"
}
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"account_id\": \"RPA-XUhOc4RzTuGVBGb93EKPRg==\",\n \"description\": \"Visa\u00ae Prepaid Card\",\n \"created_date\": \"2022-11-03T23:36:55.732Z\",\n \"prepaid_account_type\": \"PHYSICALCARD_VISA\",\n \"prepaid_account_status\": \"ACTIVE\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-XUhOc4RzTuGVBGb93EKPRg=="
},
"description": {
"type": "string",
"example": "Visa\u00ae Prepaid Card"
},
"created_date": {
"type": "string",
"example": "2022-11-03T23:36:55.732Z"
},
"prepaid_account_type": {
"type": "string",
"example": "PHYSICALCARD_VISA"
},
"prepaid_account_status": {
"type": "string",
"example": "ACTIVE"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/accounts/{recipient_id}/prepaid/{account_id}/history": {
"get": {
"summary": "Get Prepaid Account History",
"description": "Get Prepaid Account History for Recipient.\n\n`200` - Request Succeeded\n`404` - Recipient ID or Account ID not found",
"operationId": "get-prepaid-account-history",
"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
},
{
"name": "account_id",
"in": "path",
"description": "Account ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "startDate",
"in": "query",
"description": "Start date filter (optional)",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "endDate",
"in": "query",
"description": "End date filter (optiona)",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "filter",
"in": "query",
"description": "ALL = History entries for customer service, CUSTOMER = History entries for recipient",
"schema": {
"type": "string",
"enum": [
"ALL",
"CUSTOMER"
],
"default": "ALL"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"OK - Filter = ALL": {
"value": "{\n \"account_summaries\": [\n {\n \"account_last_four\": \"5586\",\n \"account_transactions\": [\n {\n \"systemTransactionId\": 2046862,\n \"activity\": \"Activation Unlock\",\n \"currency\": \"USD\",\n \"notes\": \"2046862\",\n \"amount\": 0.0,\n \"date\": \"2022-07-22T10:25:23.510Z\"\n },\n {\n \"systemTransactionId\": 1810006,\n \"activity\": \"Activation Lock\",\n \"currency\": \"USD\",\n \"notes\": \"1810006\",\n \"amount\": 0.0,\n \"date\": \"2021-07-28T20:51:16.753Z\"\n },\n {\n \"systemTransactionId\": 1810004,\n \"activity\": \"Batch Card Activation\",\n \"currency\": \"USD\",\n \"notes\": \"1810004\",\n \"amount\": 0.0,\n \"date\": \"2021-07-28T20:51:16.673Z\"\n },\n {\n \"systemTransactionId\": 1810005,\n \"activity\": \"New Card Activation\",\n \"location\": \"Client 1 (Payments)\",\n \"reason\": \"Activation\",\n \"result\": \"Active\",\n \"currency\": \"USD\",\n \"notes\": \"1810005\",\n \"amount\": 0.00,\n \"date\": \"2021-07-28T20:51:16.673Z\"\n },\n {\n \"systemTransactionId\": 1809999,\n \"activity\": \"Card Order Creation\",\n \"currency\": \"USD\",\n \"notes\": \"1809999\",\n \"amount\": 0.0,\n \"date\": \"2021-07-28T20:51:16.283Z\"\n }\n ]\n }\n ]\n}"
},
"OK - Filter = CUSTOMER": {
"value": "{\n \"account_summaries\": [\n {\n \"account_last_four\": \"5586\",\n \"account_transactions\": [\n {\n \"systemTransactionId\": 1810005,\n \"activity\": \"New Card Activation\",\n \"reason\": \"Activation\",\n \"currency\": \"USD\",\n \"notes\": \"1810005\",\n \"amount\": 0.00,\n \"date\": \"2021-07-28T20:51:16.673Z\"\n }\n ]\n }\n ]\n}"
}
},
"schema": {
"oneOf": [
{
"title": "OK - Filter = ALL",
"type": "object",
"properties": {
"account_summaries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account_last_four": {
"type": "string",
"example": "5586"
},
"account_transactions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"systemTransactionId": {
"type": "integer",
"example": 2046862,
"default": 0
},
"activity": {
"type": "string",
"example": "Activation Unlock"
},
"currency": {
"type": "string",
"example": "USD"
},
"notes": {
"type": "string",
"example": "2046862"
},
"amount": {
"type": "integer",
"example": 0,
"default": 0
},
"date": {
"type": "string",
"example": "2022-07-22T10:25:23.510Z"
}
}
}
}
}
}
}
}
},
{
"title": "OK - Filter = CUSTOMER",
"type": "object",
"properties": {
"account_summaries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account_last_four": {
"type": "string",
"example": "5586"
},
"account_transactions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"systemTransactionId": {
"type": "integer",
"example": 1810005,
"default": 0
},
"activity": {
"type": "string",
"example": "New Card Activation"
},
"reason": {
"type": "string",
"example": "Activation"
},
"currency": {
"type": "string",
"example": "USD"
},
"notes": {
"type": "string",
"example": "1810005"
},
"amount": {
"type": "integer",
"example": 0,
"default": 0
},
"date": {
"type": "string",
"example": "2021-07-28T20:51:16.673Z"
}
}
}
}
}
}
}
}
}
]
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/accounts/{recipient_id}/venmo": {
"post": {
"summary": "Add Venmo Account",
"description": "Add a Venmo Account for Recipient.\n\n`201` - Created, will include a Location response header\n`400` - Bad Request, missing or invalid parameters\n`404` - Recipient ID not found",
"operationId": "add-venmo-account",
"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": {
"phone_ number": {
"type": "string",
"description": "Venmo account phone number - format of xxx-xxx-xxxx"
}
}
},
"examples": {
"Request Example": {
"value": {
"phone_number": "555-867-5309"
}
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/json": {
"examples": {
"Created": {
"value": "{\n \"account_id\": \"RPA-d11zbCESyUUab99loSXb2uHg==\",\n \"description\": \"555-867-5309\",\n \"created_date\": \"2022-08-31T09:14:30.572Z\",\n \"phone_number\": \"555-867-5309\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-d11zbCESyUUab99loSXb2uHg=="
},
"description": {
"type": "string",
"example": "555-867-5309"
},
"created_date": {
"type": "string",
"example": "2022-08-31T09:14:30.572Z"
},
"phone_number": {
"type": "string",
"example": "555-867-5309"
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 400,\n \"error_code\": \"ERR_INVALID_EMAIL\",\n \"error_message\": \"Invalid email\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 400,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_EMAIL"
},
"error_message": {
"type": "string",
"example": "Invalid email"
}
}
}
}
}
}
},
"deprecated": false
},
"get": {
"summary": "Get Venmo Accounts",
"description": "Get Venmo Accounts for Recipient.\n\n`200` - Request Succeeded\n`404` - Recipient ID or Account ID not found",
"operationId": "get-venmo-accounts",
"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": {
"Result": {
"value": "[\n {\n \"account_id\": \"RPA-d11zbCESyUUab99loSXb2uHg==\",\n \"description\": \"555-867-5309\",\n \"created_date\": \"2022-08-31T09:14:30.572Z\",\n \"phone_number\": \"555-867-5309\"\n\t}\n]"
}
},
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-d11zbCESyUUab99loSXb2uHg=="
},
"description": {
"type": "string",
"example": "555-867-5309"
},
"created_date": {
"type": "string",
"example": "2022-08-31T09:14:30.572Z"
},
"phone_number": {
"type": "string",
"example": "555-867-5309"
}
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/accounts/{recipient_id}/venmo/{account_id}": {
"get": {
"summary": "Get Venmo Account",
"description": "Get Venmo Account for Recipient.\n\n`200` - Request Succeeded\n`404` - Recipient ID or Account ID not found",
"operationId": "get-venmo-account",
"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
},
{
"name": "account_id",
"in": "path",
"description": "Payment Account ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"account_id\": \"RPA-d11zbCESyUUab99loSXb2uHg==\",\n \"description\": \"555-867-5309\",\n \"created_date\": \"2022-08-31T09:14:30.572Z\",\n \"phone_number\": \"555-867-5309\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-d11zbCESyUUab99loSXb2uHg=="
},
"description": {
"type": "string",
"example": "555-867-5309"
},
"created_date": {
"type": "string",
"example": "2022-08-31T09:14:30.572Z"
},
"phone_number": {
"type": "string",
"example": "555-867-5309"
}
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete Venmo Account",
"description": "Delete Venmo Account for Recipient.\n\n`200` - Request Succeeded\n`404` - Recipient ID or Account ID not found",
"operationId": "delete-venmo-account",
"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
},
{
"name": "account_id",
"in": "path",
"description": "Payment Account ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/payments": {
"post": {
"summary": "Create Payment",
"description": "Create Payment for a Recipient to accept in the Recipient Portal or Widget UI.\n\n`102` - Idempotent matched request currently processing\n`201` - Created, will include a `Location` response header\n`400` - Bad Request, missing or invalid parameters\n`409` - Idempotent matched request already processed\n`422` - Cannot process due to business constraints",
"operationId": "create-payment",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Idempotency-Key",
"in": "header",
"description": "Uniquely generated key",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"description": "Recipient ID to send Payment"
},
"amount": {
"type": "number",
"description": "Payment amount, ex 25.15 or 25.00",
"format": "double"
},
"reference_id": {
"type": "string",
"description": "Payer reference ID - optional"
},
"memo": {
"type": "string",
"description": "Payment memo - optional"
}
}
},
"examples": {
"Request Example": {
"value": {
"recipient_id": "REejizS5fnTLiQYhGTKYXZaQ==",
"amount": 25,
"reference_id": "payment-123"
}
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"recipient_id\": \"REejizS5fnTLiQYhGTKYXZaQ==\",\n \"payment_id\": \"PM5duKcOBzSGmWxQoUDQinhQ==\",\n \"amount\": 25.00,\n \"reference_id\": \"payment-123\",\n \"status\": \"PENDING\",\n \"created_date\": \"2021-11-09T17:27:27.462Z\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
},
"payment_id": {
"type": "string",
"example": "PM5duKcOBzSGmWxQoUDQinhQ=="
},
"amount": {
"type": "integer",
"example": 25,
"default": 0
},
"reference_id": {
"type": "string",
"example": "payment-123"
},
"status": {
"type": "string",
"example": "PENDING"
},
"created_date": {
"type": "string",
"example": "2021-11-09T17:27:27.462Z"
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 400,\n \"error_code\": \"ERR_INVALID_RECIPIENT_ID\",\n \"error_message\": \"Invalid recipient ID\"\n}"
}
},
"schema": {
"oneOf": [
{
"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"
}
}
},
{
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 400,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_RECIPIENT_ID"
},
"error_message": {
"type": "string",
"example": "Invalid recipient ID"
}
}
}
]
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/payments/{payment_id}": {
"patch": {
"summary": "Update Payment",
"description": "Update Payment Status for `PENDING` or `APPROVAL_REQUIRED` payments. The applicable status values are:\n- `CANCELLED` - Cancels payment\n- `PENDING` - Moves `APPROVAL_REQUIRED` payments to `PENDING` for recipients to accept.\n\nIf the payment is in an immutable status, a `400` response will be returned.\n\n`200` - Request Succeeded\n`400` - Bad Request, missing or invalid parameters\n`422` - Cannot be processed, payment in immutable status",
"operationId": "update-payment",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "payment_id",
"in": "path",
"description": "Payment ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status to apply to Payment",
"enum": [
"PENDING",
"CANCELLED"
]
}
}
},
"examples": {
"Update PENDING": {
"value": {
"status": "PENDING"
}
},
"Update CANCELLED": {
"value": {
"status": "CANCELLED"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"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"
}
}
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 422,\n \"error_code\": \"ERR_PAYMENT_STATUS_IMMUTABLE\",\n \"error_message\": \"Payment in immutable status\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 422,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_PAYMENT_STATUS_IMMUTABLE"
},
"error_message": {
"type": "string",
"example": "Payment in immutable status"
}
}
}
}
}
}
},
"deprecated": false
},
"get": {
"summary": "Get Payment",
"description": "Get Payment by ID\n\n`200` - Request Succeeded\n`404` - Payment ID not found",
"operationId": "get-payment-by-id",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "payment_id",
"in": "path",
"description": "Payment ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"recipient_id\": \"REejizS5fnTLiQYhGTKYXZaQ==\",\n \"payment_id\": \"PM5duKcOBzSGmWxQoUDQinhQ==\",\n \"amount\": 25.00,\n \"reference_id\": \"payment-123\",\n \"status\": \"PENDING\",\n \"created_date\": \"2021-11-09T17:27:27.462Z\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
},
"payment_id": {
"type": "string",
"example": "PM5duKcOBzSGmWxQoUDQinhQ=="
},
"amount": {
"type": "integer",
"example": 25,
"default": 0
},
"reference_id": {
"type": "string",
"example": "payment-123"
},
"status": {
"type": "string",
"example": "PENDING"
},
"created_date": {
"type": "string",
"example": "2021-11-09T17:27:27.462Z"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/payments/reference/{reference_id}": {
"get": {
"summary": "Get Payment by Reference ID",
"description": "Get Payment by Reference ID\n\n`200` - Request Succeeded\n`404` - Payment reference ID not found",
"operationId": "get-payment-by-reference-id",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "reference_id",
"in": "path",
"description": "Payment reference ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "[\n {\n \"recipient_id\": \"REejizS5fnTLiQYhGTKYXZaQ==\",\n \"payment_id\": \"PM5duKcOBzSGmWxQoUDQinhQ==\",\n \"amount\": 25.00,\n \"reference_id\": \"payment-123\",\n \"status\": \"PENDING\",\n \"created_date\": \"2021-11-09T17:27:27.462Z\"\n\t}\n] "
}
},
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
},
"payment_id": {
"type": "string",
"example": "PM5duKcOBzSGmWxQoUDQinhQ=="
},
"amount": {
"type": "integer",
"example": 25,
"default": 0
},
"reference_id": {
"type": "string",
"example": "payment-123"
},
"status": {
"type": "string",
"example": "PENDING"
},
"created_date": {
"type": "string",
"example": "2021-11-09T17:27:27.462Z"
}
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/payments/{payment_id}/transactions": {
"get": {
"summary": "Get Transactions for Payment",
"description": "Get Transactions by Payment ID.\n\n`200` - Request Succeeded\n`404` - Payment ID not found",
"operationId": "get-transactions-by-payment-id",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "payment_id",
"in": "path",
"description": "Payment ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Check Payout": {
"value": "[\n {\n \"transaction_id\": \"ICTN-435-21313-64588-JDK\",\n \"method\": \"CHECK\",\n \"fee\": 0.00,\n \"amount\": 25.00,\n \"status\": \"PAID\",\n \"created_date\": \"2021-11-09T17:56:28.319Z\",\n \"detail\": \"987 MAIN STREET, MIAMI, FLORIDA 33132\",\n \"check_number\": \"10070\"\n }\n]"
}
},
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"transaction_id": {
"type": "string",
"example": "ICTN-435-21313-64588-JDK"
},
"method": {
"type": "string",
"example": "CHECK"
},
"fee": {
"type": "integer",
"example": 0,
"default": 0
},
"amount": {
"type": "integer",
"example": 25,
"default": 0
},
"status": {
"type": "string",
"example": "PAID"
},
"created_date": {
"type": "string",
"example": "2021-11-09T17:56:28.319Z"
},
"detail": {
"type": "string",
"example": "987 MAIN STREET, MIAMI, FLORIDA 33132"
},
"check_number": {
"type": "string",
"example": "10070"
}
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/payments/reference/{reference_id}/transactions": {
"get": {
"summary": "Get Transactions by Payment Reference ID",
"description": "Get Transactions by Payment Reference ID.\n\n`200` - Request Succeeded\n`404` - Payment Reference ID not found",
"operationId": "get-transactions-by-payment-reference-id",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "reference_id",
"in": "path",
"description": "Payment Reference ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Check Payout": {
"value": "[\n {\n \"transaction_id\": \"ICTN-435-21313-64588-JDK\",\n \"method\": \"CHECK\",\n \"fee\": 0.00,\n \"amount\": 25.00,\n \"status\": \"PAID\",\n \"created_date\": \"2021-11-09T17:56:28.319Z\",\n \"detail\": \"987 MAIN STREET, MIAMI, FLORIDA 33132\",\n \"check_number\": \"10070\"\n }\n]"
}
},
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"transaction_id": {
"type": "string",
"example": "ICTN-435-21313-64588-JDK"
},
"method": {
"type": "string",
"example": "CHECK"
},
"fee": {
"type": "integer",
"example": 0,
"default": 0
},
"amount": {
"type": "integer",
"example": 25,
"default": 0
},
"status": {
"type": "string",
"example": "PAID"
},
"created_date": {
"type": "string",
"example": "2021-11-09T17:56:28.319Z"
},
"detail": {
"type": "string",
"example": "987 MAIN STREET, MIAMI, FLORIDA 33132"
},
"check_number": {
"type": "string",
"example": "10070"
}
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/transactions": {
"post": {
"summary": "Create Transaction",
"description": "Create Transaction for immediate disbursement.",
"operationId": "create-transaction",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "Idempotency-Key",
"in": "header",
"description": "Uniquely generated key",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"description": "Recipient ID"
},
"account_id": {
"type": "string",
"description": "Payment Account ID"
},
"type": {
"type": "string",
"description": "Direction of funds - CREDIT funds to Recipient or DEBIT funds from Recipient",
"enum": [
"CREDIT",
"DEBIT"
]
},
"method": {
"type": "string",
"description": "Transaction method",
"enum": [
"ACH_FUNDING",
"ACH_FUNDING_PLUS",
"ACH_SAME_DAY",
"ACH_STANDARD",
"ACH_REFUND",
"CHECK",
"ECHECK",
"INSTANT_DEPOSIT",
"INSTANT_FUNDING",
"PAYPAL",
"PREPAID",
"RTP",
"VENMO"
]
},
"amount": {
"type": "number",
"description": "Transaction amount",
"format": "double"
},
"reference_id": {
"type": "string",
"description": "Transaction reference ID - optional"
},
"memo": {
"type": "string",
"description": "Transaction memo - optional"
},
"email": {
"type": "string",
"description": "Email override for ECHECK transactions - optional"
},
"meta_params": {
"type": "string",
"description": "JSON string of values to include for reporting requirements. Please consult with technical team on usage."
},
"originating_transaction_id": {
"type": "string",
"description": "Originating Transaction ID to be referenced in the event of an ACH_REFUND transaction"
},
"funding_options": {
"properties": {
"risk_check": {
"type": "boolean",
"description": "Evaluate the risk profile of the user/bank - optional",
"default": false
},
"ip_address": {
"type": "string",
"description": "User's IP address, can help mitigate against fraudulent transactions - optional"
},
"user_agent": {
"type": "string",
"description": "User agent of user's device, can help mitigate against fraudulent transactions - optional"
},
"user_segment": {
"type": "string",
"description": "User's segment name to reference segmented controls pertaining to velocity, balance, risk limits",
"default": "DEFAULT"
},
"device_id": {
"type": "string",
"description": "User's device ID"
}
},
"required": [],
"type": "object",
"description": "Required for Funding Transactions, not applicable for Payout transactions"
},
"location": {
"properties": {
"state": {
"type": "string",
"description": "Valid State or US Territory"
},
"ip_address": {
"type": "string",
"description": "IP address"
}
},
"required": [],
"type": "object",
"description": "Possibly required for compliance purposes"
}
}
},
"examples": {
"Instant Deposit": {
"value": {
"location_id": "NY",
"recipient_id": "REejizS5fnTLiQYhGTKYXZaQ==",
"account_id": "RPA-lOt8vNX9QweylLYpzrFiVQ==",
"method": "INSTANT_DEPOSIT",
"type": "CREDIT",
"amount": 10
}
},
"ACH Same Day": {
"value": {
"recipient_id": "REejizS5fnTLiQYhGTKYXZaQ==",
"account_id": "RPA-S3MBxLh4QjuF8TmXHyKjgw==",
"method": "ACH_SAME_DAY",
"type": "CREDIT",
"amount": 10
}
},
"ECheck": {
"value": {
"recipient_id": "REejizS5fnTLiQYhGTKYXZaQ==",
"method": "ECHECK",
"type": "CREDIT",
"amount": 10
}
},
"Check": {
"value": {
"recipient_id": "REejizS5fnTLiQYhGTKYXZaQ==",
"method": "CHECK",
"type": "CREDIT",
"amount": 10
}
},
"Instant Funding": {
"value": {
"recipient_id": "REejizS5fnTLiQYhGTKYXZaQ==",
"account_id": "RPA-lOt8vNX9QweylLYpzrFiVQ==",
"method": "INSTANT_FUNDING",
"type": "DEBIT",
"amount": 10
}
},
"RTP": {
"value": {
"recipient_id": "REejizS5fnTLiQYhGTKYXZaQ==",
"account_id": "RPA-lOt8we322lLYpzrFiVQ==",
"method": "RTP",
"type": "CREDIT",
"amount": 10
}
},
"ACH Funding Plus": {
"value": {
"recipient_id": "REejizS5fnTLiQYhGTKYXZaQ==",
"account_id": "RPA-S3MBxLh4QjuF8TmXHyKjgw==",
"method": "ACH_FUNDING_PLUS",
"type": "DEBIT",
"amount": 10,
"funding_options": {
"user_segment": "VIP_3",
"risk_check": true,
"ip_address": "108.456.789.204",
"user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 16_5_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.5.2 Mobile/15E148 Safari/604.1"
}
}
},
"ACH Refund": {
"value": {
"recipient_id": "REejizS5fnTLiQYhGTKYXZaQ==",
"account_id": "RPA-S3MBxLh4QjuF8TmXHyKjgw==",
"originating_transaction_id": "ICTN-3310-23206-62535-XQP",
"method": "ACH_REFUND",
"type": "CREDIT",
"amount": 10
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Failure": {
"value": "{\n \"http_status\": 200,\n \"error_code\": \"ERR_TRANSACTION_FAILURE\",\n \"error_message\": \"Error depositing funds\",\n \"transaction_id\": \"ICTN-43545-4344-444-WMJ\"\n}"
},
"Instant Deposit Decline": {
"value": "{\n \"http_status\": 200,\n \"error_code\": \"ERR_OCT_DECLINE\",\n \"error_message\": \"12:Invalid transaction\",\n \"transaction_id\": \"ICTN-43545-4344-444-WMJ\"\n}"
},
"OFAC Decline": {
"value": "{\n \"http_status\": 200,\n \"error_code\": \"ERR_OFAC_LIST_MATCH\",\n \"error_message\": \"Cancelled due to OFAC list match\",\n \"transaction_id\": \"ICTN-1-23213-123312-131\"\n}"
}
},
"schema": {
"oneOf": [
{
"title": "Failure",
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 200,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_TRANSACTION_FAILURE"
},
"error_message": {
"type": "string",
"example": "Error depositing funds"
},
"transaction_id": {
"type": "string",
"example": "ICTN-43545-4344-444-WMJ"
}
}
},
{
"title": "Instant Deposit Decline",
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 200,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_OCT_DECLINE"
},
"error_message": {
"type": "string",
"example": "12:Invalid transaction"
},
"transaction_id": {
"type": "string",
"example": "ICTN-43545-4344-444-WMJ"
}
}
},
{
"title": "OFAC Decline",
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 200,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_OFAC_LIST_MATCH"
},
"error_message": {
"type": "string",
"example": "Cancelled due to OFAC list match"
},
"transaction_id": {
"type": "string",
"example": "ICTN-1-23213-123312-131"
}
}
}
]
}
}
}
},
"201": {
"description": "201",
"content": {
"application/json": {
"examples": {
"ACH Same Day": {
"value": "{\n \"transaction_id\": \"ICTN-435-21313-72871-LJ1\",\n \"method\": \"ACH_SAME_DAY\",\n \"fee\": 0.00,\n \"amount\": 10.00,\n \"status\": \"PROCESSING\",\n \"created_date\": \"2021-11-09T20:14:31.439Z\",\n \"detail\": \"CHECKING 1****6789\",\n \"account_id\": \"RPA-S3MBxLh4QjuF8TmXHyKjgw==\",\n \"recipient_id\" : \"REejizS5fnTLiQYhGTKYXZaQ==\"\n}"
},
"Instant Deposit": {
"value": "{\n \"transaction_id\": \"ICTN-435-21313-73757-ETE\",\n \"method\": \"INSTANT_DEPOSIT\",\n \"fee\": 0.00,\n \"amount\": 10.00,\n \"status\": \"PAID\",\n \"created_date\": \"2021-11-09T20:29:17.758Z\",\n \"detail\": \"VISA PREPAID 0167\",\n \"account_id\": \"RPA-lOt8vNX9QweylLYpzrFiVQ==\",\n \"recipient_id\" : \"REejizS5fnTLiQYhGTKYXZaQ==\",\n \"paid_date\": \"2021-11-09T20:29:18.711Z\",\n \"network_approval_code\": \"ABC12345\",\n \"provider_reference_id\": \"987654321\"\n}"
},
"Check": {
"value": "{\n \"transaction_id\": \"ICTN-435-21315-53929-EQA\",\n \"method\": \"CHECK\",\n \"fee\": 0.00,\n \"amount\": 10.00,\n \"status\": \"PAID\",\n \"created_date\": \"2021-11-11T14:58:49.318Z\",\n \"detail\": \"987 MAIN STREET, MIAMI, FLORIDA 33132\",\n \"check_number\": \"10073\",\n \"recipient_id\" : \"REejizS5fnTLiQYhGTKYXZaQ==\"\n}"
},
"Instant Deposit - Unknown": {
"value": "{\n \"transaction_id\": \"ICTN-435-21313-73757-ETE\",\n \"method\": \"INSTANT_DEPOSIT\",\n \"fee\": 0.00,\n \"amount\": 10.00,\n \"status\": \"UNKNOWN\",\n \"created_date\": \"2021-11-09T20:29:17.758Z\",\n \"detail\": \"VISA PREPAID 0167\",\n \"account_id\": \"RPA-lOt8vNX9QweylLYpzrFiVQ==\",\n \"recipient_id\" : \"REejizS5fnTLiQYhGTKYXZaQ==\"\n}"
},
"RTP": {
"value": "{\n \"transaction_id\": \"ICTN-435-2211-45678-BEW\",\n \"method\": \"RTP\",\n \"fee\": 0.00,\n \"amount\": 10.00,\n \"status\": \"PROCESSING\",\n \"created_date\": \"2022-11-09T20:29:17.758Z\",\n \"detail\": \"CHECKING 1****6789\",\n \"account_id\": \"RPA-lOt8we322lLYpzrFiVQ==\",\n \"recipient_id\" : \"REejizS5fnTLiQYhGTKYXZaQ==\"\n}"
},
"Instant Funding": {
"value": "{\n \"transaction_id\": \"ICTN-435-21313-73757-ETE\",\n \"method\": \"INSTANT_FUNDING\",\n \"fee\": 0.00,\n \"amount\": 10.00,\n \"status\": \"PAID\",\n \"created_date\": \"2021-11-09T20:29:17.758Z\",\n \"detail\": \"VISA DEBIT 0167\",\n \"account_id\": \"RPA-lOt8vNX9QweylLYpzrFiVQ==\",\n \"recipient_id\" : \"REejizS5fnTLiQYhGTKYXZaQ==\",\n \"paid_date\": \"2021-11-09T20:29:18.711Z\",\n \"network_approval_code\": \"ABC12345\",\n \"provider_reference_id\": \"987654321\"\n}"
},
"Instant Funding with Partial Auth": {
"summary": "Instant Funding with Partial Auth",
"value": {
"transaction_id": "ICTN-435-21313-73757-ETE",
"method": "INSTANT_FUNDING",
"fee": 0,
"amount": 8,
"status": "PAID",
"created_date": "2021-11-09T20:29:17.758Z",
"detail": "VISA DEBIT 0167",
"account_id": "RPA-lOt8vNX9QweylLYpzrFiVQ==",
"recipient_id": "REejizS5fnTLiQYhGTKYXZaQ==",
"paid_date": "2021-11-09T20:29:18.711Z",
"network_approval_code": "ABC12345",
"provider_reference_id": "987654321",
"funding_options_response": {
"partial_auth_result": {
"amount_requested": 10,
"amount_approved": 8,
"amount_threshold": 5
}
}
}
}
},
"schema": {
"oneOf": [
{
"title": "ACH Same Day",
"type": "object",
"properties": {
"transaction_id": {
"type": "string",
"example": "ICTN-435-21313-72871-LJ1"
},
"method": {
"type": "string",
"example": "ACH_SAME_DAY"
},
"fee": {
"type": "integer",
"example": 0,
"default": 0
},
"amount": {
"type": "integer",
"example": 10,
"default": 0
},
"status": {
"type": "string",
"example": "PROCESSING"
},
"created_date": {
"type": "string",
"example": "2021-11-09T20:14:31.439Z"
},
"detail": {
"type": "string",
"example": "CHECKING 1****6789"
},
"account_id": {
"type": "string",
"example": "RPA-S3MBxLh4QjuF8TmXHyKjgw=="
},
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
}
}
},
{
"title": "Instant Deposit",
"type": "object",
"properties": {
"transaction_id": {
"type": "string",
"example": "ICTN-435-21313-73757-ETE"
},
"method": {
"type": "string",
"example": "INSTANT_DEPOSIT"
},
"fee": {
"type": "integer",
"example": 0,
"default": 0
},
"amount": {
"type": "integer",
"example": 10,
"default": 0
},
"status": {
"type": "string",
"example": "PAID"
},
"created_date": {
"type": "string",
"example": "2021-11-09T20:29:17.758Z"
},
"detail": {
"type": "string",
"example": "VISA PREPAID 0167"
},
"account_id": {
"type": "string",
"example": "RPA-lOt8vNX9QweylLYpzrFiVQ=="
},
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
},
"paid_date": {
"type": "string",
"example": "2021-11-09T20:29:18.711Z"
},
"network_approval_code": {
"type": "string",
"example": "ABC12345"
},
"provider_reference_id": {
"type": "string",
"example": "987654321"
}
}
},
{
"title": "Check",
"type": "object",
"properties": {
"transaction_id": {
"type": "string",
"example": "ICTN-435-21315-53929-EQA"
},
"method": {
"type": "string",
"example": "CHECK"
},
"fee": {
"type": "integer",
"example": 0,
"default": 0
},
"amount": {
"type": "integer",
"example": 10,
"default": 0
},
"status": {
"type": "string",
"example": "PAID"
},
"created_date": {
"type": "string",
"example": "2021-11-11T14:58:49.318Z"
},
"detail": {
"type": "string",
"example": "987 MAIN STREET, MIAMI, FLORIDA 33132"
},
"check_number": {
"type": "string",
"example": "10073"
},
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
}
}
},
{
"title": "Instant Deposit - Unknown",
"type": "object",
"properties": {
"transaction_id": {
"type": "string",
"example": "ICTN-435-21313-73757-ETE"
},
"method": {
"type": "string",
"example": "INSTANT_DEPOSIT"
},
"fee": {
"type": "integer",
"example": 0,
"default": 0
},
"amount": {
"type": "integer",
"example": 10,
"default": 0
},
"status": {
"type": "string",
"example": "UNKNOWN"
},
"created_date": {
"type": "string",
"example": "2021-11-09T20:29:17.758Z"
},
"detail": {
"type": "string",
"example": "VISA PREPAID 0167"
},
"account_id": {
"type": "string",
"example": "RPA-lOt8vNX9QweylLYpzrFiVQ=="
},
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
}
}
},
{
"title": "RTP",
"type": "object",
"properties": {
"transaction_id": {
"type": "string",
"example": "ICTN-435-2211-45678-BEW"
},
"method": {
"type": "string",
"example": "RTP"
},
"fee": {
"type": "integer",
"example": 0,
"default": 0
},
"amount": {
"type": "integer",
"example": 10,
"default": 0
},
"status": {
"type": "string",
"example": "PROCESSING"
},
"created_date": {
"type": "string",
"example": "2022-11-09T20:29:17.758Z"
},
"detail": {
"type": "string",
"example": "CHECKING 1****6789"
},
"account_id": {
"type": "string",
"example": "RPA-lOt8we322lLYpzrFiVQ=="
},
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
}
}
},
{
"title": "ACH Funding",
"type": "object",
"properties": {
"transaction_id": {
"type": "string",
"example": "ICTN-3310-23206-62535-XQP"
},
"method": {
"type": "string",
"example": "ACH_FUNDING"
},
"fee": {
"type": "integer",
"example": 0,
"default": 0
},
"amount": {
"type": "integer",
"example": 10,
"default": 0
},
"status": {
"type": "string",
"example": "PROCESSING"
},
"created_date": {
"type": "string",
"example": "2023-07-25T17:22:15.760Z"
},
"detail": {
"type": "string",
"example": "CHECKING 1****0000"
},
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
},
"account_id": {
"type": "string",
"example": "RPA-S3MBxLh4QjuF8TmXHyKjgw=="
},
"type": {
"type": "string",
"example": "DEBIT"
}
}
},
{
"title": "Instant Funding",
"type": "object",
"properties": {
"transaction_id": {
"type": "string",
"example": "ICTN-435-21313-73757-ETE"
},
"method": {
"type": "string",
"example": "INSTANT_FUNDING"
},
"fee": {
"type": "integer",
"example": 0,
"default": 0
},
"amount": {
"type": "integer",
"example": 10,
"default": 0
},
"status": {
"type": "string",
"example": "PAID"
},
"created_date": {
"type": "string",
"example": "2021-11-09T20:29:17.758Z"
},
"detail": {
"type": "string",
"example": "VISA DEBIT 0167"
},
"account_id": {
"type": "string",
"example": "RPA-lOt8vNX9QweylLYpzrFiVQ=="
},
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
},
"paid_date": {
"type": "string",
"example": "2021-11-09T20:29:18.711Z"
},
"network_approval_code": {
"type": "string",
"example": "ABC12345"
},
"provider_reference_id": {
"type": "string",
"example": "987654321"
}
}
}
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Invalid Account ID": {
"value": "{\n \"http_status\": 400,\n \"error_code\": \"ERR_INVALID_ACCOUNT_ID\",\n \"error_message\": \"Invalid account ID\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 400,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_ACCOUNT_ID"
},
"error_message": {
"type": "string",
"example": "Invalid account ID"
}
}
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"examples": {
"ACH Funding - Balance Threshold": {
"value": "{\n \"http_status\": 422,\n \"error_code\": \"ERR_ACCOUNT_BALANCE_THRESHOLD\",\n \"error_message\": \"Account balance insufficient\"\n}"
},
"ACH Funding - Consumer Risk Threshold": {
"value": "{\n \"http_status\": 422,\n \"error_code\": \"ERR_ACCOUNT_RISK_THRESHOLD\",\n \"error_message\": \"Account risk threshold exceeded\",\n \"transaction_id\": \"ICTN-3310-23241-64610-Y8S\",\n \"funding_options_response\": {\n \"plaid_provider\": {\n \"bank_risk_score\": 49,\n \"bank_risk_score_threshold\": 20,\n \"consumer_risk_score\": 66,\n \"consumer_risk_score_threshold\": 60\n }\n }\n}"
},
"422 - ACH Funding - Velocity Threshold": {
"value": "{\n \"http_status\": 422,\n \"error_code\": \"ERR_VELOCITY_LIMIT\",\n \"error_message\": \"Transaction failed due to velocity controls\",\n \"transaction_id\": \"ICTN-3310-23241-60143-CO4\"\n}"
},
"Bank Risk & Balance Multiplier Threshold": {
"value": "{\n \"http_status\": 422,\n \"error_code\": \"ERR_ACCOUNT_RISK_BANK_BALANCE_THRESHOLD\",\n \"error_message\": \"Account bank risk exceeded and balance insufficient\",\n \"transaction_id\": \"ICTN-3310-23241-64610-Y8S\",\n \"funding_options_response\": {\n \"plaid_provider\": {\n \"bank_risk_score\": 49,\n \"bank_risk_score_threshold\": 20,\n \"consumer_risk_score\": 51,\n \"consumer_risk_score_threshold\": 60\n }\n }\n}"
}
},
"schema": {
"oneOf": [
{
"title": "ACH Funding - Balance Threshold",
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 422,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_ACCOUNT_BALANCE_THRESHOLD"
},
"error_message": {
"type": "string",
"example": "Account balance insufficient"
}
}
},
{
"title": "ACH Funding - Consumer Risk Threshold",
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 422,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_ACCOUNT_RISK_THRESHOLD"
},
"error_message": {
"type": "string",
"example": "Account risk threshold exceeded"
},
"transaction_id": {
"type": "string",
"example": "ICTN-3310-23241-64610-Y8S"
},
"funding_options_response": {
"type": "object",
"properties": {
"plaid_provider": {
"type": "object",
"properties": {
"bank_risk_score": {
"type": "integer",
"example": 49,
"default": 0
},
"bank_risk_score_threshold": {
"type": "integer",
"example": 20,
"default": 0
},
"consumer_risk_score": {
"type": "integer",
"example": 66,
"default": 0
},
"consumer_risk_score_threshold": {
"type": "integer",
"example": 60,
"default": 0
}
}
}
}
}
}
},
{
"title": "422 - ACH Funding - Velocity Threshold",
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 422,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_VELOCITY_LIMIT"
},
"error_message": {
"type": "string",
"example": "Transaction failed due to velocity controls"
},
"transaction_id": {
"type": "string",
"example": "ICTN-3310-23241-60143-CO4"
}
}
},
{
"title": "Bank Risk & Balance Multiplier Threshold",
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 422,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_ACCOUNT_RISK_BANK_BALANCE_THRESHOLD"
},
"error_message": {
"type": "string",
"example": "Account bank risk exceeded and balance insufficient"
},
"transaction_id": {
"type": "string",
"example": "ICTN-3310-23241-64610-Y8S"
},
"funding_options_response": {
"type": "object",
"properties": {
"plaid_provider": {
"type": "object",
"properties": {
"bank_risk_score": {
"type": "integer",
"example": 49,
"default": 0
},
"bank_risk_score_threshold": {
"type": "integer",
"example": 20,
"default": 0
},
"consumer_risk_score": {
"type": "integer",
"example": 51,
"default": 0
},
"consumer_risk_score_threshold": {
"type": "integer",
"example": 60,
"default": 0
}
}
}
}
}
}
}
]
}
}
}
}
}
}
},
"/api/v2/{payer_id}/transactions/{transaction_id}": {
"patch": {
"summary": "Update Transaction",
"description": "",
"operationId": "update-transaction",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "transaction_id",
"in": "path",
"description": "Transaction ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status to update transaction",
"enum": [
"CANCELLED",
"REVERSED"
]
}
}
},
"examples": {
"Cancel Transaction": {
"value": {
"status": "CANCELLED"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 400,\n \"error_code\": \"ERR_TRANSACTION_STATUS_NOT_APPLICABLE\",\n \"error_message\": \"Transaction status cannot be applied\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 400,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_TRANSACTION_STATUS_NOT_APPLICABLE"
},
"error_message": {
"type": "string",
"example": "Transaction status cannot be applied"
}
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 404,\n \"error_code\": \"ERR_INVALID_TRANSACTION_ID\",\n \"error_message\": \"Invalid transaction ID\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 404,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_TRANSACTION_ID"
},
"error_message": {
"type": "string",
"example": "Invalid transaction ID"
}
}
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 422,\n \"error_code\": \"ERR_PAYMENT_STATUS_IMMUTABLE\",\n \"error_message\": \"Payment in immutable status\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 422,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_PAYMENT_STATUS_IMMUTABLE"
},
"error_message": {
"type": "string",
"example": "Payment in immutable status"
}
}
}
}
}
}
}
},
"get": {
"summary": "Get Transaction",
"description": "Get Transaction by Transaction ID\n\n`200` - Request Succeeded\n`404` - Transaction ID not found",
"operationId": "get-transaction",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "transaction_id",
"in": "path",
"description": "Transaction ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"ACH Same Day - PAID": {
"value": "{\n \"transaction_id\": \"ICTN-435-21313-72871-LJ1\",\n \"method\": \"ACH_SAME_DAY\",\n \"fee\": 0.00,\n \"amount\": 10.00,\n \"status\": \"PAID\",\n \"created_date\": \"2021-11-09T20:14:31.439Z\",\n \"paid_date\": \"2021-11-10T12:04:11.433Z\",\n \"detail\": \"CHECKING 1****6789\",\n \"account_id\": \"RPA-S3MBxLh4QjuF8TmXHyKjgw==\",\n \"recipient_id\" : \"REejizS5fnTLiQYhGTKYXZaQ==\"\n}"
},
"Instant Deposit": {
"value": "{\n \"transaction_id\": \"ICTN-435-21313-73757-ETE\",\n \"method\": \"INSTANT_DEPOSIT\",\n \"fee\": 0.00,\n \"amount\": 10.00,\n \"status\": \"PAID\",\n \"created_date\": \"2021-11-09T20:29:17.758Z\",\n \"detail\": \"VISA PREPAID 0167\",\n \"account_id\": \"RPA-lOt8vNX9QweylLYpzrFiVQ==\",\n \"recipient_id\" : \"REejizS5fnTLiQYhGTKYXZaQ==\",\n \"network_approval_code\": \"ABC12345\",\n \"provider_reference_id\": \"987654321\"\n}"
},
"ACH Same Day - FAILED": {
"value": "{\n \"transaction_id\": \"ICTN-435-21313-72871-LJ1\",\n \"method\": \"ACH_SAME_DAY\",\n \"fee\": 0.00,\n \"amount\": 10.00,\n \"status\": \"FAILED\",\n \"created_date\": \"2021-11-09T20:14:31.439Z\",\n \"failed_date\": \"2021-11-10T12:04:11.433Z\",\n \"detail\": \"CHECKING 1****6789\",\n \"account_id\": \"RPA-S3MBxLh4QjuF8TmXHyKjgw==\",\n \"recipient_id\" : \"REejizS5fnTLiQYhGTKYXZaQ==\",\n \"error_code\" : \"ERR_ACH_RETURN\",\n \"error_message\" : \"R04:Invalid Account Number\"\n}"
}
},
"schema": {
"oneOf": [
{
"title": "ACH Same Day - PAID",
"type": "object",
"properties": {
"transaction_id": {
"type": "string",
"example": "ICTN-435-21313-72871-LJ1"
},
"method": {
"type": "string",
"example": "ACH_SAME_DAY"
},
"fee": {
"type": "integer",
"example": 0,
"default": 0
},
"amount": {
"type": "integer",
"example": 10,
"default": 0
},
"status": {
"type": "string",
"example": "PAID"
},
"created_date": {
"type": "string",
"example": "2021-11-09T20:14:31.439Z"
},
"paid_date": {
"type": "string",
"example": "2021-11-10T12:04:11.433Z"
},
"detail": {
"type": "string",
"example": "CHECKING 1****6789"
},
"account_id": {
"type": "string",
"example": "RPA-S3MBxLh4QjuF8TmXHyKjgw=="
},
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
}
}
},
{
"title": "Instant Deposit",
"type": "object",
"properties": {
"transaction_id": {
"type": "string",
"example": "ICTN-435-21313-73757-ETE"
},
"method": {
"type": "string",
"example": "INSTANT_DEPOSIT"
},
"fee": {
"type": "integer",
"example": 0,
"default": 0
},
"amount": {
"type": "integer",
"example": 10,
"default": 0
},
"status": {
"type": "string",
"example": "PAID"
},
"created_date": {
"type": "string",
"example": "2021-11-09T20:29:17.758Z"
},
"detail": {
"type": "string",
"example": "VISA PREPAID 0167"
},
"account_id": {
"type": "string",
"example": "RPA-lOt8vNX9QweylLYpzrFiVQ=="
},
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
},
"network_approval_code": {
"type": "string",
"example": "ABC12345"
},
"provider_reference_id": {
"type": "string",
"example": "987654321"
}
}
},
{
"title": "ACH Same Day - FAILED",
"type": "object",
"properties": {
"transaction_id": {
"type": "string",
"example": "ICTN-435-21313-72871-LJ1"
},
"method": {
"type": "string",
"example": "ACH_SAME_DAY"
},
"fee": {
"type": "integer",
"example": 0,
"default": 0
},
"amount": {
"type": "integer",
"example": 10,
"default": 0
},
"status": {
"type": "string",
"example": "FAILED"
},
"created_date": {
"type": "string",
"example": "2021-11-09T20:14:31.439Z"
},
"failed_date": {
"type": "string",
"example": "2021-11-10T12:04:11.433Z"
},
"detail": {
"type": "string",
"example": "CHECKING 1****6789"
},
"account_id": {
"type": "string",
"example": "RPA-S3MBxLh4QjuF8TmXHyKjgw=="
},
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
},
"error_code": {
"type": "string",
"example": "ERR_ACH_RETURN"
},
"error_message": {
"type": "string",
"example": "R04:Invalid Account Number"
}
}
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Transaction ID not found": {
"value": "{\n \"http_status\": 404,\n \"error_code\": \"ERR_INVALID_TRANSACTION_ID\",\n \"error_message\": \"Invalid transaction ID\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 404,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_TRANSACTION_ID"
},
"error_message": {
"type": "string",
"example": "Invalid transaction ID"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/transactions/reference/{reference_id}": {
"get": {
"summary": "Get Transaction by Reference ID",
"description": "Get Transaction by Transaction reference ID\n\n`200` - Request Succeeded\n`404` - Transaction reference ID not found",
"operationId": "get-transaction-by-reference-id",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "reference_id",
"in": "path",
"description": "Transaction reference ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "[\n {\n \"transaction_id\": \"ICTN-435-21315-54033-XST\",\n \"reference_id\": \"transaction-123\",\n \"method\": \"CHECK\",\n \"fee\": 0.00,\n \"amount\": 10.00,\n \"status\": \"PAID\",\n \"created_date\": \"2021-11-11T15:00:33.092Z\",\n \"detail\": \"987 MAIN STREET, MIAMI, FLORIDA 33132\",\n \"check_number\": \"10074\",\n \t\t\"recipient_id\" : \"REejizS5fnTLiQYhGTKYXZaQ==\"\n }\n]"
}
},
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"transaction_id": {
"type": "string",
"example": "ICTN-435-21315-54033-XST"
},
"reference_id": {
"type": "string",
"example": "transaction-123"
},
"method": {
"type": "string",
"example": "CHECK"
},
"fee": {
"type": "integer",
"example": 0,
"default": 0
},
"amount": {
"type": "integer",
"example": 10,
"default": 0
},
"status": {
"type": "string",
"example": "PAID"
},
"created_date": {
"type": "string",
"example": "2021-11-11T15:00:33.092Z"
},
"detail": {
"type": "string",
"example": "987 MAIN STREET, MIAMI, FLORIDA 33132"
},
"check_number": {
"type": "string",
"example": "10074"
},
"recipient_id": {
"type": "string",
"example": "REejizS5fnTLiQYhGTKYXZaQ=="
}
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/payers/accounts": {
"get": {
"summary": "Get Payer Bank Accounts",
"description": "Get Payer Bank Accounts for a Payer",
"operationId": "get-payer-bank-accounts",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "[\n {\n \t\"name\" : \"Payer 1\",\n \"account_bank\": \"Bank of ABC\",\n \"routing_number\": \"987654321\",\n \"account_number\": \"123456789\",\n \"balance\": 893246.06,\n \"balance_real_time\": true,\n \"payout_methods\": [\n \"INSTANT_DEPOSIT\",\"ACH_SAME_DAY\"\n ]\n },\n {\n \"name\" : \"Payer 1\",\n \"account_bank\": \"Bank of XYZ\",\n \"routing_number\": \"987654322\",\n \"account_number\": \"123456788\",\n \"balance\": 224906.23,\n \"balance_real_time\": true,\n \"payout_methods\": [\n \"PHYSICAL_CARD_VISA\"\n ]\n }\n]"
}
},
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Payer 1"
},
"account_bank": {
"type": "string",
"example": "Bank of ABC"
},
"routing_number": {
"type": "string",
"example": "987654321"
},
"account_number": {
"type": "string",
"example": "123456789"
},
"balance": {
"type": "number",
"example": 893246.06,
"default": 0
},
"balance_real_time": {
"type": "boolean",
"example": true,
"default": true
},
"payout_methods": {
"type": "array",
"items": {
"type": "string",
"example": "INSTANT_DEPOSIT"
}
}
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/reports/ach/funding/settlement": {
"get": {
"summary": "Get ACH Settlement Report",
"description": "",
"operationId": "get-ach-settlement-report",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "settleDate",
"in": "query",
"description": "Format of date should be yyyy-mm-dd",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"text/plain": {
"examples": {
"Result": {
"value": "\"Payer Name\",\"Payer ID\",Name,\"Transaction ID\",\"Transaction Created Date(EST)\",\"Paid Date\",\"Failed Date\",\"Transaction Status\",\"Transaction Method\",\"Transaction Type\",\"Return Code\",\"Settlement Date\",\"Recipient Account\",\"Settlement Bank Transaction ID\",\"ACH Bank Transaction ID\",\"Recipient External Reference ID\",\"Transaction External Reference ID\",Attempts,\"Settled Account\",\"Sent To\",\"Transaction Amount\""
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 404,\n \"error_code\": \"ERR_SETTLEMENT_REPORT\",\n \"error_message\": \"No report found\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 404,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_SETTLEMENT_REPORT"
},
"error_message": {
"type": "string",
"example": "No report found"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/reports/oct/transactions": {
"get": {
"summary": "Get OCT Transactions Report",
"description": "Get Aggregator or Payer OCT Transactions Report for a date range. The `payer_id` value passed in should reflect the requested Aggregator or Payer. There is a maximum date range of 31 days enforced.\n\n** Report returns a `Content-Type` of `application/csv`\n\n`200` - Request succeeded\n`400` - Bad Request, missing or invalid parameters",
"operationId": "get-payer-oct-transactions-report",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "startDate",
"in": "query",
"description": "Format of date should be yyyy-mm-dd",
"schema": {
"type": "string"
}
},
{
"name": "endDate",
"in": "query",
"description": "Format of date should be yyyy-mm-dd",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"text/plain": {
"examples": {
"application/csv": {
"value": "Payer Name,Payer ID,First Name,Last Name,Interchecks Transaction ID,Transaction Timestamp,Transaction Status,Amount,Debit Type,Network Response Code,OCT Reference ID,Card,Settlement Date,Interchecks Settlement Reference\nExamplePayerName,payerId,FirstName,LastName,ICTN-1234,2022-08-18 20:09:00.780918,Paid,0.33,Instant Deposit,00,223100000012,451530XXXXXX0852,08/19/2022,20220819_1660888820_AUTO"
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/reports/oct/settlement": {
"get": {
"summary": "Get OCT Settlement Report",
"description": "Get Aggregator or Payer OCT Settlement Report for a specific Settle Date. The `payer_id` value passed in should reflect the requested Aggregator or Payer.\n\n** Report returns a `Content-Type` of `application/csv`\n\n`200` - Request succeeded\n`400` - Bad Request, missing or invalid parameters\n`404` - Report does not exist",
"operationId": "get-payer-oct-settlement-report",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "settleDate",
"in": "query",
"description": "Format of date should be yyyy-mm-dd",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"text/plain": {
"examples": {
"application/csv": {
"value": "Payer Name,Payer ID,First Name,Last Name,Interchecks Transaction ID,Transaction Timestamp,Transaction Status,Debit Type,Amount,DR/CR,Network Response Code,GL Post Status,GL Post Reference,Settlement Date,Account Number,OCT Reference ID,Card\nExamplePayerName,PayerId,FirstName,LastName,ICTN-1234,2022-08-18 23:54:00,Paid,Instant Deposit,0.3,DR,00,SUCCESS,223106000018-IKT7Z6E3F3,08/19/2022,66600000210,223103000067,451530XXXXXX0381"
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 404,\n \"error_code\": \"ERR_SETTLEMENT_REPORT\",\n \"error_message\": \"No report found\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 404,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_SETTLEMENT_REPORT"
},
"error_message": {
"type": "string",
"example": "No report found"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/reports/user-tracking": {
"get": {
"summary": "Get User Activity Report",
"description": "Get Payer user activity Report for a date range. The `payer_id` value passed in should reflect the requested Aggregator or Payer. There is a maximum date range of 31 days enforced.** Report returns a `Content-Type` of `application/csv``200` - Request succeeded`400` - Bad Request, missing or invalid parameters",
"operationId": "get-user-activity-report",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "startDate",
"in": "query",
"description": "Format of date should be yyyy-mm-dd",
"schema": {
"type": "string"
}
},
{
"name": "endDate",
"in": "query",
"description": "Format of date should be yyyy-mm-dd",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "200",
"content": {
"text/plain": {
"examples": {
"application/csv": {
"value": "Username,Email,\"IP Address\",\"Portal Area\",\"Portal Action\",\"Target ID\",\"Target Reference ID\",Date"
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/payload/encryption/test/decryption": {
"post": {
"summary": "Post Payload Encryption Test Decryption",
"description": "Return plaintext when sent an encrypted payload",
"operationId": "post-payload-encryption-test-decryption",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "X-PayerId",
"in": "header",
"description": "Payer ID",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"RAW_BODY": {
"type": "string",
"description": "Encrypted Request Json format as defined in the Encrypted Payload Guide",
"format": "json"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"encryptedPayload\": \"9spSIO9+Zhhtcx21gKaujVjmFGhaRszg6xxxC3aPfy3qGrhobRKG4LjF8Z45J2CnW5HcQQbMUCCzgRjSG9HQtXvPYBZ+mNfNgX+5y0IgTzAeE8JDN04Z65+XPcakH8cjj2KGqTI1E3oMWKrAx73rEsGSQh6nHu89XMbXYSRhzGcQRKvX797kkTA64ybTSY1HX4SHzFUjrg==\",\n \"decryptedPayload\": \"{\\r\\n \\\"email\\\": \\\"sherlock@mailpoof.com\\\",\\r\\n \\\"first_name\\\": \\\"Sherlock\\\",\\r\\n \\\"last_name\\\": \\\"Holmes\\\",\\r\\n \\\"reference_id\\\": \\\"payee-123\\\"\\r\\n}\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"encryptedPayload": {
"type": "string",
"example": "9spSIO9+Zhhtcx21gKaujVjmFGhaRszg6xxxC3aPfy3qGrhobRKG4LjF8Z45J2CnW5HcQQbMUCCzgRjSG9HQtXvPYBZ+mNfNgX+5y0IgTzAeE8JDN04Z65+XPcakH8cjj2KGqTI1E3oMWKrAx73rEsGSQh6nHu89XMbXYSRhzGcQRKvX797kkTA64ybTSY1HX4SHzFUjrg=="
},
"decryptedPayload": {
"type": "string",
"example": "{\r\n \"email\": \"sherlock@mailpoof.com\",\r\n \"first_name\": \"Sherlock\",\r\n \"last_name\": \"Holmes\",\r\n \"reference_id\": \"payee-123\"\r\n}"
}
}
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"examples": {
"Internal Server Error - Format": {
"value": "{\n \"http_status\": 422,\n \"error_code\": \"ERR_PAYLOAD_ENCRYPTION_ERROR\",\n \"error_message\": \"Error Encountered. Expected: [encryptedText, key, kid, ivSpec].\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 422,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_PAYLOAD_ENCRYPTION_ERROR"
},
"error_message": {
"type": "string",
"example": "Error Encountered. Expected: [encryptedText, key, kid, ivSpec]."
}
}
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"examples": {
"Internal Server Error - Decryption": {
"value": "{\n \"http_status\": 500,\n \"error_code\": \"ERR_PAYLOAD_ENCRYPTION_ERROR\",\n \"error_message\": \"Error Encountered While Decrypting Payload.\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 500,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_PAYLOAD_ENCRYPTION_ERROR"
},
"error_message": {
"type": "string",
"example": "Error Encountered While Decrypting Payload."
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/payload/encryption/test/encryption": {
"post": {
"summary": "Post Payload Encryption Test Encryption",
"description": "Returns encrypted response when sent plaintext JSON",
"operationId": "post-payload-encryption-test-encryption",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "X-PayerId",
"in": "header",
"description": "Payer ID",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"RAW_BODY": {
"type": "string",
"description": "Plaintext JSON, i.e. {\"Hello\": \"World\"}"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"encryptedText\": \"8Qklz3Ph30pORkQK4m+dZNSnsUyXU54ftrC5fFoWfrn4umDSEEscIJ0kYJBUYkaOoX/3UDexaMmJTanOpgOvU6xz5AI52aFgDo6GkVEXIPkHE4Ne6Fae3ai3JK5PhsSbmh1t7VLXmzshpofARAirorDc4x/+gTXntZFvYTL0jQfbTAYstoSLO3WrUGrg1NhYQR/ageQpaw==\",\n \"key\": \"3f01e22b2099dbb7d0310c6be46d366053721549c4ef4c13a8b495c2abc3b8ef7f5bc92639f47eae5200ddbce952b22113863a6e064ac5e6ac593763112ee4c545b151e5374a24c357ec4fbed4fc1fa117a48b6d509741a38c4eddad4dbf40a953fab72a867995630003d383b340ccd80bda3c01a0210549586b7dd6105d170b903a80a5714a26cc2e20a53a5e9b27665a7c817be632a2b01e4a3618e49365206fb00462b578b4cdbbcc3c5d693d696587734d788feaaffb4f9023290803a9a761396b5c10aa3001658268e128576770aaec42c4994b3b95e2f1b4d12603bf0df7802e378b6c682fc318b510d804ad99e769bdee92c0be114ae85fc35a2517060de660df9a106f2635c4f89a05cfb8fe9f3e612c7ff143e0e8721ee367bb051a7569d5b52e15de37aaf72faaf0668182bb2255fa6f2c732d8daeac26badb4df611ad9ca482608df1bf86c43398509447f0c724755bcd2a8ac5fcf82231950bad7a652d489b7472520e9cebaa0171c7a0369f5817fe78c3cf8c0d470b5a9ce7d30d31da1edcf70860158496b4b56d025b4ee5e6baeb0e2d76f5d673d87bbc69357dfb3f770a0c025ca18712b24c8a6c8e394660b8d4839838394b56225fb95aeebe8010a25d2922af70e9795d81e341267bbe404b81f163f7b3ef617158ba1d228f08dd1ff49238f6ca94bb92d6a2d2b1000a9f12daa24fc1a203d7fb15fc09dc\",\n \"kid\": \"\\\"ABC001\\\"\",\n \"ivSpec\": \"0bb3a62faaf7661055697f7225e934f43f36435d59466348b1127be39c35532b23abd921b00c07d03d2e8ae6a9b2dc4fb35fd3addc18b6c92df640ba4805e220eeceffd95c061305a8d1d0047729b1149b4c2a94882d46509833551740df57cd0dde34fe3eb5ecaf1a792123110a57de5932d80c8648f8e9dcc317873a5dc5eaf6ea5e950ce131f9dde8e6762d2aff09e3dcb2ca10d10e065df348e213b6ba4ddc9e943cc730466ed84ad212fb3095dbd382730951658a94c10e99fdf1c5f88ba54d9837c792e7e87e1fb30e42b5eb94e0d27b580e0295941a5d68b744b7a405ba3de3426af6248ca4999e10e3bdd43f6365dffc83f520fe281d91e39200e088b982d3b0c58f50e46766b9666955c249c35a8761053eebe7440b87ea3c036e5eccb321b34efd35cac9760f66eb6f4107395f52b12d8efe48d801eb8934ff6e881eb634b21fb2c7b7ca1267b8c60bc07aff8ae2135da2be8a8c12b6ed3a1054105898240eb121d993eb7e167860a32b4db312765a918c26b079d97163008939a38acc7c71c911c82c3e73c2642811892e7d06a0ffcf790e0a7759ee4e100e8ab967e4590bf6a758f3aebf648c723b4169e2970b1d813d9afa330ec0c3a1c3d88714169e987d2bebbfc0a0327bb65390b30279fed28dc98d480b677d46c029b6269607663801e6a35f6aacc8879ad57f8a543b6356f39f9ffc1ceb6746d24eded2\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"encryptedText": {
"type": "string",
"example": "8Qklz3Ph30pORkQK4m+dZNSnsUyXU54ftrC5fFoWfrn4umDSEEscIJ0kYJBUYkaOoX/3UDexaMmJTanOpgOvU6xz5AI52aFgDo6GkVEXIPkHE4Ne6Fae3ai3JK5PhsSbmh1t7VLXmzshpofARAirorDc4x/+gTXntZFvYTL0jQfbTAYstoSLO3WrUGrg1NhYQR/ageQpaw=="
},
"key": {
"type": "string",
"example": "3f01e22b2099dbb7d0310c6be46d366053721549c4ef4c13a8b495c2abc3b8ef7f5bc92639f47eae5200ddbce952b22113863a6e064ac5e6ac593763112ee4c545b151e5374a24c357ec4fbed4fc1fa117a48b6d509741a38c4eddad4dbf40a953fab72a867995630003d383b340ccd80bda3c01a0210549586b7dd6105d170b903a80a5714a26cc2e20a53a5e9b27665a7c817be632a2b01e4a3618e49365206fb00462b578b4cdbbcc3c5d693d696587734d788feaaffb4f9023290803a9a761396b5c10aa3001658268e128576770aaec42c4994b3b95e2f1b4d12603bf0df7802e378b6c682fc318b510d804ad99e769bdee92c0be114ae85fc35a2517060de660df9a106f2635c4f89a05cfb8fe9f3e612c7ff143e0e8721ee367bb051a7569d5b52e15de37aaf72faaf0668182bb2255fa6f2c732d8daeac26badb4df611ad9ca482608df1bf86c43398509447f0c724755bcd2a8ac5fcf82231950bad7a652d489b7472520e9cebaa0171c7a0369f5817fe78c3cf8c0d470b5a9ce7d30d31da1edcf70860158496b4b56d025b4ee5e6baeb0e2d76f5d673d87bbc69357dfb3f770a0c025ca18712b24c8a6c8e394660b8d4839838394b56225fb95aeebe8010a25d2922af70e9795d81e341267bbe404b81f163f7b3ef617158ba1d228f08dd1ff49238f6ca94bb92d6a2d2b1000a9f12daa24fc1a203d7fb15fc09dc"
},
"kid": {
"type": "string",
"example": "\"ABC001\""
},
"ivSpec": {
"type": "string",
"example": "0bb3a62faaf7661055697f7225e934f43f36435d59466348b1127be39c35532b23abd921b00c07d03d2e8ae6a9b2dc4fb35fd3addc18b6c92df640ba4805e220eeceffd95c061305a8d1d0047729b1149b4c2a94882d46509833551740df57cd0dde34fe3eb5ecaf1a792123110a57de5932d80c8648f8e9dcc317873a5dc5eaf6ea5e950ce131f9dde8e6762d2aff09e3dcb2ca10d10e065df348e213b6ba4ddc9e943cc730466ed84ad212fb3095dbd382730951658a94c10e99fdf1c5f88ba54d9837c792e7e87e1fb30e42b5eb94e0d27b580e0295941a5d68b744b7a405ba3de3426af6248ca4999e10e3bdd43f6365dffc83f520fe281d91e39200e088b982d3b0c58f50e46766b9666955c249c35a8761053eebe7440b87ea3c036e5eccb321b34efd35cac9760f66eb6f4107395f52b12d8efe48d801eb8934ff6e881eb634b21fb2c7b7ca1267b8c60bc07aff8ae2135da2be8a8c12b6ed3a1054105898240eb121d993eb7e167860a32b4db312765a918c26b079d97163008939a38acc7c71c911c82c3e73c2642811892e7d06a0ffcf790e0a7759ee4e100e8ab967e4590bf6a758f3aebf648c723b4169e2970b1d813d9afa330ec0c3a1c3d88714169e987d2bebbfc0a0327bb65390b30279fed28dc98d480b677d46c029b6269607663801e6a35f6aacc8879ad57f8a543b6356f39f9ffc1ceb6746d24eded2"
}
}
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"examples": {
"Internal Server Error - Format": {
"value": "{\n \"http_status\": 422,\n \"error_code\": \"ERR_PAYLOAD_ENCRYPTION_ERROR\",\n \"error_message\": \"Error Encountered. Expected: [encryptedText, key, kid, ivSpec].\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 422,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_PAYLOAD_ENCRYPTION_ERROR"
},
"error_message": {
"type": "string",
"example": "Error Encountered. Expected: [encryptedText, key, kid, ivSpec]."
}
}
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"examples": {
"Internal Server Error - Encryption": {
"value": "{\n \"http_status\": 500,\n \"error_code\": \"ERR_PAYLOAD_ENCRYPTION_ERROR\",\n \"error_message\": \"Error Encountered While Encrypting Payload.\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 500,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_PAYLOAD_ENCRYPTION_ERROR"
},
"error_message": {
"type": "string",
"example": "Error Encountered While Encrypting Payload."
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/payload/encryption/test/end-to-end": {
"post": {
"summary": "Post Payload Encryption Test End to End",
"description": "Fully test payload encryption by sending an encrypted request and receiving an encrypted response with no business logic",
"operationId": "post-payload-encryption-test-end-to-end",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"RAW_BODY": {
"type": "string",
"description": "Encrypted Request Json format as defined in the Encrypted Payload Guide"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"encryptedText\": \"8Qklz3Ph30pORkQK4m+dZNSnsUyXU54ftrC5fFoWfrn4umDSEEscIJ0kYJBUYkaOoX/3UDexaMmJTanOpgOvU6xz5AI52aFgDo6GkVEXIPkHE4Ne6Fae3ai3JK5PhsSbmh1t7VLXmzshpofARAirorDc4x/+gTXntZFvYTL0jQfbTAYstoSLO3WrUGrg1NhYQR/ageQpaw==\",\n \"key\": \"3f01e22b2099dbb7d0310c6be46d366053721549c4ef4c13a8b495c2abc3b8ef7f5bc92639f47eae5200ddbce952b22113863a6e064ac5e6ac593763112ee4c545b151e5374a24c357ec4fbed4fc1fa117a48b6d509741a38c4eddad4dbf40a953fab72a867995630003d383b340ccd80bda3c01a0210549586b7dd6105d170b903a80a5714a26cc2e20a53a5e9b27665a7c817be632a2b01e4a3618e49365206fb00462b578b4cdbbcc3c5d693d696587734d788feaaffb4f9023290803a9a761396b5c10aa3001658268e128576770aaec42c4994b3b95e2f1b4d12603bf0df7802e378b6c682fc318b510d804ad99e769bdee92c0be114ae85fc35a2517060de660df9a106f2635c4f89a05cfb8fe9f3e612c7ff143e0e8721ee367bb051a7569d5b52e15de37aaf72faaf0668182bb2255fa6f2c732d8daeac26badb4df611ad9ca482608df1bf86c43398509447f0c724755bcd2a8ac5fcf82231950bad7a652d489b7472520e9cebaa0171c7a0369f5817fe78c3cf8c0d470b5a9ce7d30d31da1edcf70860158496b4b56d025b4ee5e6baeb0e2d76f5d673d87bbc69357dfb3f770a0c025ca18712b24c8a6c8e394660b8d4839838394b56225fb95aeebe8010a25d2922af70e9795d81e341267bbe404b81f163f7b3ef617158ba1d228f08dd1ff49238f6ca94bb92d6a2d2b1000a9f12daa24fc1a203d7fb15fc09dc\",\n \"kid\": \"\\\"CK001\\\"\",\n \"ivSpec\": \"0bb3a62faaf7661055697f7225e934f43f36435d59466348b1127be39c35532b23abd921b00c07d03d2e8ae6a9b2dc4fb35fd3addc18b6c92df640ba4805e220eeceffd95c061305a8d1d0047729b1149b4c2a94882d46509833551740df57cd0dde34fe3eb5ecaf1a792123110a57de5932d80c8648f8e9dcc317873a5dc5eaf6ea5e950ce131f9dde8e6762d2aff09e3dcb2ca10d10e065df348e213b6ba4ddc9e943cc730466ed84ad212fb3095dbd382730951658a94c10e99fdf1c5f88ba54d9837c792e7e87e1fb30e42b5eb94e0d27b580e0295941a5d68b744b7a405ba3de3426af6248ca4999e10e3bdd43f6365dffc83f520fe281d91e39200e088b982d3b0c58f50e46766b9666955c249c35a8761053eebe7440b87ea3c036e5eccb321b34efd35cac9760f66eb6f4107395f52b12d8efe48d801eb8934ff6e881eb634b21fb2c7b7ca1267b8c60bc07aff8ae2135da2be8a8c12b6ed3a1054105898240eb121d993eb7e167860a32b4db312765a918c26b079d97163008939a38acc7c71c911c82c3e73c2642811892e7d06a0ffcf790e0a7759ee4e100e8ab967e4590bf6a758f3aebf648c723b4169e2970b1d813d9afa330ec0c3a1c3d88714169e987d2bebbfc0a0327bb65390b30279fed28dc98d480b677d46c029b6269607663801e6a35f6aacc8879ad57f8a543b6356f39f9ffc1ceb6746d24eded2\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"encryptedText": {
"type": "string",
"example": "8Qklz3Ph30pORkQK4m+dZNSnsUyXU54ftrC5fFoWfrn4umDSEEscIJ0kYJBUYkaOoX/3UDexaMmJTanOpgOvU6xz5AI52aFgDo6GkVEXIPkHE4Ne6Fae3ai3JK5PhsSbmh1t7VLXmzshpofARAirorDc4x/+gTXntZFvYTL0jQfbTAYstoSLO3WrUGrg1NhYQR/ageQpaw=="
},
"key": {
"type": "string",
"example": "3f01e22b2099dbb7d0310c6be46d366053721549c4ef4c13a8b495c2abc3b8ef7f5bc92639f47eae5200ddbce952b22113863a6e064ac5e6ac593763112ee4c545b151e5374a24c357ec4fbed4fc1fa117a48b6d509741a38c4eddad4dbf40a953fab72a867995630003d383b340ccd80bda3c01a0210549586b7dd6105d170b903a80a5714a26cc2e20a53a5e9b27665a7c817be632a2b01e4a3618e49365206fb00462b578b4cdbbcc3c5d693d696587734d788feaaffb4f9023290803a9a761396b5c10aa3001658268e128576770aaec42c4994b3b95e2f1b4d12603bf0df7802e378b6c682fc318b510d804ad99e769bdee92c0be114ae85fc35a2517060de660df9a106f2635c4f89a05cfb8fe9f3e612c7ff143e0e8721ee367bb051a7569d5b52e15de37aaf72faaf0668182bb2255fa6f2c732d8daeac26badb4df611ad9ca482608df1bf86c43398509447f0c724755bcd2a8ac5fcf82231950bad7a652d489b7472520e9cebaa0171c7a0369f5817fe78c3cf8c0d470b5a9ce7d30d31da1edcf70860158496b4b56d025b4ee5e6baeb0e2d76f5d673d87bbc69357dfb3f770a0c025ca18712b24c8a6c8e394660b8d4839838394b56225fb95aeebe8010a25d2922af70e9795d81e341267bbe404b81f163f7b3ef617158ba1d228f08dd1ff49238f6ca94bb92d6a2d2b1000a9f12daa24fc1a203d7fb15fc09dc"
},
"kid": {
"type": "string",
"example": "\"CK001\""
},
"ivSpec": {
"type": "string",
"example": "0bb3a62faaf7661055697f7225e934f43f36435d59466348b1127be39c35532b23abd921b00c07d03d2e8ae6a9b2dc4fb35fd3addc18b6c92df640ba4805e220eeceffd95c061305a8d1d0047729b1149b4c2a94882d46509833551740df57cd0dde34fe3eb5ecaf1a792123110a57de5932d80c8648f8e9dcc317873a5dc5eaf6ea5e950ce131f9dde8e6762d2aff09e3dcb2ca10d10e065df348e213b6ba4ddc9e943cc730466ed84ad212fb3095dbd382730951658a94c10e99fdf1c5f88ba54d9837c792e7e87e1fb30e42b5eb94e0d27b580e0295941a5d68b744b7a405ba3de3426af6248ca4999e10e3bdd43f6365dffc83f520fe281d91e39200e088b982d3b0c58f50e46766b9666955c249c35a8761053eebe7440b87ea3c036e5eccb321b34efd35cac9760f66eb6f4107395f52b12d8efe48d801eb8934ff6e881eb634b21fb2c7b7ca1267b8c60bc07aff8ae2135da2be8a8c12b6ed3a1054105898240eb121d993eb7e167860a32b4db312765a918c26b079d97163008939a38acc7c71c911c82c3e73c2642811892e7d06a0ffcf790e0a7759ee4e100e8ab967e4590bf6a758f3aebf648c723b4169e2970b1d813d9afa330ec0c3a1c3d88714169e987d2bebbfc0a0327bb65390b30279fed28dc98d480b677d46c029b6269607663801e6a35f6aacc8879ad57f8a543b6356f39f9ffc1ceb6746d24eded2"
}
}
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"examples": {
"Internal Server Error - Format": {
"value": "{\n \"http_status\": 422,\n \"error_code\": \"ERR_PAYLOAD_ENCRYPTION_ERROR\",\n \"error_message\": \"Error Encountered. Expected: [encryptedText, key, kid, ivSpec].\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 422,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_PAYLOAD_ENCRYPTION_ERROR"
},
"error_message": {
"type": "string",
"example": "Error Encountered. Expected: [encryptedText, key, kid, ivSpec]."
}
}
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"examples": {
"Internal Server Error - Decryption": {
"value": "{\n \"http_status\": 500,\n \"error_code\": \"ERR_PAYLOAD_ENCRYPTION_ERROR\",\n \"error_message\": \"Error Encountered While Decrypting Payload.\"\n}"
},
"Internal Server Error - Encryption": {
"value": "{\n \"http_status\": 500,\n \"error_code\": \"ERR_PAYLOAD_ENCRYPTION_ERROR\",\n \"error_message\": \"Error Encountered While Encrypting Payload.\"\n}"
}
},
"schema": {
"oneOf": [
{
"title": "Internal Server Error - Decryption",
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 500,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_PAYLOAD_ENCRYPTION_ERROR"
},
"error_message": {
"type": "string",
"example": "Error Encountered While Decrypting Payload."
}
}
},
{
"title": "Internal Server Error - Encryption",
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 500,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_PAYLOAD_ENCRYPTION_ERROR"
},
"error_message": {
"type": "string",
"example": "Error Encountered While Encrypting Payload."
}
}
}
]
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/payload/encryption/public-key/{format}": {
"get": {
"summary": "Get Encryption Public Key",
"description": "",
"operationId": "get-encryption-public-key",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer Id",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "format",
"in": "path",
"description": "Public Key Format. Both pem and jwk formats are supported.",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"key\":\"-----BEGIN PUBLIC KEY-----\\rMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA8Jidkl06C2nepHPKEvzz\\rPoPfJRJfxCKuwnz6XIgHzZV9wWspMhrK4uHGFb5zHsjWNkf6/eySw58suDyMLRxp\\rydlAnDi8gMrnYaIPR1q4TA9teOV/5ygujR6dXlQAlq/n0cS1G/73zTER8Uw6pLHv\\r2XeGILEBL7kaga1kZRTRP7IBr7Ae6zaZ7Lg7qjZVcagdOen2Tavh63PdsglZsCoj\\r3NWeLGqqKvjJCZtgK//AdxuTK4V7lsHVDQ/Ry75XQY9UkJC5mAcfmlxV6BmJ3X4b\\rcH5VcwNrT/A8iiqJNhwfcBbWl8ISDH7uDW2iOKRnLCwLwpdozGMWey/2SHzOXBWF\\rpcXWyY1tLYO078FC4xHHWv94fSiyohUrEIQeHy02t5VuboUY4uOWWySmzmZngqaF\\rf0rlU9ePk58blOgaHMW0fySvkkKCeqnXNXDS8CUQB7Cp9e09OZ6via2ByteGabhh\\rgYyP4yQTGEtlgjv8Gr61zCBSBoEh1lWVJQWGUWubONpZEBgGg7BV88o8ZCREic0T\\r9ReIu16ptXZzUwFZp5+3AI1BywAUVXTs1UbXiXBj9V4CXmj9eTnVYON1x887MRsO\\rR+aJVO9xVK+jSvXnQ5dmeOIXEwtpkOhGC4ZNU+u3vo5nqTYUu/9x/KX70cZndr5G\\rYVsv5HIdh8aozj+WBnkEbkECAwEAAQ==\\r-----END PUBLIC KEY-----\",\n \"versionId\":\"80b9761f-166d-4225-809f-d01d02cf5117\",\n \"format\":\"pem\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "-----BEGIN PUBLIC KEY-----\rMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA8Jidkl06C2nepHPKEvzz\rPoPfJRJfxCKuwnz6XIgHzZV9wWspMhrK4uHGFb5zHsjWNkf6/eySw58suDyMLRxp\rydlAnDi8gMrnYaIPR1q4TA9teOV/5ygujR6dXlQAlq/n0cS1G/73zTER8Uw6pLHv\r2XeGILEBL7kaga1kZRTRP7IBr7Ae6zaZ7Lg7qjZVcagdOen2Tavh63PdsglZsCoj\r3NWeLGqqKvjJCZtgK//AdxuTK4V7lsHVDQ/Ry75XQY9UkJC5mAcfmlxV6BmJ3X4b\rcH5VcwNrT/A8iiqJNhwfcBbWl8ISDH7uDW2iOKRnLCwLwpdozGMWey/2SHzOXBWF\rpcXWyY1tLYO078FC4xHHWv94fSiyohUrEIQeHy02t5VuboUY4uOWWySmzmZngqaF\rf0rlU9ePk58blOgaHMW0fySvkkKCeqnXNXDS8CUQB7Cp9e09OZ6via2ByteGabhh\rgYyP4yQTGEtlgjv8Gr61zCBSBoEh1lWVJQWGUWubONpZEBgGg7BV88o8ZCREic0T\r9ReIu16ptXZzUwFZp5+3AI1BywAUVXTs1UbXiXBj9V4CXmj9eTnVYON1x887MRsO\rR+aJVO9xVK+jSvXnQ5dmeOIXEwtpkOhGC4ZNU+u3vo5nqTYUu/9x/KX70cZndr5G\rYVsv5HIdh8aozj+WBnkEbkECAwEAAQ==\r-----END PUBLIC KEY-----"
},
"versionId": {
"type": "string",
"example": "80b9761f-166d-4225-809f-d01d02cf5117"
},
"format": {
"type": "string",
"example": "pem"
}
}
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 500,\n \"error_code\": \"ERR_PAYLOAD_ENCRYPTION_ERROR\",\n \"error_message\": \"Error Encountered Generating Public Key.\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 500,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_PAYLOAD_ENCRYPTION_ERROR"
},
"error_message": {
"type": "string",
"example": "Error Encountered Generating Public Key."
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/payload/encryption/health": {
"post": {
"summary": "Encryption Health Check",
"description": "Post a test payload to verify that your current Encryption Keys are working. Interchecks will decrypt and then encrypt the payload you send. There is no backing business logic.",
"operationId": "encryption-health-check",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer Id",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "X-ENCRYPTED",
"in": "header",
"description": "Payer Id",
"schema": {
"type": "string"
}
},
{
"name": "X-AES-MODE",
"in": "header",
"description": "Optional. Accepts GCM_NOPADDING or CBC_PKCS5PADDING",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"RAW_BODY": {
"type": "string",
"description": "The payload you send will be returned with no processing."
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"encryptedText\": \"8Qklz3Ph30pORkQK4m+dZNSnsUyXU54ftrC5fFoWfrn4umDSEEscIJ0kYJBUYkaOoX/3UDexaMmJTanOpgOvU6xz5AI52aFgDo6GkVEXIPkHE4Ne6Fae3ai3JK5PhsSbmh1t7VLXmzshpofARAirorDc4x/+gTXntZFvYTL0jQfbTAYstoSLO3WrUGrg1NhYQR/ageQpaw==\",\n \"key\": \"3f01e22b2099dbb7d0310c6be46d366053721549c4ef4c13a8b495c2abc3b8ef7f5bc92639f47eae5200ddbce952b22113863a6e064ac5e6ac593763112ee4c545b151e5374a24c357ec4fbed4fc1fa117a48b6d509741a38c4eddad4dbf40a953fab72a867995630003d383b340ccd80bda3c01a0210549586b7dd6105d170b903a80a5714a26cc2e20a53a5e9b27665a7c817be632a2b01e4a3618e49365206fb00462b578b4cdbbcc3c5d693d696587734d788feaaffb4f9023290803a9a761396b5c10aa3001658268e128576770aaec42c4994b3b95e2f1b4d12603bf0df7802e378b6c682fc318b510d804ad99e769bdee92c0be114ae85fc35a2517060de660df9a106f2635c4f89a05cfb8fe9f3e612c7ff143e0e8721ee367bb051a7569d5b52e15de37aaf72faaf0668182bb2255fa6f2c732d8daeac26badb4df611ad9ca482608df1bf86c43398509447f0c724755bcd2a8ac5fcf82231950bad7a652d489b7472520e9cebaa0171c7a0369f5817fe78c3cf8c0d470b5a9ce7d30d31da1edcf70860158496b4b56d025b4ee5e6baeb0e2d76f5d673d87bbc69357dfb3f770a0c025ca18712b24c8a6c8e394660b8d4839838394b56225fb95aeebe8010a25d2922af70e9795d81e341267bbe404b81f163f7b3ef617158ba1d228f08dd1ff49238f6ca94bb92d6a2d2b1000a9f12daa24fc1a203d7fb15fc09dc\",\n \"kid\": \"\\\"CK001\\\"\",\n \"ivSpec\": \"0bb3a62faaf7661055697f7225e934f43f36435d59466348b1127be39c35532b23abd921b00c07d03d2e8ae6a9b2dc4fb35fd3addc18b6c92df640ba4805e220eeceffd95c061305a8d1d0047729b1149b4c2a94882d46509833551740df57cd0dde34fe3eb5ecaf1a792123110a57de5932d80c8648f8e9dcc317873a5dc5eaf6ea5e950ce131f9dde8e6762d2aff09e3dcb2ca10d10e065df348e213b6ba4ddc9e943cc730466ed84ad212fb3095dbd382730951658a94c10e99fdf1c5f88ba54d9837c792e7e87e1fb30e42b5eb94e0d27b580e0295941a5d68b744b7a405ba3de3426af6248ca4999e10e3bdd43f6365dffc83f520fe281d91e39200e088b982d3b0c58f50e46766b9666955c249c35a8761053eebe7440b87ea3c036e5eccb321b34efd35cac9760f66eb6f4107395f52b12d8efe48d801eb8934ff6e881eb634b21fb2c7b7ca1267b8c60bc07aff8ae2135da2be8a8c12b6ed3a1054105898240eb121d993eb7e167860a32b4db312765a918c26b079d97163008939a38acc7c71c911c82c3e73c2642811892e7d06a0ffcf790e0a7759ee4e100e8ab967e4590bf6a758f3aebf648c723b4169e2970b1d813d9afa330ec0c3a1c3d88714169e987d2bebbfc0a0327bb65390b30279fed28dc98d480b677d46c029b6269607663801e6a35f6aacc8879ad57f8a543b6356f39f9ffc1ceb6746d24eded2\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"encryptedText": {
"type": "string",
"example": "8Qklz3Ph30pORkQK4m+dZNSnsUyXU54ftrC5fFoWfrn4umDSEEscIJ0kYJBUYkaOoX/3UDexaMmJTanOpgOvU6xz5AI52aFgDo6GkVEXIPkHE4Ne6Fae3ai3JK5PhsSbmh1t7VLXmzshpofARAirorDc4x/+gTXntZFvYTL0jQfbTAYstoSLO3WrUGrg1NhYQR/ageQpaw=="
},
"key": {
"type": "string",
"example": "3f01e22b2099dbb7d0310c6be46d366053721549c4ef4c13a8b495c2abc3b8ef7f5bc92639f47eae5200ddbce952b22113863a6e064ac5e6ac593763112ee4c545b151e5374a24c357ec4fbed4fc1fa117a48b6d509741a38c4eddad4dbf40a953fab72a867995630003d383b340ccd80bda3c01a0210549586b7dd6105d170b903a80a5714a26cc2e20a53a5e9b27665a7c817be632a2b01e4a3618e49365206fb00462b578b4cdbbcc3c5d693d696587734d788feaaffb4f9023290803a9a761396b5c10aa3001658268e128576770aaec42c4994b3b95e2f1b4d12603bf0df7802e378b6c682fc318b510d804ad99e769bdee92c0be114ae85fc35a2517060de660df9a106f2635c4f89a05cfb8fe9f3e612c7ff143e0e8721ee367bb051a7569d5b52e15de37aaf72faaf0668182bb2255fa6f2c732d8daeac26badb4df611ad9ca482608df1bf86c43398509447f0c724755bcd2a8ac5fcf82231950bad7a652d489b7472520e9cebaa0171c7a0369f5817fe78c3cf8c0d470b5a9ce7d30d31da1edcf70860158496b4b56d025b4ee5e6baeb0e2d76f5d673d87bbc69357dfb3f770a0c025ca18712b24c8a6c8e394660b8d4839838394b56225fb95aeebe8010a25d2922af70e9795d81e341267bbe404b81f163f7b3ef617158ba1d228f08dd1ff49238f6ca94bb92d6a2d2b1000a9f12daa24fc1a203d7fb15fc09dc"
},
"kid": {
"type": "string",
"example": "\"CK001\""
},
"ivSpec": {
"type": "string",
"example": "0bb3a62faaf7661055697f7225e934f43f36435d59466348b1127be39c35532b23abd921b00c07d03d2e8ae6a9b2dc4fb35fd3addc18b6c92df640ba4805e220eeceffd95c061305a8d1d0047729b1149b4c2a94882d46509833551740df57cd0dde34fe3eb5ecaf1a792123110a57de5932d80c8648f8e9dcc317873a5dc5eaf6ea5e950ce131f9dde8e6762d2aff09e3dcb2ca10d10e065df348e213b6ba4ddc9e943cc730466ed84ad212fb3095dbd382730951658a94c10e99fdf1c5f88ba54d9837c792e7e87e1fb30e42b5eb94e0d27b580e0295941a5d68b744b7a405ba3de3426af6248ca4999e10e3bdd43f6365dffc83f520fe281d91e39200e088b982d3b0c58f50e46766b9666955c249c35a8761053eebe7440b87ea3c036e5eccb321b34efd35cac9760f66eb6f4107395f52b12d8efe48d801eb8934ff6e881eb634b21fb2c7b7ca1267b8c60bc07aff8ae2135da2be8a8c12b6ed3a1054105898240eb121d993eb7e167860a32b4db312765a918c26b079d97163008939a38acc7c71c911c82c3e73c2642811892e7d06a0ffcf790e0a7759ee4e100e8ab967e4590bf6a758f3aebf648c723b4169e2970b1d813d9afa330ec0c3a1c3d88714169e987d2bebbfc0a0327bb65390b30279fed28dc98d480b677d46c029b6269607663801e6a35f6aacc8879ad57f8a543b6356f39f9ffc1ceb6746d24eded2"
}
}
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"examples": {
"Internal Server Error - Format": {
"value": "{\n \"http_status\": 422,\n \"error_code\": \"ERR_PAYLOAD_ENCRYPTION_ERROR\",\n \"error_message\": \"Error Encountered. Expected: [encryptedText, key, kid, ivSpec].\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 422,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_PAYLOAD_ENCRYPTION_ERROR"
},
"error_message": {
"type": "string",
"example": "Error Encountered. Expected: [encryptedText, key, kid, ivSpec]."
}
}
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"examples": {
"Internal Server Error - Decryption": {
"value": "{\n \"http_status\": 500,\n \"error_code\": \"ERR_PAYLOAD_ENCRYPTION_ERROR\",\n \"error_message\": \"Error Encountered While Decrypting Payload.\"\n}"
},
"Internal Server Error - Encryption": {
"value": "{\n \"http_status\": 500,\n \"error_code\": \"ERR_PAYLOAD_ENCRYPTION_ERROR\",\n \"error_message\": \"Error Encountered While Encrypting Payload.\"\n}"
}
},
"schema": {
"oneOf": [
{
"title": "Internal Server Error - Decryption",
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 500,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_PAYLOAD_ENCRYPTION_ERROR"
},
"error_message": {
"type": "string",
"example": "Error Encountered While Decrypting Payload."
}
}
},
{
"title": "Internal Server Error - Encryption",
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 500,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_PAYLOAD_ENCRYPTION_ERROR"
},
"error_message": {
"type": "string",
"example": "Error Encountered While Encrypting Payload."
}
}
}
]
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/test-harness/accounts/plaid": {
"post": {
"summary": "Create Account with Plaid Link",
"description": "",
"operationId": "create-account-plaid",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"widget_id": {
"type": "string",
"description": "Widget ID"
},
"webhook_url": {
"type": "string",
"description": "Webhook URL (optional) - Webhook subscription URL will be overridden with provided value"
}
}
},
"examples": {
"Request Example": {
"value": {
"widget_id": "UTsZZ3DE_eTSWCUv7QFi7i5w=="
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"account_id\": \"RPA-sws6LZyJQs2_mvJz0QIeMQ==\",\n \"description\": \"CHECKING 1924\",\n \"created_date\": \"2024-07-23T12:19:59.178Z\",\n \"account_name\": \"SHERLOCK HOLMES\",\n \"account_number\": \"7022381924\",\n \"account_type\": \"CHECKING\",\n \"bank_name\": \"CITIZENS BANK NA\",\n \"routing_number\": \"011401533\",\n \"rtp_status\": \"ENABLED\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"example": "RPA-sws6LZyJQs2_mvJz0QIeMQ=="
},
"description": {
"type": "string",
"example": "CHECKING 1924"
},
"created_date": {
"type": "string",
"example": "2024-07-23T12:19:59.178Z"
},
"account_name": {
"type": "string",
"example": "SHERLOCK HOLMES"
},
"account_number": {
"type": "string",
"example": "7022381924"
},
"account_type": {
"type": "string",
"example": "CHECKING"
},
"bank_name": {
"type": "string",
"example": "CITIZENS BANK NA"
},
"routing_number": {
"type": "string",
"example": "011401533"
},
"rtp_status": {
"type": "string",
"example": "ENABLED"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/test-harness/accounts": {
"post": {
"summary": "Update Account Status",
"description": "",
"operationId": "update-account-status",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"description": "Account ID"
},
"action": {
"type": "string",
"description": "Account action",
"enum": [
"BANK_ACCOUNT_BLOCKED",
"BANK_ACCOUNT_VALIDATION_FAILED",
"PLAID_REAUTH_REQUIRED",
"PLAID_PERMISSION_REVOKED",
"REACTIVATE_BANK_ACCOUNT"
]
},
"webhook_url": {
"type": "string",
"description": "Webhook URL (optional) - Webhook subscription URL will be overridden with provided value"
}
}
},
"examples": {
"Request Example": {
"value": {
"account_id": "RPA-6TX9kE1pS2yCFuj7VnaISA==",
"action": "BANK_ACCOUNT_BLOCKED",
"webhook_url": "http://test.domain.com"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/test-harness/payments": {
"post": {
"summary": "Update Payment Status",
"description": "Update Payment Status. Payment can only be updated if in a non terminal status: PAID, PENDING_KYC, APPROVAL_REQUIRED, PENDING\n\n`200` - Request Succeeded\n`400` - Bad Request, missing or invalid parameters\n`422` - Transaction not updateable",
"operationId": "update-payment-status",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"payment_id": {
"type": "string",
"description": "Payment ID"
},
"status": {
"type": "string",
"description": "Payment Status",
"enum": [
"APPROVAL_REQUIRED",
"PENDING",
"CANCELLED",
"RETURNED",
"PAID"
]
},
"webhook_url": {
"type": "string",
"description": "Webhook URL (optional) - Webhook subscription URL will be overridden with provided value"
}
}
},
"examples": {
"Request Example": {
"value": {
"payment_id": "PMiSYqFhMrQxaqVOsbcs3c0g34",
"status": "CANCELLED",
"webhook_url": "http://test.domain.com"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 422,\n \"error_code\": \"ERR_TH_PAYMENT_STATUS_NOT_UPDATEABLE\",\n \"error_message\": \"Only APPROVAL_REQUIRED, PAID, PENDING, PENDING_KYC payments can be updated\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 422,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_TH_PAYMENT_STATUS_NOT_UPDATEABLE"
},
"error_message": {
"type": "string",
"example": "Only APPROVAL_REQUIRED, PAID, PENDING, PENDING_KYC payments can be updated"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/test-harness/transactions": {
"post": {
"summary": "Update Transaction Status",
"description": "Update Transaction Status. `200` - Request Succeeded`400` - Bad Request, missing or invalid parameters`422` - Transaction not undateable",
"operationId": "update-transaction-status",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"transaction_id": {
"type": "string",
"description": "Transaction ID"
},
"status": {
"type": "string",
"description": "Transaction Status",
"enum": [
""
]
},
"webhook_url": {
"type": "string",
"description": "Webhook URL (optional) - Webhook subscription URL will be overridden with provided value"
},
"ach_return_code": {
"type": "string",
"description": "ACH Return Code value (R01, R03, etc) to trigger ACH workflows (optional) when updating the status to FAILED"
}
}
},
"examples": {
"Request Example": {
"value": {
"transaction_id": "ICTN-652-22277-65670-GZH",
"status": "FAILED",
"webhook_url": "http://test.domain.com"
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{}"
}
},
"schema": {
"type": "object",
"properties": {}
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 422,\n \"error_code\": \"ERR_TH_TRANSACTION_STATUS_NOT_UPDATEABLE\",\n \"error_message\": \"Only PAID, PENDING_KYC, PROCESSING, UNKNOWN transactions can be updated\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 422,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_TH_TRANSACTION_STATUS_NOT_UPDATEABLE"
},
"error_message": {
"type": "string",
"example": "Only PAID, PENDING_KYC, PROCESSING, UNKNOWN transactions can be updated"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/widgets/accounts/bank": {
"post": {
"summary": "Create Bank Widget",
"description": "Create a Widget URL to add a Bank Account using Plaid Link.
View the [About Widgets](ref:about-widgets) page to learn about optional `widget_params`.
`201` - Created
`400` - Bad Request, missing or invalid parameters.\n\nUpon completion of bank account link, Interchecks will utilize the `redirect_url` parameter in the `widget_params` to redirect control back to the client's browser. The completion page should provide the appropriate messaging to the user to indicate next steps or action required.",
"operationId": "create-bank-widget",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"description": "Recipient ID"
},
"account_id": {
"type": "string",
"description": "Required if the bank account requires a re-authorization process with Plaid Link",
"default": "optional"
},
"mobile_device": {
"type": "boolean",
"description": "Indicate mobile device to render appropriate UI",
"default": false
},
"link_provider": {
"type": "string",
"description": "Determines the link workflow",
"default": "INTERCHECKS",
"enum": [
"PLAID",
"INTERCHECKS"
]
}
}
},
"examples": {
"Bank Widget for new Account": {
"value": {
"recipient_id": "REejizS5fnTLiQYhGTKYXZaQ==",
"mobile_device": true,
"link_provider": "PLAID"
}
},
"Bank Widget for Account re-auth": {
"value": {
"recipient_id": "REejizS5fnTLiQYhGTKYXZaQ==",
"account_id": "RPAes4gfds5ygQYhsadf33==",
"mobile_device": true,
"link_provider": "PLAID"
}
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"widget_id\": \"UTnFBl7AW8QD64HVcwn5H_VA==\",\n \"widget_url\": \"https://domain-to-provider-link.com\",\n \"expiration\": \"2022-11-02T22:44:14.481Z\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"widget_id": {
"type": "string",
"example": "UTnFBl7AW8QD64HVcwn5H_VA=="
},
"widget_url": {
"type": "string",
"example": "https://domain-to-provider-link.com"
},
"expiration": {
"type": "string",
"example": "2022-11-02T22:44:14.481Z"
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Bad Request - invalid Recipient ID": {
"value": "{\n \"http_status\": 400,\n \"error_code\": \"ERR_INVALID_RECIPIENT_ID\",\n \"error_message\": \"Invalid recipient ID\"\n}"
},
"Bad Request - invalid Account ID": {
"value": "{\n \"http_status\": 400,\n \"error_code\": \"ERR_INVALID_ACCOUNT_ID\",\n \"error_message\": \"Invalid account ID\"\n}"
}
},
"schema": {
"oneOf": [
{
"title": "Bad Request - invalid Recipient ID",
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 400,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_RECIPIENT_ID"
},
"error_message": {
"type": "string",
"example": "Invalid recipient ID"
}
}
},
{
"title": "Bad Request - invalid Account ID",
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 400,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_ACCOUNT_ID"
},
"error_message": {
"type": "string",
"example": "Invalid account ID"
}
}
}
]
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/widgets/accounts/card": {
"post": {
"summary": "Create Card Widget",
"description": "Create a Widget URL to add a Debit Card. View the [About Widgets](ref:about-widgets) page to learn about optional `widget_params`.`201` - Created`400` - Bad Request, missing or invalid parameters",
"operationId": "create-card-widget",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"description": "Recipient ID"
}
}
},
"examples": {
"Card Widget": {
"value": {
"recipient_id": "REejizS5fnTLiQYhGTKYXZaQ=="
}
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"widget_id\": \"UTnFBl7AW8QD64HVcwn5H_VA==\",\n \"widget_url\": \"{{environment-url}}/widget-v2/{{payer_id}}/UTnFBl7AW8QD64HVcwn5H_VA==\",\n \"expiration\": \"2022-11-02T22:44:14.481Z\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"widget_id": {
"type": "string",
"example": "UTnFBl7AW8QD64HVcwn5H_VA=="
},
"widget_url": {
"type": "string",
"example": "{{environment-url}}/widget-v2/{{payer_id}}/UTnFBl7AW8QD64HVcwn5H_VA=="
},
"expiration": {
"type": "string",
"example": "2022-11-02T22:44:14.481Z"
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 400,\n \"error_code\": \"ERR_INVALID_RECIPIENT_ID\",\n \"error_message\": \"Invalid recipient ID\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 400,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_RECIPIENT_ID"
},
"error_message": {
"type": "string",
"example": "Invalid recipient ID"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/widgets/payments": {
"post": {
"summary": "Create Payment Widget",
"description": "Create a Widget URL for a Recipient to accept Payment. View the [About Widgets](ref:about-widgets) page to learn about optional `widget_params`.`201` - Created`400` - Bad Request, missing or invalid parameters`422` - Payment not in a `PENDING` status",
"operationId": "create-payment-widget",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"description": "Recipient ID"
},
"payment_id": {
"type": "string",
"description": "Payment ID"
}
}
},
"examples": {
"Card Widget": {
"value": {
"recipient_id": "REejizS5fnTLiQYhGTKYXZaQ==",
"payment_id": "PM5duKcOBzSGmWxQoUDQinhQ=="
}
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"widget_id\": \"UTnFBl7AW8QD64HVcwn5H_VB==\",\n \"widget_url\": \"{{environment-url}}/widget-v2/{{payer_id}}/UTnFBl7AW8QD64HVcwn5H_VB==\",\n \"expiration\": \"2022-11-02T22:44:14.481Z\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"widget_id": {
"type": "string",
"example": "UTnFBl7AW8QD64HVcwn5H_VB=="
},
"widget_url": {
"type": "string",
"example": "{{environment-url}}/widget-v2/{{payer_id}}/UTnFBl7AW8QD64HVcwn5H_VB=="
},
"expiration": {
"type": "string",
"example": "2022-11-02T22:44:14.481Z"
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 400,\n \"error_code\": \"ERR_INVALID_RECIPIENT_ID\",\n \"error_message\": \"Invalid recipient ID\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 400,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_RECIPIENT_ID"
},
"error_message": {
"type": "string",
"example": "Invalid recipient ID"
}
}
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 422,\n \"error_code\": \"ERR_PAYMENT_NOT_VALID_FOR_WIDGET\",\n \"error_message\": \"Payment already processed\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 422,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_PAYMENT_NOT_VALID_FOR_WIDGET"
},
"error_message": {
"type": "string",
"example": "Payment already processed"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/widgets/accounts/prepaid": {
"post": {
"summary": "Create Prepaid Dashboard Widget",
"description": "Create a Widget URL for a Recipient view and manage their Prepaid Card account. View the [About Widgets](ref:about-widgets) page to learn about optional `widget_params`.`201` - Created`400` - Bad Request, missing or invalid parameters",
"operationId": "create-prepaid-dashboard-widget",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"recipient_id": {
"type": "string",
"description": "Recipient ID"
},
"account_id": {
"type": "string",
"description": "Account ID"
}
}
},
"examples": {
"Card Widget": {
"value": {
"recipient_id": "REejizS5fnTLiQYhGTKYXZaQ==",
"account_id": "RPA-7tbtEUw_TYKdOc3UY4EyGQ=="
}
}
}
}
}
},
"responses": {
"201": {
"description": "201",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"widget_id\": \"UTnFBl7AW8QD64HVcwn5H_VC==\",\n \"widget_url\": \"{{environment-url}}/widget-v2/{{payer_id}}/UTnFBl7AW8QD64HVcwn5H_VC==\",\n \"expiration\": \"2022-11-02T22:44:14.481Z\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"widget_id": {
"type": "string",
"example": "UTnFBl7AW8QD64HVcwn5H_VC=="
},
"widget_url": {
"type": "string",
"example": "{{environment-url}}/widget-v2/{{payer_id}}/UTnFBl7AW8QD64HVcwn5H_VC=="
},
"expiration": {
"type": "string",
"example": "2022-11-02T22:44:14.481Z"
}
}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"http_status\": 404,\n \"error_code\": \"ERR_INVALID_ACCOUNT_ID\",\n \"error_message\": \"Invalid account ID\"\n}"
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 404,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_INVALID_ACCOUNT_ID"
},
"error_message": {
"type": "string",
"example": "Invalid account ID"
}
}
}
}
}
}
},
"deprecated": false
}
},
"/api/v2/{payer_id}/accounts/{recipient_id}/banks/plaid-processor-token": {
"post": {
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
},
"examples": {
"Created": {
"summary": "Created",
"value": {
"account_id": "RPA-L2NW6S4ASIeaKqeP4JmocA==",
"description": "CHECKING 1****6789",
"created_date": "2021-11-09T13:52:55.330Z",
"account_name": "Sherlock Holmes",
"account_number": "123456789",
"account_type": "CHECKING",
"bank_name": "BANCO POPULAR",
"routing_number": "021502011",
"rtp_status": "DISABLED"
}
}
}
}
},
"description": "Created"
},
"422": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
},
"examples": {
"Unprocessable Entity": {
"summary": "Unprocessable Entity",
"value": {
"http_status": 422,
"error_code": "ERR_ACCOUNT_LIMIT_EXCEEDED",
"error_message": "Activity Limit Exceeded"
}
}
}
}
},
"description": "Unprocessable Entity"
}
},
"parameters": [
{
"in": "path",
"name": "payer_id",
"schema": {
"type": "string",
"default": ""
},
"required": true,
"description": "Payer ID"
},
{
"in": "path",
"name": "recipient_id",
"schema": {
"type": "string"
},
"required": true,
"description": "Recipient ID"
}
],
"summary": "Add Bank Account",
"operationId": "post_api-v2-payer-id-accounts-recipient-id-banks-plaid-processor-token",
"description": "Add a Plaid Linked Bank Account using a Plaid Processor Token.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"processor_token": {
"type": "string",
"description": "Plaid processor token"
}
},
"required": [
"processor_token"
]
}
}
}
}
}
},
"/api/v2/{payer_id}/accounts/{recipient_id}/banks/plaid-processor-token/{account_id}/status": {
"patch": {
"responses": {
"204": {
"description": ""
}
},
"parameters": [
{
"in": "path",
"name": "payer_id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "recipient_id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "account_id",
"schema": {
"type": "string"
},
"required": true
}
],
"summary": "Update Bank Account Status",
"description": "Update Plaid linked account status",
"operationId": "patch_api-v2-payer-id-accounts-recipient-id-banks-plaid-processor-token-account-id-status",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"event": {
"type": "string",
"enum": [
"ITEM_LOGIN_REQUIRED",
"PENDING_DISCONNECT",
"USER_ACCOUNT_REVOKED",
"PENDING_EXPIRATION",
"USER_PERMISSION_REVOKED",
"ITEM_NOT_SUPPORTED",
"LOGIN_REPAIRED"
],
"description": "Plaid status event"
}
},
"required": [
"event"
]
}
}
}
}
}
},
"/api/v2/{payer_id}/reports/bank-transactions": {
"get": {
"summary": "Get Bank Transactions Report",
"description": "",
"operationId": "get-ach-settlement-report-1",
"parameters": [
{
"name": "payer_id",
"in": "path",
"description": "Payer ID",
"schema": {
"type": "string"
},
"required": true
},
{
"name": "reportDate",
"in": "query",
"description": "Format of date should be yyyy-mm-dd",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "query",
"name": "lastFour",
"schema": {
"type": "number"
},
"required": true,
"description": "Last four of bank account number"
}
],
"responses": {
"200": {
"description": "200",
"content": {
"text/plain": {
"examples": {
"Result": {
"value": "\"Account Name\",\"Transaction ID\",Type,Amount,\"Virtual Balance\",IMAD,OMAD,\"ACH Trace\",\"Counterparty Name\",\"Created Date\",\"Approved By\",\"Approved Date\",Source,Completed,Status,\"Company Id\",\"Company Name\",\"Company Entry Description\",\"ACH Reversal\",\"ACH Return\",\"Client Reference ID\",\"Error Code\",\"Error Description\""
}
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"examples": {
"Result": {
"value": ""
}
},
"schema": {
"type": "object",
"properties": {
"http_status": {
"type": "integer",
"example": 404,
"default": 0
},
"error_code": {
"type": "string",
"example": "ERR_SETTLEMENT_REPORT"
},
"error_message": {
"type": "string",
"example": "No report found"
}
}
}
}
}
}
}
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": false,
"proxy-enabled": true
},
"x-readme-fauxas": true
}