Email-Ecommerce

This strategy is used whenever you want to have a simple confirmation of the consumer email’s authenticity. An email will be dispatched for your customer with a confirmation link. Once the customer receives it and clicks in the link, the process will be finished.

To trigger a new confirmation process, you must make an authenticated request by using the following URL.

POST https://confirmation-api.paycertify.com/api/confirmations

Parameter Type Presence Description Example
confirmation_template_id uuid Required A template ID that relates to this confirmation strategy. You must use a confirmation template created for email_ecommerce process type. 63693de5-8a19-4233-b382-c75f0c6b31aa
email_address string Required The user’s email that you want to get confirmed [email protected]
timeout_seconds string Optional Timeout in seconds (default 300 seconds) 600
callback_url string Optional The callback URL http://hooks.my.com/paycertify
card_number string Required The credit card to charge 411111111111111
card_expiry_month string Required The expiration month with two positions 01
card_expiry_year string Required The expiration year with four positions 2021
amount string Required Total transaction amount 3.56
order_description string Required A brief description of the current order Hand pruners And loppers
first_name string Required Customer’s first name John
last_name string Required Customer’s last name Doe
Field Type Description Example
confirmation.id uuid The confirmation ID baa88e8a-300a-4833-b716-48f85251b839
confirmation.created_at datetime Created at date/time 2018-05-12T21:07:59.508Z
confirmation.updated_at datetime Updated at date/time 2018-05-12T21:07:59.508Z
confirmation.state string Status of this confirmation request. The possible states are: idle, processing, confirmed, refused, failed, expired processing
confirmation.callback_url string The provided callback URL http://hooks.my.com/paycertify
confirmation.process_name string The selected process strategy name email_ecommerce
confirmation.process.id uuid Process-specific ID baa88e8a-300a-4833-b716-48f85251b832
confirmation.process.state string Process-specific state. The states available are idle, generating_token, sending_email, waiting_response, finished, failed waiting_response
confirmation.process.email_address string Email [email protected]
confirmation.process.timeout_seconds string Time in seconds 300
confirmation.process.fail_reason string A fail description when process fails Delivery Error
confirmation.process.created_at datetime Process-specific created at date 2018-07-05T14:09:40.106Z
confirmation.process.updated_at datetime Process-specific updated at date 2018-07-05T14:09:40.106Z
confirmation.confirmation_actions.*.id uuid Action ID ce388e8a-300a-4833-b716-48f85251b839
confirmation.confirmation_actions.*.created_at datetime Action created at date 2018-07-05T14:09:40.106Z
confirmation.confirmation_actions.*.action_name string Action name start
confirmation.confirmation_actions.*.actor string Action’s actor merchant
confirmation.confirmation_actions.*.executed string If action is executed or not true
confirmation.confirmation_actions.*.error_message string Error message Delivery Error
curl --request POST \
  --url 'https://confirmation-api.paycertify.com/api/confirmations' \
  --header 'Authorization: Bearer D28A17DFD326A2E255DC4C69C17C2451446A7EC8' \
  --header 'Cache-Control: no-cache' \
  --form 'confirmation_template_id=15be8861-597a-4b7b-a0aa-b7486ba3de7e' \
  --form 'timeout_seconds=300' \
  --form '[email protected]' \
  --form 'card_number=411111111111111' \
  --form 'card_expiry_month=01' \
  --form 'card_expiry_year=2021' \
  --form 'amount=3.56' \
  --form 'order_description=Hand pruners And loppers' \
  --form 'first_name=John' \
  --form 'last_name=Doe' \

Responds with:

{
  "confirmation": {
    "id": "ca8d77c9-4477-4f48-bbea-9bc52264e74d",
    "created_at": "2018-07-05T14:09:40.098Z",
    "updated_at": "2018-07-05T14:09:40.110Z",
    "state": "processing",
    "callback_url": null,
    "process_name": "email_ecommerce",
    "process": {
        "id": "df3a192a-33d2-4d98-8e2d-29709c73e840",
        "state": "waiting_response",
        "email_address": "[email protected]",
        "timeout_seconds": 60,
        "fail_reason": null,
        "created_at": "2018-07-05T14:09:40.092Z",
        "updated_at": "2018-07-05T14:09:40.137Z"
    },
    "confirmation_actions": [
        {
            "id": "d198c09a-6713-4fa3-ba75-187a409bf2b5",
            "created_at": "2018-07-05T14:09:40.106Z",
            "action_name": "start",
            "actor": "merchant",
            "parameters": {
                "email_address": "[email protected]",
                "timeout_seconds": "60"
            },
            "executed": null,
            "error_message": null
        }
    ]
  }
}