secure_payment
POST - Create a guaranteed payment
| Argument | Description | Type - Length | Example | Mandatory |
|---|---|---|---|---|
| safedebit_consumer_reference | Safedebit consumer reference | String - 35 | YES | |
| umr | Unique mandate reference | String - 35 | YES | |
| amount | Total levy amount in cents | String - 18 | YES | |
| echeance_number | Number of levy deadlines | String - 2 | YES | |
| secure_type | Securing type | Char - 1 | See table in annex | YES |
| due_date | Levy first date | String - 10 | DD/MM/YYYY | YES |
| payment_reference | Payment reference | String - 64 | YES | |
| sdd | List of SDD references | Json | YES | |
| motif ** | Reason of levy | String - 128 | NO | |
| beneficiary_reference *** | Unique reference of beneficiary | String - 32 | NO | |
| url_callback | Callback URL | String - 128 | NO | |
*** MB reserved field.
Request
POST /xxxx/secure_payment HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
{
"safedebit_consumer_reference": "XXXXXX",
"amount": "1000",
"due_date": "01/01/2018",
"secure_type": "2",
"echeance_number": "2",
"sdd": [
"Reference-first-sdd",
"Reference-second-sdd"
],
"umr": "UMR_XXXXX",
"payment_reference": "Transaction-123",
"motif": "Paiement en 2 fois",
"url_callback": "https://mondomaine.fr/lien"}
If payment validated
Response
{
"result" : true,
"status" : "VALIDATED",
"payment_reference" : "Transaction-123",
"safedebit_secure_reference" : "XXXXXX",
"sdd": [
{
"sdd_reference" : "Reference-first-sdd",
"amount" : "500",
"due_date" : "01/01/2018",
"status" : "CREATED"
},
{
"sdd_reference" : "Reference-second-sdd",
"amount" : "500",
"due_date" : "01/02/2018",
"status" : "WAITING"
}
]
}
Payment waiting for validation
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : true,
"status" : "PENDING",
"payment_reference": "Transaction-123",
"safedebit_secure_reference" : "XXXXXX",
"sdd":[
{
"sdd_reference" : "Reference-first-sdd",
"amount" : "500",
"due_date" : "01/01/2018",
"status" : "PENDING"
},
{
"sdd_reference" : "Reference-second-sdd",
"amount" : "500",
"due_date" : "01/02/2018",
"status" : "PENDING"
}
]
}
Payment creation 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 |
||||||||
| status | Payment status | ||||||||
| payment_reference | Payment reference | ||||||||
| safedebit_secure_reference | Safedebit guarantee reference | ||||||||
| sdd | List of levies
|
||||||||
| validation_type | Type of validation : OTP (sms) PIN (PIN code) FCID (FaceId) TCID(TouchId) |
||||||||
| code | See (error codes in annex). |
Request
HTTP/1.1 200 OK
POST /ssp/payment HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json