You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/API Overview/pis.md
+25-23Lines changed: 25 additions & 23 deletions
Original file line number
Diff line number
Diff line change
@@ -74,18 +74,11 @@ If you choose to send a domestic payment to a GB recipient from a supported curr
74
74
75
75
`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).
76
76
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
-
84
77
### Note on recipient destination currency
85
78
86
79
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.
87
80
88
-
###`SupplementaryData` requirements
81
+
## `SupplementaryData` requirements
89
82
90
83
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.
91
84
@@ -95,22 +88,31 @@ The following fields are necessary for all payments, except those made with the
95
88
96
89
**Note: SupplementaryData has additional optional fields that are required for a successful payment depending on the destination country:**
97
90
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.
99
94
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`
101
100
102
-
|DestinationCountryCode| Scheme Name |CreditorAccount.Identification |SupplementaryData.CreditorAccount.BankAccountDetails.RoutingNumber |SupplementaryData.CreditorAccount.BankAccountDetails.BranchNumber |SupplementaryData.CreditorAccount.BankAccountDetails.SwiftCode |
@@ -126,16 +128,16 @@ The following table mentions the additional KYC data you must send about the cre
126
128
|||||
127
129
128
130
129
-
# SupplementaryData Object
131
+
##SupplementaryData Object
130
132
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:
132
134
133
-
## SupplementaryData
135
+
###SupplementaryData
134
136
135
137
Properties:
136
138
-**CreditorAccount** (object, required): Information about the creditor's account.
137
139
138
-
## SupplementaryData.CreditorAccount
140
+
###SupplementaryData.CreditorAccount
139
141
140
142
Properties:
141
143
-**Email** (string, optional): The email address of the creditor.
@@ -153,7 +155,7 @@ Properties:
153
155
154
156
-**BankAccountDetails** (object, optional): Details about the bank account.
155
157
156
-
## SupplementaryData.CreditorAccount.Individual
158
+
###SupplementaryData.CreditorAccount.Individual
157
159
158
160
Properties:
159
161
-**Name** (string, optional): The full name of the individual creditor.
@@ -164,14 +166,14 @@ Properties:
164
166
165
167
-**Address** (object, optional): The address of the individual.
0 commit comments