V1

Ressources

To create or retrieve transfers references associated with a user :

/api/[domaine_partenaire]/users/AppUserId/chequereferences
/api/[domaine_partenaire]/users/AppUserId/payins/cheques/references

To retrieve a specific reference :

/api/[domaine_partenaire]/users/AppUserId/chequereferences/id
/api/[domaine_partenaire]/users/AppUserId/chequereferences/reference
/api/[domaine_partenaire]/users/AppUserId/payins/cheques/references/id
/api/[domaine_partenaire]/users/AppUserId/payins/cheques/references/reference

To retrieve the list of top-ups by transfers of a user :

/api/[domaine_partenaire]/users/AppUserId/payins/cheques

To retrieve the list of top-ups by transfer of a user associated with a reference :

/api/[domaine_partenaire]/users/AppUserId/payins/cheques ?reference=reference

To retrieve a user top-up by transfer :

/api/[domaine_partenaire]/users/AppUserId/payins/cheques/id

2.1 References

Contains the information of a cheque reference

Parameters Type Example Description
Id Long 123 Reference ID
Beneficiary SubAccountRef Object with the receiving sub-account details.

If not mentioned, the main sub-account of the connected user is used
IsMine Bool True True if the account holder is also the bank account holder

(it is an account top-up, and not a payment)
Reference String "A1B2C3D4E5" Reference to write on the cheque
BankAccount BankAccount Details of the account to which the client has to make a transfer

2.2 Cheques

Contains the information of a top-up by cheque

Parameters Type Example Description
Id Long 123 Top-up ID
PaymentDate DateTime 2013-09-10T15:49:58.791121+02:00 Transfer date
Amount Long 2350 Amount of the top-up (in cents)
Status Int 1 Payment status
0 = Pending
1 = Realised
2 = Refunded
3 = Failure
4 = Waiting for validation
5 = Canceled
6 = Waiting for a remittance
Beneficiary SubAccountRef Object with the receiving sub-account details.

If not mentioned, the main sub-account of the connected user is used
IsMine Bool True True if the account holder is also the bank account holder

(it is an account top-up, and not a payment)
Reference String "A1B2C3D4E5" Reference to write on the cheque
Address Address Details of the account to which the client has to make a transfer

2.3 SUBACCOUNTREF

This object enables identifying the accounts between which the operations are made.

Parameter 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 displayed name
Href Uri "/api/[domaine_partenaire]/accounts/123" Uri to the account details

2.4 ADDRESS

Parameter Type Example Description
Name String S-money - cheque-cashing departement of the platform xxx Name + Department to comunicate to the client to send the cheque
Street String 2 rue des chataîgners Number and street
Zipcode String 75001 Zip code
City String Paris Town
Country String "FR" Country (code ISO 3166-1)