Debit consent signature
This operations is applicable when:
- Creating a DEBIT transaction
This operation enables you to:
- Require a debit consent from the consumer. Thereby the consumer approves one or multiple debit transactions up to the total amount of the order.
- Associate a signature to a debit consent for an order. Can be used with both electronical and physical identification types.
Signing a debit consent can be done with:
- Electronic signature
- Signature performed by Ecster. Parameter identifier should be omitted or have no value set. This will initiate an Ecster hosted electronical signature process where the init call must be followed by subsequent Collect calls to determine the outcome.
- Signature performed by 3rd party. An identification reference must be provided in parameter identifier. No subsequent calls to Collect are needed.
- Physical
- Specifying physical identification types will store signature information on order. No subsequent calls to Collect are needed.
1. Initialize electronic debit consent
Call to begin consumer debit consent signature using an electronic id - BankID or mobile BankID.
POST /v1/orders/rSW0BZRvtwQ0ZZxj3jje/signatures
x-api-key: njdfdsdkjfl5598503mnfkfe
x-merchant-key: 86969769
Content-Type: application/json
{
"signatureType": "DEBIT_CONSENT",
"identification": {
"method": "SE_BANKID_MOBILE",
"identifier": null
}
}The orderId have to be submittet in the url.
2. Handle the response
The response will either be OK or an error code.
The response contains following information:
- id: identifier for this signature. Only returned for electronical identification methods AND identifier NOT provided.
- status: see here for statuses.
- startURL: URL used to activate chosen eid client on consumer’s computer or mobile device. Only relevant when application and eid client reside on same device.
- pollTime: time to wait until next poll, in milliseconds
Status: 201 created
{
"id": "rSW0BZRvtwQ0ZZxj3jje",
"status": "OUTSTANDING_TRANSACTION",
"startURL": "bankid:///?autostarttoken=DUMMY-AUTOSTART",
"pollTime": 5000
}Here we got status OUTSTANDING_TRANSACTION and a poll time at 5000ms and that means we are going to make the collect call to check the status in 5000ms.
3. Collect electronic signature
You make the collect call with the id returned from Initialize electronic debit consent or Collect electronic debit consent.
Call to collect status on the signature process.
GET /v1/orders/rSW0BZRvtwQ0ZZxj3jje/signatures/<signatureId>
x-api-key: njdfdsdkjfl5598503mnfkfe
x-merchant-key: 86969769
Content-Type: application/jsonAll request parameters have to be submittet in the url. No message body should be sent.
4 Handle the response
The response will either be OK or an error code.
The response contains following information:
- id: identifier for this identification.
- status: see here for statuses.
- startURL: URL used to activate chosen eid client on consumer’s computer or mobile device. Only relevant when application and eid client reside on same device.
- pollTime: time to wait until next poll, in milliseconds
Status: 200 OK
{
"id": "v5HjBADhxAcM4QnZR3wS",
"status": "COMPLETE",
"startURL": "bankid:///?autostarttoken=DUMMY-AUTOSTART",
"pollTime": 1500
}