Phone-Ecommerce

This confirmation strategy is similar to Email-Ecommerce strategy. However, it targets to confirm the consumer’s phone number through an sms message instead of an email message. SMS message templates shall be interpreted as plain-text messages, which means that HTML tags won’t be rendered correctly. URLs in the SMS body are usually transformed into clickable links by the mobile device itself.

It worths to say that all the links received in the SMS-based processes are shortened with our safe and proprietary url-shortener service (links are rendered as https://pcer.co/{UNIQUE_TOKEN}).

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. 63693de5-8a19-4233-b382-c75f0c6b31aa
phone_number string Required The user’s phone number that you want to confirm (in E.164 format) +11231231234
timeout_seconds string Optional Timeout in seconds (default 60 seconds) 90
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 template 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. States available are: idle, processing, confirmed, confirmation.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 phone_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_sms, waiting_token, finished, failed sending_sms
phone_number string The user’s phone number that you want to confirm (in E.164 format) +11231231234
confirmation.process.timeout_seconds string Time in seconds 60
confirmation.process.fail_reason string Status of this template  
confirmation.process.merchant_id uuid The UUID of merchant 48a872f9-9389-4047-be85-a38d291e62b3
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 Status of this template  
confirmation.confirmation_actions.*.created_at datetime Status of this template 2018-07-05T14:09:40.106Z
confirmation.confirmation_actions.*.action_name string Status of this template  
confirmation.confirmation_actions.*.actor string Status of this template  
confirmation.confirmation_actions.*.executed string Status of this template  
confirmation.confirmation_actions.*.error_message string Status of this template  
curl --request POST \
  --url 'https://confirmation-api.paycertify.com/api/confirmations' \
  --header 'Authorization: Bearer D28A17DFD326A2E255DC4C69C17C2451446A7EC8' \
  --header 'Cache-Control: no-cache' \
  --form 'confirmation_template_id=a37e67e4-af37-4ebf-af48-80ffade48c4b' \
  --form 'phone_number=+5531992274225' \
  --form 'timeout_seconds=540' \
  --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": "3c86e137-1e59-4af5-bf9d-8f6b2970d4f9",
    "created_at": "2018-07-05T14:55:36.171Z",
    "updated_at": "2018-07-05T14:55:36.183Z",
    "state": "processing",
    "callback_url": null,
    "process_name": "phone_ecommerce",
    "process": {
        "id": "e8ef69e8-c50d-41ce-b306-a281217cb024",
        "state": "waiting_token",
        "phone_number": "+5531992274225",
        "timeout_seconds": 540,
        "fail_reason": null,
        "merchant_id": "48a872f9-9389-4047-be85-a38d291e62b3",
        "created_at": "2018-07-05T14:55:36.165Z",
        "updated_at": "2018-07-05T14:55:39.947Z"
    },
    "confirmation_actions": [
        {
            "id": "152283ba-3959-4871-8f87-2a246995c17f",
            "created_at": "2018-07-05T14:55:36.179Z",
            "action_name": "start",
            "actor": "merchant",
            "parameters": {
                "phone_number": "+5531992274225",
                "timeout_seconds": "540"
            },
            "executed": null,
            "error_message": null
        }
    ]
  }
}