Top-up by cheque

Generalities

1.1 How does it work?

The partner has to create a reference of top-up by cheque with S-money. This reference enables linking the S-money account.

When creating this reference, the S-money server send back:
 The reference to write on the cheque
 The adress to send the cheque to.

Thus the partner has to ask his client:
 To write a cheque to S-money
 To add the reference (on the back of the cheque or after S-money in the order
 To send to the adress received.

The partner will be notified:
 When the cheque has been received
 When the cheque has been credited form the account.

Warning: Multiple cheques with the same reference can credit the account linked to this reference.

1.2 Macro Process

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

2.2 Cheques

Contains the information of a top-up by cheque

2.3 SUBACCOUNTREF

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

2.4 ADDRESS

Ask for a reference of a top-up by cheque

3.1 Send data of the request of top-up by cheque to the S-money server

To ask for a reference of a top-up by cheque, please refer to the example in the right margin.

3.2 Send the third-party server data of a top-up by cheque made

The third-party server has to make available a server url enabling the S-money server to notify it of the result of the processing of a top-up.

Warning, multiple top-ups can come with the same reference.

Calling the S-money server is done using the HTTP POST method.

Parameters of the HTTP request are:

Retrieve the list of references of top-ups by cheque

To retrieve the list of references of top-ups by cheque, please refer to the example in the right margin.

Retrieve a reference of top-up by cheque

To retrieve a reference of top-up by cheque, please refer to the example in the right margin.

Error case

Retrieve the list of the top-ups by cheque

To retrieve the list of top-ups by cheque, please refer to the example in the right margin.

Retrieve a top-up by cheque

To retrieve a top-up by cheque, please refer to the example in the right margin.

Error case: