Transaction Advice

Transaction Advice is a module that allows you to connect to Autoform. AutoForm is a document management system. Transaction Module provides certain APIs, that a user can use to login, search, and download documents from AutoForm.

Name Description Introduced In
loginAndDownload This API is used to to sign in to AutoForm and download the document file based on the provided input parameters. The input parameters include keys such as customerId, accountId, transactionType, page, transactionRef, and mediaType. 2020.07
loginAndView This API is used to login to AutoForm and download the document file based on the provided input parameters. The downloaded file is returned as response in a base64 encoded string format. The input parameters include keys such as customerId, accountId, transactionType, page, transactionRef, and mediaType. 2020.07
Closed loginAndDownload
 
Description: This API is used to sign in to AutoForm and download the document file based on the provided input parameters. The input parameters include keys such as customerId, accountId, transactionType, page, transactionRef, and mediaType.
Method: GET
URL: /services/data/v1/TransactionAdvice/objects/TransactionAdviceObject?customerId=100335&accountId=98568&transactionRef=FT191070MC9L&mediaType=png&transactionType=Cheque&page=0
Security Level: Public
Header Request: None
Body Request: None
Response: The document file gets downloaded to your system.
Error Code(s):
  • Error Code: 20003
    Error Message: No records were found that matched the selection criteria.
  • Error Code: 20004
    Error Message: Autoform Login Failed.
  • Error Code: 20041
    Error Message: Backend Failed.
  • Error Code: 20001
    Error Message: Invalid Payload.
Associated Enterprise APIs:

TransactionAdviceJson is an integration service and the operations used in the service are login, searchByCUK, and download.
ClosedloginAndView
 
Description: This API is used to to sign in to AutoForm and download the document file based on the provided input parameters. The downloaded file is returned as response in a base64 encoded string format. The input parameters include keys such as customerId, accountId, transactionType, page, transactionRef, and mediaType.
Method: Custom Verb
URL: /services/data/v1/TransactionAdvice/operations/TransactionAdviceObject/getBase64
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

accountID (Mandatory)

Specifies the account number that contains the transaction details.

transactionRef (Mandatory)

Specifies the transaction ID or reference.

mediaType (Mandatory)

Specifies the type of media (PNG or PDF).

transactionType (Mandatory)

Specifies the type of transaction (Cheque, Draft, or ExternalTransfers).

page

Specifies the integer value of the page (front/ back). By default the value of this key is zero.

{
"accountID" : "GB0010001-87122",
"transactionType" : "All",
"offset": 0,
"limit" : 10,
"order" : "desc",
"sortBy": "amount"
}}
Response:

Parameters

base64

Specifies the base64 encoding of the file.
Error Code(s):
  • Error Code: 20003
    Error Message: No records were found that matched the selection criteria.
  • Error Code: 20004
    Error Message: Autoform Login Failed
  • Error Code: 20041
    Error Message: Backend Failed.
  • Error Code: 20003
    Error Message: Invalid Payload.
Associated Enterprise APIs: TransactionAdviceJson is an integration service and the operations used in the service are login, searchByCUK, and download.

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?