Skip to main content

Check Transactions

Overview​

You can create CHECK transactions via POST /v1/customer/id/{placeholder}/transaction.
The examples below demonstrate common collect and send scenarios.

Resource Access​

Production (api.ahrvo.network)

POST https://api.ahrvo.network/banking/us2/v1/customer/id/{customerId}/transaction

Staging (gateway.ahrvo.network)

POST https://gateway.ahrvo.network/banking/us2/v1/customer/id/{customerId}/transaction
Scenarios Covered

• Collect — third-party → Ahrvo (images)
• Collect — third-party → Ahrvo (images, isEndorsed)
• Send — Ahrvo → third-party (pre-existing address)
• Send — Ahrvo → Contact
• Send — Ahrvo → third-party (external check transaction)

Collect — Third-Party → Ahrvo (images)​

POST /banking/us2/v1/customer/id/{placeholder}/transaction
Host: <hostname>
Authorization: Bearer <JWT token>
x-api-key: {apiKey}
Content-Type: application/json
{
  "amount": "200.00",
  "linkedDocument": [
    {
      "purpose": "CHECK_DEPOSIT",
      "document": {
        "type": "CHECK_IMAGE_FRONT",
        "base64encodedContent": "/9j/4AAQSkZJRgABAQAAAQABAAD//=",
        "name": "BusinessCheckwithAmount200.jpg"
      }
    },
    {
      "purpose": "CHECK_DEPOSIT",
      "document": {
        "type": "CHECK_IMAGE_BACK",
        "base64encodedContent": "/9j/4AAQSkZJRgABAQAAAQABAAD//=",
        "name": "CorrectImageBack.jpg"
      }
    }
  ],
  "method": "CHECK",
  "processingDetail": {
    "onUs": "1498238/",
    "auxiliaryOnUs": "<000012537<",
    "location": { "id": 2601 }
  },
  "purpose": "Mobile check with user input - FTNI response matched",
  "destination": {
    "account": { "id": "4004695" }
  },
  "scheduleDate": "03/24/2023",
  "type": "Regular"
}

Collect — Third-Party → Ahrvo (images, isEndorsed true)​

POST /banking/us2/v1/customer/id/{placeholder}/transaction
Host: <hostname>
Authorization: Bearer <JWT token>
x-api-key: {apiKey}
Content-Type: application/json
{
  "amount": "200.00",
  "linkedDocument": [
    {
      "purpose": "CHECK_DEPOSIT",
      "document": {
        "type": "CHECK_IMAGE_FRONT",
        "base64encodedContent": "/9j/4AAQSkZJRgABAQAAAQABAAD//=",
        "name": "BusinessCheckwithAmount200.jpg"
      }
    },
    {
      "purpose": "CHECK_DEPOSIT",
      "document": {
        "type": "CHECK_IMAGE_BACK",
        "base64encodedContent": "/9j/4AAQSkZJRgABAQAAAQABAAD//=",
        "name": "CorrectImageBack.jpg"
      }
    }
  ],
  "method": "CHECK",
  "processingDetail": {
    "onUs": "1498238/",
    "auxiliaryOnUs": "<000012537<",
    "routingNumber": "123456780",
    "isEndorsed": true,
    "location": { "id": 2601 },
    "checkType": "BUSINESS_CHECK",
    "accountNumber": "1498238",
    "checkNumber": "573492"
  },
  "purpose": "Mobile check with user input - FTNI response matched",
  "destination": {
    "account": { "id": "4004695" }
  },
  "scheduleDate": "03/24/2023",
  "type": "Regular"
}

Send — Ahrvo → Third-Party (pre-existing address)​

POST /banking/us2/v1/customer/id/{placeholder}/transaction
Host: <hostname>
Authorization: Bearer <JWT token>
x-api-key: {apiKey}
Content-Type: application/json
{
  "method": "CHECK",
  "amount": "101",
  "type": "REGULAR",
  "purpose": "Services",
  "source": {
    "account": { "id": 4007295 },
    "payorAddress": { "id": 1035110 }
  },
  "destination": {
    "address": { "id": "1035110" }
  },
  "processingDetail": {
    "deliveryMode": "OVERNIGHT",
    "remittanceInfo": [
      {
        "Date": "asd",
        "Invoice Number": "sdf",
        "Amount": "sdf",
        "order": "sdf",
        "distance": "eew",
        "time": "er",
        "speed": "",
        "present": "",
        "future": "",
        "past": ""
      }
    ]
  },
  "allowDuplicate": "false"
}

Send — Ahrvo → Contact​

POST /banking/us2/v1/customer/id/{placeholder}/transaction
Host: <hostname>
Authorization: Bearer <JWT token>
x-api-key: {apiKey}
Content-Type: application/json
{
  "method": "CHECK",
  "type": "REGULAR",
  "amount": "31",
  "allowDuplicate": "true",
  "purpose": "services",
  "source": {
    "account": { "id": 4010863 }
  },
  "destination": {
    "contact": {
      "id": 4012964,
      "mailingAddress": { "id": 1048888 }
    }
  },
  "processingDetail": {
    "deliveryMode": "STANDARD",
    "memo": "Check to Herzogg"
  }
}

Send — Ahrvo → Third-Party (external check transaction)​

POST /banking/us2/v1/customer/id/{placeholder}/transaction
Host: <hostname>
Authorization: Bearer <JWT token>
x-api-key: {apiKey}
Content-Type: application/json
{
  "amount": "100",
  "allowDuplicate": "true",
  "method": "CHECK",
  "purpose": "ICLDebitAutoMatch",
  "destination": {
    "address": { "id": "1209279" },
    "payeeName": "Jane Smith"
  },
  "source": {
    "account": { "id": "4035159" }
  },
  "type": "EXTERNAL",
  "processingDetail": {
    "memo": "Test Payee Name1"
  }
}

OpenAPI Specification​