Skip to content

Commit 84517a5

Browse files
Fix formatting
1 parent 7794164 commit 84517a5

File tree

1 file changed

+25
-23
lines changed

1 file changed

+25
-23
lines changed

docs/API Overview/pis.md

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -74,18 +74,11 @@ If you choose to send a domestic payment to a GB recipient from a supported curr
7474

7575
`InstructedAmount/Currency` can be any currency. The user can specify the instructed amount in any currency and Stripe will do the required FX to extract money from the user's Stripe account and send the money in the recipient's destination currency (see note below).
7676

77-
### `SupplementaryData` requirements
78-
79-
Stripe's Open Banking API requires you to send additional data in the SupplementaryData field to ensure a successful payment:
80-
81-
- `SupplementaryData.CreditorAccount.Email`: Must contain the recipient's email address
82-
- `SupplementaryData.CreditorAccount.EntityType`: Must be either `individual` or `company` depending on the type of the recipient
83-
8477
### Note on recipient destination currency
8578

8679
Stripe only supports payments that land in the recipient's local currency. For instance, when sending a payment to a France based recipient, the payment will post to the user's bank account in Euros.
8780

88-
### `SupplementaryData` requirements
81+
## `SupplementaryData` requirements
8982

9083
Stripe's Open Banking API requires you to send additional data in the SupplementaryData field to ensure a successful payment. The full schema of SupplementaryData is included at the end of this document.
9184

@@ -95,22 +88,31 @@ The following fields are necessary for all payments, except those made with the
9588

9689
**Note: SupplementaryData has additional optional fields that are required for a successful payment depending on the destination country:**
9790

98-
## Additional required bank account information for international payments
91+
### Additional required bank account information for international payments
92+
93+
The following table mentions the bank account details you must send about the creditor depending on the destination country and the scheme name.
9994

100-
The following table mentions the bank account details you must send about the creditor depending on the destinationcountry and the scheme name.
95+
- `Country` refers to the country of the Creditor (`DestinationCountryCode`)
96+
- `Identification` refers to `Initiation.CreditorAccount.Identification`
97+
- `RoutingNumber` refers to `SupplementaryData.CreditorAccount.BankAccountDetails.RoutingNumber`
98+
- `BranchNumber` refers to `SupplementaryData.CreditorAccount.BankAccountDetails.BranchNumber`
99+
- `SwiftCode` refers to `SupplementaryData.CreditorAccount.BankAccountDetails.SwiftCode`
101100

102-
| DestinationCountryCode | Scheme Name | CreditorAccount.Identification | SupplementaryData.CreditorAccount.BankAccountDetails.RoutingNumber | SupplementaryData.CreditorAccount.BankAccountDetails.BranchNumber | SupplementaryData.CreditorAccount.BankAccountDetails.SwiftCode |
101+
| Country | Scheme Name | Identification | RoutingNumber | BranchNumber | SwiftCode |
103102
| ----------------- | ------------ | ------------------------------ | ------------------------------------------------------------------ | ----------------------------------------------------------------- | -------------------------------------------------------------- |
104103
| AU | UK.OBIE.BBAN | Account Number | BSB | | |
105104
| CA | UK.OBIE.BBAN | Account Number | Transit Number | Institution Number | |
106105
| FR | UK.OBIE.IBAN | IBAN | | | |
107106
| US | UK.OBIE.BBAN | Account Number | Routing Number |
108107

109-
## Additional required information KYC information for international payments
110-
The following table mentions the additional KYC data you must send about the creditor depending on the destination country and entity type.
108+
### Additional required information KYC information for international payments
109+
110+
The following table mentions the additional KYC data you must send about the creditor depending on the destination country and entity type.
111111

112+
- `Individual` refers to `SupplementaryData.CreditorAccount.Individual`
113+
- `BusinessDetails` refers to `SupplementaryData.CreditorAccount.BusinessDetails`
112114

113-
| DestinationCountryCode | Required fields | Required if EntityType=individual | Required if EntityType=company |
115+
| Country | Required fields | Required if EntityType=individual | Required if EntityType=company |
114116
| ----------------- | -------------------------------------------- | --------------------------------- | ------------------------------ |
115117
| AU | SupplementaryData.CreditorAccount.Email | Individual.DateOfBirth | BusinessDetails.Address |
116118
| | SupplementaryData.CreditorAccount.EntityType | Individual.Address | |
@@ -126,16 +128,16 @@ The following table mentions the additional KYC data you must send about the cre
126128
| | | | |
127129

128130

129-
# SupplementaryData Object
131+
## SupplementaryData Object
130132

131-
The SupplementaryData is an Optional object that contains additional information that Stripe requires in some cases. Please read the tables below to ensure you send all the required data for a successful payment. The shape of the object is defined below:
133+
The SupplementaryData is an Optional object that contains additional information that Stripe requires in some cases. Please read the tables above to ensure you send all the required data for a successful payment. The shape of the object is defined below:
132134

133-
## SupplementaryData
135+
### SupplementaryData
134136

135137
Properties:
136138
- **CreditorAccount** (object, required): Information about the creditor's account.
137139

138-
## SupplementaryData.CreditorAccount
140+
### SupplementaryData.CreditorAccount
139141

140142
Properties:
141143
- **Email** (string, optional): The email address of the creditor.
@@ -153,7 +155,7 @@ Properties:
153155

154156
- **BankAccountDetails** (object, optional): Details about the bank account.
155157

156-
## SupplementaryData.CreditorAccount.Individual
158+
### SupplementaryData.CreditorAccount.Individual
157159

158160
Properties:
159161
- **Name** (string, optional): The full name of the individual creditor.
@@ -164,14 +166,14 @@ Properties:
164166

165167
- **Address** (object, optional): The address of the individual.
166168

167-
## SupplementaryData.CreditorAccount.BusinessDetails
169+
### SupplementaryData.CreditorAccount.BusinessDetails
168170

169171
Properties:
170172
- **RegisteredName** (string, optional): The registered name of the business.
171173

172174
- **Address** (object, optional): The address of the business.
173175

174-
## SupplementaryData.CreditorAccount.BankAccountDetails
176+
### SupplementaryData.CreditorAccount.BankAccountDetails
175177

176178
Properties:
177179
- **RoutingNumber** (string, optional): Refer to the table below for the expected value per country.
@@ -180,7 +182,7 @@ Properties:
180182

181183
- **SwiftCode** (string, optional): Refer to the table below for the expected value per country.
182184

183-
## SupplementaryData.CreditorAccount.Individual.Address and SupplementaryData.CreditorAccount.BusinessDetails.Address
185+
### SupplementaryData.CreditorAccount.Individual.Address and SupplementaryData.CreditorAccount.BusinessDetails.Address
184186
If the Address is required, please provide all the properties you have in the below mentioned spec.
185187

186188
Properties:
@@ -198,7 +200,7 @@ Properties:
198200

199201
- **Line2** (string, optional): The second line of the address.
200202

201-
## Example payment request for an international payment to US
203+
### Example payment request for an international payment to US
202204
The following shows an example payment request to the US using the guidelines above:
203205

204206
- The `DestinationCountryCode` is "US"

0 commit comments

Comments
 (0)