Skip to main content
POST
/
aba-checks
Upload a single ABA file
curl --request POST \
  --url https://app.ezyshield.com.au/api/aba-checks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "status": "<string>",
      "description": "<string>",
      "aba_date": "<string>",
      "original_file_name": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    },
    "relationships": {
      "entries": {
        "data": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "account_name": "<string>",
        "bsb": "<string>",
        "account_number": "<string>",
        "amount": "<string>",
        "lodgement_reference": "<string>",
        "result": "<string>",
        "passed": "<string>"
      },
      "relationships": {
        "verification": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
include
enum<string>[]
Available options:
entries,
entries.verification
​
fields[aba-checks]
enum<string>[]
Available options:
status,
description,
aba_date,
original_file_name,
created_at,
updated_at
​
fields[aba-check-entries]
enum<string>[]
Available options:
account_name,
bsb,
account_number,
amount,
lodgement_reference,
result,
passed
​
fields[verifications]
enum<string>[]
Available options:
status,
individual_confirmation_mode,
send_individual_confirmation_sms,
send_individual_confirmation_email,
accept_close_match,
attribution_id,
individual_confirmation_url,
failure_reason,
check_results,
created_at,
updated_at

Body

multipart/form-data
​
file
file
required

ABA file to upload and match against verifications. Must be a valid ABA file up to 10MB.

Maximum string length: 10240

Response

AbaCheckResource

​
data
AbaCheckResource · object
required
​
included
(AbaCheckEntryResource · object | VerificationResource · object)[]