Resources
Retrieve the references of the transfer associated to a user:
/api/[partner_domain]/users/AppUserId/banktransferreferences
/api/[partner_domain]/users/AppUserId/payins/banktransfers/references
Retrieve one particular reference:
/api/[partner_domain]/users/AppUserId/banktransferreferences/id
/api/[partner_domain]/users/AppUserId/banktransferreferences/reference
/api/[partner_domain]/users/AppUserId/payins/banktransfers/references/id
/api/[partner_domain]/users/AppUserId/payins/banktransfers/references/reference
Retrieve the list of top-ups by user’s transfers:
/api/[partner_domain]/users/AppUserId/payins/banktransfers
Retrieve the list of top-ups through a transfer made by a user associated to one reference:
/api/[partner_domain]/users/AppUserId/payins/banktransfers?reference=reference
Retrieve a top-up by user’s transfer:
/api/[partner_domain]/users/AppUserId/payins/banktransfers/id
1.References
It contains the informations of a money transfer reference.
Property | Type | Example | Description |
---|---|---|---|
Id | Long | 123 | Reference Id |
Beneficiary | SubAccountRef | Item containg the details of the receiver sub-account. If not precised, it is the main sub-account of the connected user, which is used. | |
IsMine | Bool | True | True, if the account holder is also the bank account holder (it applies to an account top-up and not a payment) |
Reference | String | "A1B2C3D4E5" | Bank transfer reference to be indicated |
BankAccount | BankAccount | Details of the account into which the client should make his/her transfer |
2.BankTransfers
Contains information about a bank transfer top-up
Property | Type | Example | Description |
---|---|---|---|
Id | Long | 123 | Top-up Id |
PaymentDate | DateTime | 2013-09-10T15:49:58. 791121+02:00 | Top-up date |
Amount | Long | 2350 | Top-up amount (in cents ) |
Status | Int | 1 | Payment status -1 = unknow 0 = Waiting 1 = Realised 2 = Refunded 3 = Refused 4 = Waiting for validation |
Beneficiary | SubAccountRef | Item containg the details of the receiver sub-account If not precised, it is the main sub-account of the connected user, which is used | |
IsMine | Bool | True | True, if the account holder is also the holder of the bank account (it applies to an account top-up and not to a payment) |
Reference | String | "A1B2C3D4E5" | Reference to be indicated during a bank transfer |
BankAccount | BankAccount | Details of the account into which the client should make his/her transfer |
3. SubaccountRef
This item allows to identify the accounts between which the operations are made.
Property | Type | Example | Description |
---|---|---|---|
Id | Long | 98 | Account identifier |
AppAccountId | String | "123" | Account identifier provided by the third-party application. |
DisplayName | String | "Jean Dupont" | Display account name |
Href | Uri | "/api/[partner_domain] /accounts/123" | Uri for the account details |
4. BankAccount
This item refers to the references of the account to which the bank transfer needs to be made.
Property | Type | Example | Description |
---|---|---|---|
Name | String | "S-money" | Name of the account holder |
Address | Address | Address of the account holder | |
BIC | String | "XXXXXXX" | Account BIC |
IBAN | String | "FRXX XXXX XXXX XXXX XXXX XXXX XX" | Account IBAN |
5. Address
Propriété | Type | Exemple | Description |
---|---|---|---|
Street | String | 2 rue des châtaigniers | Number and street |
Zipcode | String | 75001 | Postcode |
City | String | Paris | City |
Country | String | "FR" | Nationality (ISO 3166-1 code) FR = France |