Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 11 additions & 19 deletions mintlify/openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 11 additions & 19 deletions openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion openapi/components/schemas/common/CnyAccountInfo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ allOf:
items:
type: string
enum:
- MOBILE_MONEY
- BANK_TRANSFER
- MOBILE_MONEY
18 changes: 9 additions & 9 deletions openapi/components/schemas/common/CnyAccountInfoBase.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,31 @@ description: 'Required fields depend on the selected paymentRails:

- BANK_TRANSFER: accountNumber, bankName

- MOBILE_MONEY: phoneNumber, bankName'
- MOBILE_MONEY: bankName, phoneNumber'
properties:
accountType:
type: string
enum:
- CNY_ACCOUNT
accountNumber:
type: string
description: The destination bank account number (BANK_TRANSFER rail)
description: The account number of the bank
minLength: 1
maxLength: 34
bankName:
type: string
description: The name of the bank
minLength: 1
maxLength: 255
Comment on lines +20 to +24

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 The bankName description was narrowed from "The name of the bank or mobile-wallet provider" to "The name of the bank", but this field is still required for the MOBILE_MONEY rail (as stated in the schema description above). For MOBILE_MONEY payments there is no bank — the value is the mobile-wallet provider name. Dropping that clause leaves MOBILE_MONEY integrators without the guidance they need and could cause incorrect payloads to be submitted.

Suggested change
bankName:
type: string
description: The name of the bank
minLength: 1
maxLength: 255
bankName:
type: string
description: The name of the bank or mobile-wallet provider
minLength: 1
maxLength: 255
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/common/CnyAccountInfoBase.yaml
Line: 20-24

Comment:
The `bankName` description was narrowed from "The name of the bank or mobile-wallet provider" to "The name of the bank", but this field is still required for the MOBILE_MONEY rail (as stated in the schema description above). For MOBILE_MONEY payments there is no bank — the value is the mobile-wallet provider name. Dropping that clause leaves MOBILE_MONEY integrators without the guidance they need and could cause incorrect payloads to be submitted.

```suggestion
  bankName:
    type: string
    description: The name of the bank or mobile-wallet provider
    minLength: 1
    maxLength: 255
```

How can I resolve this? If you propose a fix, please make it concise.

phoneNumber:
type: string
description: The phone number in international format (MOBILE_MONEY rail)
description: The phone number in international format
Comment on lines 15 to +27

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 The descriptions for accountNumber and phoneNumber previously called out which payment rail each field applies to ("BANK_TRANSFER rail" / "MOBILE_MONEY rail"). Those rail hints were the only inline guidance telling integrators when to supply each field; removing them leaves users to rely solely on the prose block at the top of the schema.

Suggested change
accountNumber:
type: string
description: The destination bank account number (BANK_TRANSFER rail)
description: The account number of the bank
minLength: 1
maxLength: 34
bankName:
type: string
description: The name of the bank
minLength: 1
maxLength: 255
phoneNumber:
type: string
description: The phone number in international format (MOBILE_MONEY rail)
description: The phone number in international format
accountNumber:
type: string
description: The destination bank account number (BANK_TRANSFER rail)
minLength: 1
maxLength: 34
bankName:
type: string
description: The name of the bank or mobile-wallet provider
minLength: 1
maxLength: 255
phoneNumber:
type: string
description: The phone number in international format (MOBILE_MONEY rail)
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/common/CnyAccountInfoBase.yaml
Line: 15-27

Comment:
The descriptions for `accountNumber` and `phoneNumber` previously called out which payment rail each field applies to ("BANK_TRANSFER rail" / "MOBILE_MONEY rail"). Those rail hints were the only inline guidance telling integrators when to supply each field; removing them leaves users to rely solely on the prose block at the top of the schema.

```suggestion
  accountNumber:
    type: string
    description: The destination bank account number (BANK_TRANSFER rail)
    minLength: 1
    maxLength: 34
  bankName:
    type: string
    description: The name of the bank or mobile-wallet provider
    minLength: 1
    maxLength: 255
  phoneNumber:
    type: string
    description: The phone number in international format (MOBILE_MONEY rail)
```

How can I resolve this? If you propose a fix, please make it concise.

example: '+1234567890'
minLength: 7
maxLength: 15
pattern: ^\+[0-9]{6,14}$
bankName:
type: string
description: The name of the bank or mobile-wallet provider
minLength: 1
maxLength: 255
example:
accountType: CNY_ACCOUNT
accountNumber: '1234567890'
bankName: Example Bank
phoneNumber: '+1234567890'
bankName: China Construction Bank
7 changes: 0 additions & 7 deletions openapi/components/schemas/common/GbpBeneficiary.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,23 @@ properties:
type: string
enum:
- INDIVIDUAL
example: INDIVIDUAL
fullName:
type: string
description: The full name of the beneficiary
example: Jane Smith
birthDate:
type: string
description: The birth date of the beneficiary
example: '1990-01-15'
nationality:
type: string
description: The nationality of the beneficiary
example: GB
email:
type: string
description: The email of the beneficiary
example: jane.smith@example.com
phoneNumber:
type: string
description: The phone number of the beneficiary
example: '+447700900123'
countryOfResidence:
type: string
description: The country of residence of the beneficiary
example: GB
address:
$ref: ./Address.yaml
4 changes: 2 additions & 2 deletions openapi/components/schemas/common/SgdAccountInfoBase.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
type: object
required:
- accountType
- bankName
- accountNumber
- swiftCode
properties:
Expand All @@ -11,7 +10,8 @@ properties:
- SGD_ACCOUNT
bankName:
type: string
description: Name of the beneficiary's bank
description: Name of the beneficiary's bank. When omitted, resolved from swiftCode
via the payout partner bank directory at account creation.
minLength: 1
maxLength: 255
example: DBS Bank Ltd
Expand Down
Loading