Email-MOTO
This strategy is designed to be used in a MOTO (mail order/telephone order) environment. It works similarly to the Email-Ecommerce strategy and the parameters provided and received are the same. However, this process requires the consumer to perform one step more; after clicking on the email message’s link, the user will be directed to an intermediary screen where it must agree with a disclaimer in order to accomplish the confirmation process. This disclaimer shall be configured directly in your agreement
message available at your confirmation template.
To trigger an Email-Moto 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 |
email_address |
string |
Required | The user’s email that you want to confirm | [email protected] |
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 |
---|---|---|---|
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. States available 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_moto |
confirmation.process.id |
uuid |
Process-specific ID | baa88e8a-300a-4833-b716-48f85251b832 |
confirmation.process.state |
string |
Process-specific state. States available are: idle , generating_token , sending_email , waiting_click , waiting_agreement , finished , failed |
waiting_click |
confirmation.process.email_address |
string |
[email protected] | |
confirmation.process.timeout_seconds |
string |
Time in seconds | 60 |
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=600' \
--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_moto",
"process": {
"id": "df3a192a-33d2-4d98-8e2d-29709c73e840",
"state": "waiting_click",
"email_address": "[email protected]",
"timeout_seconds": 600,
"fail_reason": null,
"user_response": 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",
"executed": null,
"error_message": null
}
]
}
}