ASA Webhooks

User Guide
Version 1.0 ● 20 April 2023

ASA Technologies Inc. – [email protected] - ASA.Financial

© 2023 ASA Technologies or an ASA Technologies affiliate company. All rights reserved.

ASA.Financial

Trademarks

Login with ASA are registered trademarks of ASA Financial. All other trademarks or registered
trademarks are the property of their respective owners.

Disclaimer

The information provided in this document is provided "as is" without warranty of any kind. ASA
Technologies disclaims all warranties, either express or implied, including the warranties of
merchantability and fitness for a particular purpose. In no event shall ASA Technologies be liable for
any damages whatsoever including direct, indirect, incidental, consequential, loss of business profits
or special damages, even if ASA Technologies or its suppliers have been advised of the possibility of
such damages.

Document Lifetime

ASA Technologies may occasionally update online documentation between releases of the related
software. Consequently, if this document was not downloaded recently, it may not contain the most
up-to-date information. Please refer to ASA.Financial for the most current information.

From the Web site, you may also download and refresh this document if it has been updated, as
indicated by a change in this date: April 20, 2023.

Where to get help

ASA Technologies support, product, and licensing information can be obtained as follows.

Product information — Documentation, release notes, software updates, and information about ASA
Technologies products, licensing, and service, are at ASA Technologies website at:

ASA.Financial

Technical support — Go to ASA.Financial and select Support, or email [email protected].

Note: Please provide your company or entity name when you create the support request
ASA Technologies ASA Webhooks Version 1.0

Contents
1 INTRODUCTION ............................................................................................................................................. 4

1.1 WEBHOOKS OVERVIEW ......................................................................................................................................4

1.2 WEBHOOKS CONFIGURATION ..............................................................................................................................4

2 WEBHOOK ENDPOINT DEFINITION ................................................................................................................ 5

2.1 CONSUMER AUTHORIZATION NOTIFICATION ...........................................................................................................5

2.1.1 Fintech Requirements ..............................................................................................................................5
2.1.2 Post to Fintech URL ..................................................................................................................................5
2.1.3 Example ...................................................................................................................................................5
2.2 NEW TRANSACTIONS AVAILABLE (GET TRANSACTIONS) .............................................................................................5
2.2.1 Fintech Requirements ..............................................................................................................................6
2.2.2 Post to Fintech URL ..................................................................................................................................6
2.2.3 Example ...................................................................................................................................................7

3 APPENDIX B: DOCUMENT CHANGELOG ......................................................................................................... 9

© ASA Technologies 2022. All rights reserved. Page 3 of 9

ASA Technologies ASA Open API Version 0.6

1 Introduction
ASA is a secure and reliable Digital Services Network that connects with the banks in the United
States to allow FinTech (Financial Technology companies that use Consumers’ information) to
access the consumers data. The consumer (Account Holder) authenticates the ASA Vault app
with their Bank data and chooses which data to share with a FinTech. This makes the consumers
data accessible to a FinTech. This is a credible service-providing network that places the
consumer in control of the extent of accessibility of his/her data. It also provides information to
the banks regarding FinTech’s chosen by consumer through the ASA Vault App.
This is an extension to the ASA Open API documentation to aid the Fintech that requires
consumer permissioned data shared with the FinTech. Webhooks automate a push service that
notifies the Fintech of events they would like to be aware of without the need to make API requests
continuously to the ASA Platform.

1.1 Webhooks Overview

ASA provides webhooks that send consumer information and data from ASA Financial when it is
available on ASA Financial platform. The solution is based on events and is automated once
configured.
Asa Financial provides following webhooks to which FinTech’s can subscribe for details:

• Consumer Authorization Notification: Fintech will be notified by email and by webhook

when a consumer grants access to their data.
• New Transactions Available: Fintech will be notified by email when there are new
transactions available for a Consumer that has granted access to the Fintech. The Fintech
will be sent new transactions throughout the day via webhooks, based on when they are
processed by the Financial Institution.

1.2 Webhooks Configuration

The Fintech will need to provide the following information to ASA Financial to complete the
Webhooks configuration:

• Webhook URL to receive data from ASA

• Email account used to send notifications related to Webhooks
• RetryCount: Number of attempts to make a request to the Fintech Webhook URL. ASA
will make multiple attempts until successful, up to when the system exceeds the
RetryCount
• PageSize: Pagination defines how many records will be sent in single request and is
defined using the PageSize value. This allows the Fintech and ASA to compensate for
large transaction datasets.

© ASA Technologies 2023. All rights reserved. Page 4 of 9

ASA Technologies ASA Webhooks Version 1.0

2 Webhook Endpoint Definition

Webhooks are extensions and work with the ASA OpenAPI. The difference is that ASA is pushing
the data to the Fintech using Webhooks rather than the Fintech pulling data using the Open API.
See the latest version of OpenAPI available at Swagger Hub:
https://app.swaggerhub.com/apis/ASA-Financial/ASAOpenAPI/

2.1 Consumer Authorization Notification

This webhook notifies a Fintech when a consumer has granted access to their information. This
can be used to determine Consumers that have initiated the process of sharing information with
a Fintech. It is up to each Fintech to pull the data from the OpenAPI or to configure webhooks to
receive the data.

2.1.1 Fintech Requirements

A Fintech will need to provide two items to utilize this webhook. ASA will need to have the Fintech
URL to send the webhook and the email address for notifications.

2.1.2 Post to Fintech URL

POST <https://<webhook.fintech.com>/AuthorizationNotification> [Link provided by Fintech]
Headers:
Content-Type: application/text
Parameters: None
Body:
{
"subscriptionkey": <Fintech SubscriptionKey>, // This is a placeholder for any authentication key
that fintech requires
"webhookConfigurationsId": long, //ReferenceId for Webhook configuration, Used for
Troubleshooting
"data": "string" // Define the datatype for response object
}
Response:string

