initiate_transfer
POST - Initialisation of a levy payment
| Argument | Description | Type - Length | Example | Mandatory |
|---|---|---|---|---|
| safedebit_consumer_reference | Safedebit consumer reference | String - 35 | YES * | |
| consumer_reference | Consumer reference | String - 35 | NO *** | |
| payment_reference | Payment/order reference | String - 64 | YES | |
| sms_option | Options for sending SMS payment link | Char - 1 | NO | |
| email_option | Options for sending payment link by e-mail | Char - 1 | NO | |
| url_ko | Error URL | String - 128 | https:// | NO |
| url_cancel | Cancellation URL | String - 128 | https:// | NO |
| code_bank | bank code | String - 8 | NO | |
| consumer_first_name | Consumer first name | String - 70 | YES * | |
| consumer_last_name | Consumer last name | String - 70 | YES * | |
| consumer_phone_number | Consumer phone | String - 16 | NO | |
| consumer_email | Consumer e-mail | String - 70 | NO | |
| amount | Total amount in cents | String - 18 | YES | |
| url_ok | Confirmation URL | String - 128 | https:// | YES ** |
| url_callback | Notification URL | String - 128 | https:// | YES ** |
- MABANQUE : test bank.
- SOGEFRPP : Société Générale.
- AGRIFRPP : Crédit Agricole.
- CMCIFRPP : Crédit Mutuel.
- BOUSFRPP : Boursourama.
- BNPAFRPP : BNP Paribas.
- ALL : all banks.
** Confirmation url is required (url_ok : manual response or url_callback : automatic response).
*** If the consumer_reference is given and corresponds to an existing consumer, the initialization of the payment will be cancelled.
Necessary consumer information is : safedebit_consumer_reference or (consumer_first_name + consumer_last_name + code_bank)
Request
POST /xxxx/initiate_transfer HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
{
"field.caih.safedebit_consumer_reference.label2 is missing": "XXXXXX",
"consumer_reference": "XXXXXX",
"amount": "1000",
"payment_reference": "Commande 12345",
"sms_option": "1",
"email_option": "1",
"url_ok": "https://.......",
"url_ko": "https://.......",
"url_cancel": "https://.......",
"url_callback": "https://.......",
"consumer_last_name": "Dupont",
"consumer_first_name": "Jean",
"consumer_phone_number": "0615985048",
"consumer_email": "jean.dupont@gmail.com"}
If link to payment by transfer successfully generated
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : true,
"link" : "https://xxxxx"
}
If link to payment by transfer failed
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : false,
"code" : "XXXX"
}
| Argument | Description |
|---|---|
| result | true or false : true : action succeeded false : action failed |
| link | Payment link by bank transfer |
| code | See (error codes in annex). |
Callback
After payment by transfer validation, a notification is sent to url_callback with this parameters| Argument | Description |
|---|---|
| payment_reference | Payment/order reference |
| payment_status | VALIDATED,CANCELED,ERROR |
| amount | Total amount in cents |
| validation_date | Validation date |
| safedebit_consumer_reference | Consumer's Safedebit reference |
Request
HTTP/1.1 200 OK
POST /ssp/initiate_transfer HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json