Skip to content

Commit 8a1c61b

Browse files
committed
feat: adding more docs about minimum required data for external accounts
1 parent c768b01 commit 8a1c61b

1 file changed

Lines changed: 105 additions & 0 deletions

File tree

mintlify/snippets/external-accounts.mdx

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,79 @@ curl -X POST 'https://api.lightspark.com/grid/2025-10-13/customers/external-acco
151151

152152
</Tab>
153153

154+
<Tab title="Philippines">
155+
**PHP Bank Transfer**
156+
157+
```bash cURL
158+
curl -X POST 'https://api.lightspark.com/grid/2025-10-13/customers/external-accounts' \
159+
-H 'Authorization: Basic $GRID_CLIENT_ID:$GRID_CLIENT_SECRET' \
160+
-H 'Content-Type: application/json' \
161+
-d '{
162+
"currency": "PHP",
163+
"platformAccountId": "ph_bank_001",
164+
"accountInfo": {
165+
"accountType": "PHP_ACCOUNT",
166+
"bankName": "BDO Unibank",
167+
"accountNumber": "001234567890",
168+
"paymentRails": ["BANK_TRANSFER"],
169+
"beneficiary": {
170+
"beneficiaryType": "INDIVIDUAL",
171+
"fullName": "Maria Santos",
172+
"birthDate": "1995-04-10",
173+
"nationality": "PH",
174+
"address": {
175+
"line1": "123 Rizal Avenue",
176+
"city": "Manila",
177+
"state": "Metro Manila",
178+
"postalCode": "1000",
179+
"country": "PH"
180+
}
181+
}
182+
}
183+
}'
184+
```
185+
186+
<Note>
187+
Account number must be 8-16 digits.
188+
</Note>
189+
</Tab>
190+
191+
<Tab title="United Kingdom">
192+
**GBP Faster Payments**
193+
194+
```bash cURL
195+
curl -X POST 'https://api.lightspark.com/grid/2025-10-13/customers/external-accounts' \
196+
-H 'Authorization: Basic $GRID_CLIENT_ID:$GRID_CLIENT_SECRET' \
197+
-H 'Content-Type: application/json' \
198+
-d '{
199+
"currency": "GBP",
200+
"platformAccountId": "gb_bank_001",
201+
"accountInfo": {
202+
"accountType": "GBP_ACCOUNT",
203+
"sortCode": "123456",
204+
"accountNumber": "12345678",
205+
"paymentRails": ["FASTER_PAYMENTS"],
206+
"beneficiary": {
207+
"beneficiaryType": "INDIVIDUAL",
208+
"fullName": "James Smith",
209+
"birthDate": "1985-09-03",
210+
"nationality": "GB",
211+
"address": {
212+
"line1": "10 Downing Street",
213+
"city": "London",
214+
"postalCode": "SW1A 2AA",
215+
"country": "GB"
216+
}
217+
}
218+
}
219+
}'
220+
```
221+
222+
<Note>
223+
Sort code must be 6 digits. Account number must be 8 digits. Address is required for GBP individual beneficiaries.
224+
</Note>
225+
</Tab>
226+
154227
<Tab title="India">
155228
**UPI**
156229

@@ -521,6 +594,25 @@ For business accounts, include business information:
521594
}
522595
```
523596

597+
## Minimum required beneficiary fields
598+
599+
The following table shows the minimum required fields for individual and business beneficiaries by country. All other fields are optional but recommended for faster compliance review.
600+
601+
### Individual beneficiaries
602+
603+
| Country | Required Fields | Required Address Fields |
604+
| --- | --- | --- |
605+
| US (USD) | `beneficiaryType`, `fullName` | None (address optional) |
606+
| Mexico (MXN) | `beneficiaryType`, `fullName` | None (address optional) |
607+
| Brazil (BRL) | `beneficiaryType`, `fullName` | None (address optional) |
608+
| Philippines (PHP) | `beneficiaryType`, `fullName` | None (address optional) |
609+
| United Kingdom (GBP) | `beneficiaryType`, `fullName`, `address` | `line1`, `postalCode`, `country` |
610+
| Europe (EUR) | `beneficiaryType`, `fullName`, `address` | `line1`, `postalCode`, `country` |
611+
612+
<Info>
613+
While only the fields listed above are strictly required, providing additional information like `birthDate`, `nationality`, and `address` can reduce the likelihood of false positive compliance review and increase transaction success rates.
614+
</Info>
615+
524616
## Account status
525617
Beneficiary data may be reviewed for risk and compliance. Only `ACTIVE` accounts can receive payments. Updates to account data may trigger account re-review.
526618

@@ -587,6 +679,19 @@ if (!/^\d{7,12}$/.test(cadAccountNumber)) {
587679
throw new Error("Invalid Canadian account number");
588680
}
589681

682+
// PHP: 8-16 digit account number
683+
if (!/^\d{8,16}$/.test(phpAccountNumber)) {
684+
throw new Error("Invalid Philippine account number");
685+
}
686+
687+
// GBP: 6-digit sort code, 8-digit account number
688+
if (!/^\d{6}$/.test(sortCode)) {
689+
throw new Error("Invalid sort code");
690+
}
691+
if (!/^\d{8}$/.test(gbpAccountNumber)) {
692+
throw new Error("Invalid UK account number");
693+
}
694+
590695
// ZAR: 9-13 digit account number
591696
if (!/^\d{9,13}$/.test(zarAccountNumber)) {
592697
throw new Error("Invalid South African account number");

0 commit comments

Comments
 (0)