Resources
Retrieving madates associated with a user is made via:
/api/[domaine_partenaire]/mandates to access debit mandates associated with the connected user
/api/[domaine_partenaire]/users/appuserid/mandates to access debit mandates associated with the user "appuserid".
There are two ways to create a bank debit mandate:
Mandate by electronic signature, validated by electronic signature
Mandate on paper, validated by S-money Back Office.
1.Mandates
Contains details of a bank debit mandate
Parameter | Type | Example | Description |
---|---|---|---|
Id | Long | 123 | Mandate ID |
Date | DateTime | 2013-09-10T15:49:58. 791121+02:00 |
Mandate date of creation |
BankAccount | BankAccountRef | Reference to the bank account | |
Status | Int | 0 | Mandate status 0 = Pending 1 = Validated 2 = Dismissed 3 = Failure |
UrlReturn | String | http://s-money.fr/returnurl | URL to which the user is redirected after the signature |
MandateDemands | MandateDemands | Request details | |
Href | Uri | URL to call in order to electronically sign the mandate | |
ErrorCode | Int | 0 | Error code for failed requests, 0 = No error 1 = Session failed 2 = Session interrupted 3 = Session cancelled |
UMR | 30007-Sandbox-66673-14032016-0 | Mandate Single Reference |
2. MandateDemands
Contains details of a bank debit mandate
Parameter | Type | Example | Description |
---|---|---|---|
Id | Long | 123 | Request ID |
RequestDate | DateTime | 2013-09-10T15:49:58. 791121+02:00 | Date of the creation of the request |
VoucherCopies | List<Attachement> | List of supporting documents | |
Status | Int | Request status 0 = Incomplete 1 = Waiting 2 = Refused 3 = Accepted | |
Reason | String | Reason of refusal :
![]() ![]() ![]() ![]() |
3. Attachement
This object identifies the user bank account
Parameter | Type | Example | Description |
---|---|---|---|
Id | Long | 98 | Document ID |
Name | String | Receipt | File name |
ContentType | String | "image/png" | Image type |
Size | Long | 523010 | Size of the attached file (in octet) |
Href | Url | Link to the attached file |
4. BankAccountRef
This object identifies the user bank account
Parameter | Type | Example | Description |
---|---|---|---|
Id | Long | 98 | Bank account ID |
Href | Uri | "/api/[domaine_partenaire]/bankaccounts/98" | Url to the bank account details |