2.1.3 Example
{"Subscriptionkey":"temp1","WebhookConfigurationsId":176,"Data":"Consumer with ASA
Consumer Code : 274861085 Registered Successfully."}

2.2 New Transactions Available (get Transactions)

© ASA Technologies 2022. All rights reserved. Page 5 of 9

ASA Technologies ASA Open API Version 0.6

This webhook notifies a Fintech when a consumer has transactions that have processed at their
Financial Institution (FI). This occurs based on timing from the FI regarding how and when they
post transactions. For ASA partner FIs, this is posting of transaction data usually every quarter
hour. ASA is working to reduce this time with each FI and will get as near to real-time as possible
in the future.
It is up to each Fintech to pull the data from the OpenAPI or to configure webhooks to receive the
data. Good practices would be to perform a regular pull of data using the OpenAPI to compare to
the results from Webhooks since there is no guarantee webhooks were received by the Fintech
for each event.

2.2.1 Fintech Requirements

A Fintech will need to provide four items to utilize this webhook. ASA will need to have the Fintech
URL to send the webhook, the email address for notifications, the RetryCount and PageSize. If
any of these required fields are not present, the webhook will not provide the data to a Fintech.

2.2.2 Post to Fintech URL

POST <https://<webhhok.fintech.com>/GetTransactions>
Headers: Content-Type: application/json
Parameters: none
Body:
{
"subscriptionkey": <Fintech SubscriptionKey>, // This is a placeholder for the authentication key
provided to the fintech
"webhookConfigurationsId": long, //ReferenceId for Webhook configuration, Used for
Troubleshooting
"data": "string" // Define the datatype for response object
}
Response: Json Object
{
"ConsumerFiTransactionDetailId": Long // Unique Trnsaction no by ASA
"AccountId": Long, // Unique Account no by ASA
"TransactionId": string, // Unique Transaction Id by FI
"ConsumerName": string, // Customername
"FintechName": string, // FintechName
"ConsumerId": long // unique Consumer no by ASA
"FintechDetailId": long, //unique FinTech no by ASA
"ConsumerFiAccountDetailId": long // Unique Account no by ASA
"TransactionMemo": string , // transaction description

© ASA Technologies 2023. All rights reserved. Page 6 of 9

ASA Technologies ASA Webhooks Version 1.0

"Amount": decimal, // transaction Amount

"CategoryId": string, // Transaction category id
"CategoryName": string, // Transaction categoryname like 'Personal Finance','Real Estate'
"activity_date": string, // transaction Activity date
"activity_datetime": string, // transaction Activity date and time
"effective_date": string, //transaction Effective date
"effective_datetime":tring, //transaction Effective date and time
"transaction_date": string, // transaction Post date and time
"transaction_datetime": string,// transaction Post date
"TransactionStatus": string, // transaction status like "Posted" or "Pending"
"TransactionType": string, // Transaction type "Credit" or "Debit"
"ASAFiCode": long, // Financial Institution Code by ASA
"TransactionTypeCode": string // Transaction type code "D" or "C"
}

2.2.3 Example
{
"TotalRecords": 2,
"consumerTransactionFIDatas": [
{
"ConsumerFiTransactionDetailId": 603773,
"AccountId": 8750,
"TransactionId": "4013-0001-5459-40284-",
"ConsumerName": "WARREN",
"FintechName": "After Pay",
"ConsumerId": 29,
"FintechDetailId": 123,
"ConsumerFiAccountDetailId": 8750,
"TransactionMemo": "DRAFT/SAVE XFER",
"Amount": 2570.01,
"CategoryId": 18,
"CategoryName": "Real Estate",
"activity_date": "2010-04-18",
"activity_datetime": "2010-04-18T00:00:00.0000000",
"effective_date": "2010-04-19",
"effective_datetime": "2010-04-19T00:00:00.0000000",

© ASA Technologies 2022. All rights reserved. Page 7 of 9

ASA Technologies ASA Open API Version 0.6

"transaction_date": "2010-04-18",
"transaction_datetime": "2010-04-18T00:00:00.0000000",
"TransactionStatus": "Posted",
"TransactionType": "Debit",
"ASAFiCode": 123456,
"TransactionTypeCode": "D"
},
{
"ConsumerFiTransactionDetailId": 138540,
"AccountId": 603007,
"TransactionId": "4013-0001-5458-40284-907",
"ConsumerName": "WARREN",
"FintechName": "After Pay",
"ConsumerId": 603007,
"FintechDetailId": 123,
"ConsumerFiAccountDetailId": 603007,
"TransactionMemo": "Deposit Transfer From Share 0020",
"Amount": 2570.01,
"CategoryId": 21,
"CategoryName": "General",
"activity_date": "2010-04-11",
"activity_datetime": "2010-04-11T00:00:00.0000000",
"effective_date": "2010-04-12",
"effective_datetime": "2010-04-12T00:00:00.0000000",
"transaction_date": "2010-04-18",
"transaction_datetime": "2010-04-18T00:00:00.0000000",
"TransactionStatus": "Posted",
"TransactionType": "Credit",
"ASAFiCode": 123456,
"TransactionTypeCode": "D"
},
]
}

© ASA Technologies 2023. All rights reserved. Page 8 of 9

ASA Technologies ASA Webhooks Version 1.0

3 Appendix B: Document changelog

Provide a brief summary of what has changed the since the last time this document was
updated

Term Meaning

V1.0 Initial Release

© ASA Technologies 2022. All rights reserved. Page 9 of 9