For the complete documentation index, see llms.txt. This page is also available as Markdown.

Dispatch Input Reference

Your AA service sends API transaction details to SNA by calling the snalib sna.dispatch() method at each integration point. snalib sends these details to the SNA agent running in your infrastructure.

SNA API: POST /sna/v1/aa snalib method: sna.dispatch()

The same method and input structure are used on both the AA-FIP and AA-FIU interfaces.

Input Fields

Key
Type
Required
Description

callType

string

Yes

Type of transaction call. See Call Types.

route

string

Yes

ReBIT API endpoint route, e.g. /FI/request

peerId

string

Yes

Entity ID of the peer: the FIP on the AA-FIP interface, the FIU on the AA-FIU interface

peerType

string

Yes

Entity type of the peer: FIP or FIU

txnCorId

string

Yes

UUID correlating a request with its response. The request and its response must carry the same value.

customerId

string

No

Customer ID related to the transaction

httpStatus

integer

Responses only

HTTP status code of the response. Applies only to responseIn and responseOut.

addlAttr

json

Yes (at least eventTime)

Additional attributes. See Additional Attributes (addlAttr).

body

json

Yes

The actual request or response body. The encryptedFI field may be redacted; see below.

Call Types

callType
Meaning
AA-FIP point
AA-FIU point

requestOut

AA sends a request to the peer

A

E

responseIn

AA receives the peer's response

B

F

requestIn

AA receives a request from the peer

C

G

responseOut

AA sends its response to the peer

D

H

For every requestOut, call sna.dispatch() with a matching responseIn carrying the same txnCorId, including when the call fails, times out, or the connection drops. For every requestIn, call sna.dispatch() with a matching responseOut.

Additional Attributes Summary

Attribute
Required
Applies to

eventTime

Yes

All calls, both interfaces

consentTypes

Yes

FI/request (AA-FIU); AA-FIP for future use

cnsCorId

Optional

Consent APIs, both interfaces (for future use)

fiuCnsId

Optional

Consent APIs on the AA-FIP interface (for future use)

ssnCorId

Optional

Data-fetch APIs, both interfaces (for future use)

fiuSsnId

Optional

Data-fetch APIs on the AA-FIP interface (for future use)

fiFetchEncDataLen

Conditional

FI/fetch responses, when encryptedFI is redacted

For full details of each attribute, see Additional Attributes (addlAttr).

Redacting encryptedFI

If you prefer not to share the encrypted FI payload with SNA, you can redact or mask the encryptedFI field in FI/fetch responses. Continue to send the rest of the body, and add the length of the original encryptedFI string as fiFetchEncDataLen in addlAttr.

Example: FI/request received from an FIU (Point G)

All values below are synthetic and for illustration only.

Example: Response sent to the FIU (Point H)

Last updated

Was this helpful?