Resources
The creation of a transfer is done via :
/api/DomainePartenaire/users/appuserid/payouts/storedbankaccounts to create a transfer to a registered account for the user belonging to the connected third-party application.
Retrieving transfers can be done via:
/api/DomainePartenaire/users/appuserid/payouts/ to retrieve transfers for a user belonging the connected third-party application.
1.Payouts
Parameter | Type | Example | Description |
---|---|---|---|
OrderId | String | Moneyout-1 | Transfer reference in the third-party application (limited to 255 caracters) |
Id | Long | 412 | Transfer ID |
AccountId | SubAccountRef | Specifies the sub-account making the payment. (If not specified, the main account is used) | |
BankAccount | BankAccount | Bank account used | |
Amount | Long | 2350 | Transfer ammount (in cents) |
Fee | Fee | Fee | |
OperationDate | DateTime | 2013-09-10T 15:49:58.791121 +02:00 |
Transfer Date |
Message | String | S-money transfer of 01/22/2014 | Heading associated with the transfer. |
Reference | String | REF123456 | It is the EndtoEndID, it will be transfered in the SEPA Transfer operation (limited to 35 caracters) |
Motif | String | Virement S-money | It is the heading, it will be transfered in the SEPA Transfer operation (limited to 35 caracters) |
ExecutedDate | DateTime | 2017-08-02T17:37:55 | Date of the execution of the transfer |
2.BankAccount
Parameter | Type | Example | Description |
---|---|---|---|
Id | Long | Bank account ID | |
DisplayName | String | "Bank account" | Display name for the bank account |
Bic | String | Bank Identifier Code (BIC) | |
Iban | String | International Bank Account Number (IBAN) | |
IsMine | Bool | The bank account belongs to the user |
3.SubAccountRef
This object enables the identification of the accounts between which the oprations are made.
Parameters | Type | Example | Description |
---|---|---|---|
Id | Long | 98 | Account ID |
AppAccountId | String | "123 " | ID of the account provided by the third-party application |
DisplayName | String | "John Smith" | Account display name |
href | url | /api/DomainePartenaire/accounts/123 | URL to the account details |
4.Fee
The object Fee defines the fees applied.
Parameters | Type | Example | Description |
---|---|---|---|
Amount | long | 150 | Fee amount without taxes (in cents) |
VAT | double | 19.6 | fee percentage (in percentage) |
AmountWithVAT | long | 179 | Fee amount all taxes included (in cents) |
Status | Int | 1 | fee status 0 = Pending 1 = Succeeded 2 = Cancelled 3 = Failed 4 = Expired 5 = Refunded |