make_transfer
POST - Make a transfert
| Argument | Description | Type - Length | Example | Mandatory |
|---|---|---|---|---|
| consumer_first_name | Beneficiary first name | String - 70 | YES * | |
| consumer_last_name | Beneficiary last name | String - 70 | YES * | |
| safedebit_consumer_reference | Safedebit consumer reference | String - 32 | YES * | |
| transfer_reference | Transfer reference | String - 35 | YES | |
| transfer_date | Transfer date | String - 10 | Format DD/MM/YYYY | YES ** |
| transfer_type | Transfer type | String - 35 | field.transfer_type.example1 is missing | YES |
| amount | Levy amount in cents | String - 10 | YES | |
| consumer_store | Safedebit store reference | String - 10 | YES *** | |
| iban | Beneficiary's IBAN | String - 33 | YES | |
| token | field.token.label is missing | String | NO | |
| motif | reason of transfer | String - 120 | NO | |
** Transfer date must be greater than today's date and greater by 8 days, in the context of a non-accountable collecting contract.
*** If the merchant owns more than one store, then consumer_store is mandatory
Request
POST /xxxx/make_transfer HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
{
"consumer_first_name": "Foo",
"consumer_last_name": "Bar",
"transfer_reference": "Transfer-Reference-1",
"transfer_type": "TRANSFER",
"transfer_date": "30/06/2023",
"amount": "1000",
"iban": "FRXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXX",
"consumer_store": "CONSUMERSTORE"}
If transfer was successfully registered
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": true,
"transfer_reference": "Transfer-Reference-1 c5a",
"transfer_status": "1",
"transfer_date": "30/06/2023",
"amount": "1000",
"safedebit_consumer_reference": "16861271302132155"
}
| Argument | Description |
|---|---|
| transfer_reference | Transfer reference |
| transfer_status | Transfer status : 1 : Pending 2 : Emitted 3 : Waiting for validation 4 : Waiting for funds 5 : On hold without funds 6 : Refused 7 : Canceled |
| transfer_date | Transfer date |
| amount | Levy amount in cents |
| safedebit_consumer_reference | Safedebit consumer reference |
If transfer registration failed
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : false,
"code" : "XXXX"
}
Request
HTTP/1.1 200 OK
POST /ssp/make_transfer HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json