Skip to content

Commit fa97cde

Browse files
lightspark-copybara[bot]Lightspark Eng
andauthored
chore: Sync account schemas (#275)
Auto-synced account schemas. These schemas are generated from VASP adapter field definitions in sparkcore. **Synced schemas:** - `common/` — per-currency account info, beneficiary, and payment account schemas - `common/PaymentInstructions.yaml` — payment instructions oneOf (new currencies added) - `external_accounts/` — per-currency external account schemas (reference common/) Please review the changes before merging. Co-authored-by: Lightspark Eng <engineering@lightspark.com>
1 parent a49c760 commit fa97cde

59 files changed

Lines changed: 1874 additions & 815 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

mintlify/openapi.yaml

Lines changed: 684 additions & 330 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

openapi.yaml

Lines changed: 684 additions & 330 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
type: object
2+
required:
3+
- accountType
4+
- paymentRails
5+
- iban
6+
properties:
7+
accountType:
8+
type: string
9+
enum:
10+
- AED_ACCOUNT
11+
paymentRails:
12+
type: array
13+
items:
14+
type: string
15+
enum:
16+
- BANK_TRANSFER
17+
iban:
18+
type: string
19+
description: UAE IBAN (23 characters, starting with AE)
20+
example: AE070331234567890123456
21+
minLength: 23
22+
maxLength: 23
23+
pattern: ^AE[0-9]{21}$
24+
swiftCode:
25+
type: string
26+
description: The SWIFT/BIC code of the bank
27+
example: EBILAEAD
28+
minLength: 8
29+
maxLength: 11
30+
pattern: ^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
title: Individual Beneficiary
2+
type: object
3+
required:
4+
- beneficiaryType
5+
- fullName
6+
properties:
7+
beneficiaryType:
8+
type: string
9+
enum:
10+
- INDIVIDUAL
11+
fullName:
12+
type: string
13+
description: The full name of the beneficiary
14+
birthDate:
15+
type: string
16+
description: The birth date of the beneficiary
17+
nationality:
18+
type: string
19+
description: The nationality of the beneficiary
20+
email:
21+
type: string
22+
description: The email of the beneficiary
23+
phoneNumber:
24+
type: string
25+
description: The phone number of the beneficiary
26+
registrationNumber:
27+
type: string
28+
description: The registration number of the beneficiary
29+
countryOfResidence:
30+
type: string
31+
description: The country of residence of the beneficiary
32+
address:
33+
$ref: ./Address.yaml

openapi/components/schemas/common/BrlAccountInfo.yaml

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,21 @@ properties:
1818
- PIX
1919
pixKey:
2020
type: string
21-
description: The PIX key of the bank
21+
description: The PIX key (email, phone, CPF, CNPJ, or random)
22+
minLength: 1
23+
maxLength: 77
2224
pixKeyType:
2325
type: string
24-
description: The type of PIX key of the bank
26+
description: The type of PIX key
27+
enum:
28+
- CPF
29+
- CNPJ
30+
- EMAIL
31+
- PHONE
32+
- RANDOM
2533
taxId:
2634
type: string
27-
description: The tax ID of the bank account
35+
description: The tax ID (CPF or CNPJ)
36+
minLength: 11
37+
maxLength: 14
38+
pattern: ^[0-9]{11,14}$

openapi/components/schemas/common/DkkAccountInfo.yaml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,15 @@ properties:
1717
- SEPA_INSTANT
1818
iban:
1919
type: string
20-
description: The IBAN of the bank
21-
swiftBic:
20+
description: The IBAN of the bank account
21+
example: DE89370400440532013000
22+
minLength: 15
23+
maxLength: 34
24+
pattern: ^[A-Z]{2}[0-9]{2}[A-Za-z0-9]{11,30}$
25+
swiftCode:
2226
type: string
23-
description: The SWIFT BIC of the bank
27+
description: The SWIFT/BIC code of the bank
28+
example: DEUTDEFF
29+
minLength: 8
30+
maxLength: 11
31+
pattern: ^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$

openapi/components/schemas/common/EurAccountInfo.yaml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,15 @@ properties:
1717
- SEPA_INSTANT
1818
iban:
1919
type: string
20-
description: The IBAN of the bank
21-
swiftBic:
20+
description: The IBAN of the bank account
21+
example: DE89370400440532013000
22+
minLength: 15
23+
maxLength: 34
24+
pattern: ^[A-Z]{2}[0-9]{2}[A-Za-z0-9]{11,30}$
25+
swiftCode:
2226
type: string
23-
description: The SWIFT BIC of the bank
27+
description: The SWIFT/BIC code of the bank
28+
example: DEUTDEFF
29+
minLength: 8
30+
maxLength: 11
31+
pattern: ^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$

openapi/components/schemas/common/GbpAccountInfo.yaml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,15 @@ properties:
1717
- FASTER_PAYMENTS
1818
sortCode:
1919
type: string
20-
description: UK bank sort code (6 digits, may include hyphens)
21-
example: '20-00-00'
22-
pattern: '^[0-9]{2}-?[0-9]{2}-?[0-9]{2}$'
20+
description: The UK sort code
21+
example: '123456'
22+
minLength: 6
23+
maxLength: 6
24+
pattern: ^[0-9]{6}$
2325
accountNumber:
2426
type: string
2527
description: UK bank account number (8 digits)
26-
example: '12345678'
2728
minLength: 8
2829
maxLength: 8
30+
example: '12345678'
2931
pattern: ^[0-9]{8}$

openapi/components/schemas/common/HkdAccountInfo.yaml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,18 @@ properties:
1818
- BANK_TRANSFER
1919
bankName:
2020
type: string
21-
description: Name of the bank
22-
example: HSBC Hong Kong
21+
description: The name of the bank
22+
minLength: 1
23+
maxLength: 255
2324
accountNumber:
2425
type: string
2526
description: Hong Kong bank account number
27+
minLength: 1
28+
maxLength: 34
2629
example: '123456789012'
2730
swiftCode:
2831
type: string
29-
description: SWIFT/BIC code (8 or 11 characters)
32+
description: The SWIFT/BIC code of the bank
3033
example: HSBCHKHHHKH
3134
minLength: 8
3235
maxLength: 11

openapi/components/schemas/common/IdrAccountInfo.yaml

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ type: object
22
required:
33
- accountType
44
- paymentRails
5-
- accountNumber
65
- bankName
6+
- accountNumber
77
- swiftCode
88
- phoneNumber
99
properties:
@@ -17,17 +17,21 @@ properties:
1717
type: string
1818
enum:
1919
- BANK_TRANSFER
20+
bankName:
21+
type: string
22+
description: The name of the bank
23+
minLength: 1
24+
maxLength: 255
25+
example: Bank Central Asia
2026
accountNumber:
2127
type: string
2228
description: Indonesian bank account number
29+
minLength: 1
30+
maxLength: 34
2331
example: '1234567890'
24-
bankName:
25-
type: string
26-
description: Name of the bank
27-
example: Bank Central Asia
2832
swiftCode:
2933
type: string
30-
description: SWIFT/BIC code (8 or 11 characters)
34+
description: The SWIFT/BIC code of the bank
3135
example: CENAIDJA
3236
minLength: 8
3337
maxLength: 11
@@ -36,4 +40,6 @@ properties:
3640
type: string
3741
description: Indonesian phone number for e-wallet payments
3842
example: '+6281234567890'
43+
minLength: 7
44+
maxLength: 15
3945
pattern: ^\+62[0-9]{9,12}$

0 commit comments

Comments
 (0)