Skip to content

Commit 3de05db

Browse files
lightspark-copybara[bot]Lightspark Eng
lightspark-copybara[bot]
and
Lightspark Eng
authored
chore: Sync account schemas (#276)
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 a205da8 commit 3de05db

16 files changed

Lines changed: 762 additions & 120 deletions

‎mintlify/openapi.yaml‎

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

‎openapi.yaml‎

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

‎openapi/components/schemas/common/BwpAccountInfo.yaml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
type: object
2+
required:
3+
- accountType
4+
- paymentRails
5+
- phoneNumber
6+
- provider
7+
properties:
8+
accountType:
9+
type: string
10+
enum:
11+
- BWP_ACCOUNT
12+
paymentRails:
13+
type: array
14+
items:
15+
type: string
16+
enum:
17+
- MOBILE_MONEY
18+
phoneNumber:
19+
type: string
20+
description: The phone number in international format
21+
example: '+1234567890'
22+
minLength: 7
23+
maxLength: 15
24+
pattern: ^\+[0-9]{6,14}$
25+
provider:
26+
type: string
27+
description: The mobile money provider name
28+
minLength: 1
29+
maxLength: 255

‎openapi/components/schemas/common/BwpBeneficiary.yaml‎

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/MwkAccountInfo.yaml‎

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,14 @@
11
type: object
22
required:
3-
- accountType
4-
- countries
5-
- paymentRails
6-
- phoneNumber
7-
- provider
3+
- accountType
4+
- paymentRails
5+
- phoneNumber
6+
- provider
87
properties:
98
accountType:
109
type: string
1110
enum:
12-
- MWK_ACCOUNT
13-
countries:
14-
type: array
15-
items:
16-
type: string
17-
enum:
18-
- MW
11+
- MWK_ACCOUNT
1912
paymentRails:
2013
type: array
2114
items:
@@ -24,9 +17,13 @@ properties:
2417
- MOBILE_MONEY
2518
phoneNumber:
2619
type: string
27-
description: Malawian mobile money phone number
28-
example: '+265991234567'
29-
pattern: ^\+265[0-9]{9}$
20+
description: The phone number in international format
21+
example: '+1234567890'
22+
minLength: 7
23+
maxLength: 15
24+
pattern: ^\+[0-9]{6,14}$
3025
provider:
3126
type: string
32-
description: Mobile money provider
27+
description: The mobile money provider name
28+
minLength: 1
29+
maxLength: 255

‎openapi/components/schemas/common/PaymentBwpAccountInfo.yaml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
title: BWP Account
2+
allOf:
3+
- $ref: ./BasePaymentAccountInfo.yaml
4+
- $ref: ./BwpAccountInfo.yaml
5+
- type: object
6+
required:
7+
- reference
8+
properties:
9+
reference:
10+
type: string
11+
description: Unique reference code that must be included with the payment to
12+
properly credit it
13+
example: UMA-Q12345-REF

‎openapi/components/schemas/common/PaymentInstructions.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ properties:
3939
- $ref: ../common/PaymentXofAccountInfo.yaml
4040
- $ref: ../common/PaymentZarAccountInfo.yaml
4141
- $ref: ../common/PaymentZmwAccountInfo.yaml
42+
- $ref: ../common/PaymentBwpAccountInfo.yaml
43+
- $ref: ../common/PaymentXafAccountInfo.yaml
4244
- $ref: ../common/PaymentSparkWalletInfo.yaml
4345
- $ref: ../common/PaymentLightningInvoiceInfo.yaml
4446
- $ref: ../common/PaymentSolanaWalletInfo.yaml
@@ -79,3 +81,5 @@ properties:
7981
XOF_ACCOUNT: ../common/PaymentXofAccountInfo.yaml
8082
ZAR_ACCOUNT: ../common/PaymentZarAccountInfo.yaml
8183
ZMW_ACCOUNT: ../common/PaymentZmwAccountInfo.yaml
84+
BWP_ACCOUNT: ../common/PaymentBwpAccountInfo.yaml
85+
XAF_ACCOUNT: ../common/PaymentXafAccountInfo.yaml

‎openapi/components/schemas/common/PaymentXafAccountInfo.yaml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
title: XAF Account
2+
allOf:
3+
- $ref: ./BasePaymentAccountInfo.yaml
4+
- $ref: ./XafAccountInfo.yaml
5+
- type: object
6+
required:
7+
- reference
8+
properties:
9+
reference:
10+
type: string
11+
description: Unique reference code that must be included with the payment to
12+
properly credit it
13+
example: UMA-Q12345-REF

‎openapi/components/schemas/common/UgxAccountInfo.yaml‎

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,14 @@
11
type: object
22
required:
3-
- accountType
4-
- countries
5-
- paymentRails
6-
- phoneNumber
7-
- provider
3+
- accountType
4+
- paymentRails
5+
- phoneNumber
6+
- provider
87
properties:
98
accountType:
109
type: string
1110
enum:
12-
- UGX_ACCOUNT
13-
countries:
14-
type: array
15-
items:
16-
type: string
17-
enum:
18-
- UG
11+
- UGX_ACCOUNT
1912
paymentRails:
2013
type: array
2114
items:
@@ -24,9 +17,13 @@ properties:
2417
- MOBILE_MONEY
2518
phoneNumber:
2619
type: string
27-
description: Ugandan mobile money phone number
28-
example: '+256701234567'
29-
pattern: ^\+256[0-9]{9}$
20+
description: The phone number in international format
21+
example: '+1234567890'
22+
minLength: 7
23+
maxLength: 15
24+
pattern: ^\+[0-9]{6,14}$
3025
provider:
3126
type: string
32-
description: Mobile money provider
27+
description: The mobile money provider name
28+
minLength: 1
29+
maxLength: 255

‎openapi/components/schemas/common/XafAccountInfo.yaml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
type: object
2+
required:
3+
- accountType
4+
- paymentRails
5+
- phoneNumber
6+
- provider
7+
- region
8+
properties:
9+
accountType:
10+
type: string
11+
enum:
12+
- XAF_ACCOUNT
13+
paymentRails:
14+
type: array
15+
items:
16+
type: string
17+
enum:
18+
- MOBILE_MONEY
19+
phoneNumber:
20+
type: string
21+
description: The phone number in international format
22+
example: '+1234567890'
23+
minLength: 7
24+
maxLength: 15
25+
pattern: ^\+[0-9]{6,14}$
26+
provider:
27+
type: string
28+
description: The mobile money provider name
29+
minLength: 1
30+
maxLength: 255
31+
region:
32+
type: string
33+
description: Country code within the Central African CFA franc zone
34+
minLength: 2
35+
maxLength: 2
36+
pattern: ^[A-Z]{2}$
37+
enum:
38+
- CM
39+
- CG

0 commit comments

Comments
 (0)