1asyncapi: 3.0.0
2info:
3  title: Remittance Service Event Bus Example
4  version: 1.0.0
5  description: |
6    Example AsyncAPI 2.6.0 model for a Remittance Service.
7    A user makes a cross-border transaction request.
8    Events are published to AWS SNS, which pushes them to an SQS queue.
9    Downstream services consume the event from SQS.
10servers:
11  aws:
12    host: '{service}.{region}.amazonaws.com'
13    protocol: https
14    description: AWS endpoints for SNS and SQS.
15    variables:
16      service:
17        enum:
18          - sns
19          - sqs
20        default: sns
21      region:
22        default: us-east-1
23        description: AWS region used for the SNS/SQS resources.
24channels:
25  remittance-transactions-topic:
26    address: sns/remittance-transactions-topic
27    messages:
28      publishRemittanceTransactionToSNS:
29        $ref: '#/components/messages/RemittanceTransactionRequested'
30    description: SNS topic for remittance transaction events.
31  remittance-transactions-queue:
32    address: sqs/remittance-transactions-queue
33    messages:
34      consumeRemittanceTransactionFromSQS:
35        $ref: '#/components/messages/RemittanceTransactionRequested'
36    description: SQS queue that receives messages forwarded from SNS topic via
37      subscription.
38operations:
39  publishRemittanceTransactionToSNS:
40    action: receive
41    channel:
42      $ref: '#/channels/remittance-transactions-topic'
43    summary: Publish RemittanceTransactionRequested event to SNS topic
44    messages:
45      - $ref: '#/channels/remittance-transactions-topic/messages/publishRemittanceTransactionToSNS'
46  consumeRemittanceTransactionFromSQS:
47    action: send
48    channel:
49      $ref: '#/channels/remittance-transactions-queue'
50    summary: >-
51      Consumer service polls SQS to consume RemittanceTransactionRequested
52      events.
53    messages:
54      - $ref: '#/channels/remittance-transactions-queue/messages/consumeRemittanceTransactionFromSQS'
55components:
56  messages:
57    RemittanceTransactionRequested:
58      name: RemittanceTransactionRequested
59      title: Remittance Transaction Requested
60      summary: Event emitted when a user requests to send money cross-border.
61      contentType: application/json
62      payload:
63        type: object
64        required:
65          - transactionId
66          - transactionType
67          - createdAt
68          - sender
69          - receiver
70          - amount
71          - currency
72          - paymentMethod
73        properties:
74          transactionId:
75            type: string
76            format: uuid
77            description: Unique transaction identifier.
78          transactionType:
79            type: string
80            description: Type of transaction.
81          createdAt:
82            type: string
83            format: date-time
84            description: ISO8601 timestamp for when the request was made.
85          sender:
86            type: object
87            required:
88              - name
89              - email
90              - country
91            properties:
92              name:
93                type: string
94              email:
95                type: string
96                format: email
97              country:
98                type: string
99                description: ISO 3166-1 alpha-2 country code
100          receiver:
101            type: object
102            required:
103              - name
104              - email
105              - country
106            properties:
107              name:
108                type: string
109              email:
110                type: string
111                format: email
112              country:
113                type: string
114                description: ISO 3166-1 alpha-2 country code
115          amount:
116            type: number
117            format: double
118            description: Amount requested to transfer.
119          currency:
120            type: string
121            description: ISO 4217 currency code.
122          paymentMethod:
123            type: string
124            description: Payment method used to fund the transaction.
125            enum:
126              - card
127              - wire_transfer
128              - bank_account
129      examples:
130        - name: remittance.transaction.requested.example
131          summary: Example remittance transaction request
132          payload:
133            transactionId: 33333333-3333-3333-3333-333333333333
134            transactionType: remittance.requested
135            createdAt: '2025-09-16T10:15:00Z'
136            sender:
137              name: Jonas Petrauskas
138              email: jonas.petrauskas@example.lt
139              country: LT
140            receiver:
141              name: Olena Shevchenko
142              email: olena.shevchenko@example.ua
143              country: UA
144            amount: 750
145            currency: EUR
146            paymentMethod: wire_transfer