Skip to content

docs: sync account type fields with OpenAPI schemas #548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shreyav merged 1 commit into from
Jun 4, 2026
Merged

docs: sync account type fields with OpenAPI schemas #548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 16 additions & 12 deletions components/grid-visualizer/src/data/account-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,35 +288,39 @@ export const accountTypeSpecs: Record<string, AccountTypeSpec> = {
BDT_ACCOUNT: {
accountType: 'BDT_ACCOUNT',
fields: [
{ name: 'accountNumber', example: '1234567890123' },
{ name: 'branchCode', example: '12345', description: '5-digit branch code' },
{ name: 'phoneNumber', example: '+8801712345678' },
{ name: 'bankName', example: 'BRAC Bank' },
{ name: 'accountNumber', example: '1234567890123', description: 'For bank transfer' },
{ name: 'branchCode', example: '12345', description: '5-digit branch code (optional)' },
{ name: 'phoneNumber', example: '+8801712345678', description: 'For mobile money' },
{ name: 'swiftCode', example: 'BABORUMMYYY', description: 'Optional' },
],
beneficiaryRequired: true,
},
COP_ACCOUNT: {
accountType: 'COP_ACCOUNT',
fields: [
{ name: 'bankName', example: 'Bancolombia' },
{ name: 'accountNumber', example: '1234567890', description: 'For bank transfer' },
{ name: 'bankAccountType', example: 'CHECKING', description: 'CHECKING or SAVINGS (for bank transfer)' },
{ name: 'phoneNumber', example: '+573001234567', description: 'For mobile money' },
],
beneficiaryRequired: true,
},
EGP_ACCOUNT: {
accountType: 'EGP_ACCOUNT',
fields: [
{ name: 'accountNumber', example: '1234567890123456' },
{ name: 'iban', example: 'EG380019000500000000263180002', description: 'Optional' },
{ name: 'swiftCode', example: 'NBEGEGCX', description: 'Optional' },
{ name: 'bankName', example: 'National Bank of Egypt' },
{ name: 'iban', example: 'EG380019000500000000263180002', description: 'For bank transfer (29 chars, starts with EG)' },
{ name: 'phoneNumber', example: '+201012345678', description: 'For mobile money' },
],
beneficiaryRequired: true,
},
GHS_ACCOUNT: {
accountType: 'GHS_ACCOUNT',
fields: [
{ name: 'accountNumber', example: '1234567890' },
{ name: 'phoneNumber', example: '+233241234567' },
{ name: 'bankName', example: 'GCB Bank' },
{ name: 'accountNumber', example: '1234567890', description: 'For bank transfer' },
{ name: 'phoneNumber', example: '+233241234567', description: 'For mobile money' },
],
beneficiaryRequired: true,
},
Expand Down Expand Up @@ -347,10 +351,10 @@ export const accountTypeSpecs: Record<string, AccountTypeSpec> = {
PKR_ACCOUNT: {
accountType: 'PKR_ACCOUNT',
fields: [
{ name: 'accountNumber', example: '1234567890123456' },
{ name: 'phoneNumber', example: '+923001234567' },
{ name: 'iban', example: 'PK36SCBL0000001123456702', description: 'Optional' },
{ name: 'bankName', example: 'HBL', description: 'Required for Mobile Money' },
{ name: 'bankName', example: 'HBL' },
{ name: 'accountNumber', example: '1234567890123456', description: 'For bank transfer' },
{ name: 'iban', example: 'PK36SCBL0000001123456702', description: 'Optional (24 chars, starts with PK)' },
{ name: 'phoneNumber', example: '+923001234567', description: 'For mobile money' },
],
beneficiaryRequired: true,
},
Expand Down
1 change: 1 addition & 0 deletions mintlify/snippets/external-accounts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ curl -X POST 'https://api.lightspark.com/grid/2025-10-13/customers/external-acco
"platformAccountId": "co_mobile_001",
"accountInfo": {
"accountType": "COP_ACCOUNT",
"bankName": "Nequi",
"phoneNumber": "+573001234567",
"beneficiary": {
"beneficiaryType": "INDIVIDUAL",
Expand Down
Loading