/mail_order | Sipay Developers

Payment with Multiple Methods

POST /moto/api/v1/mail_order

Pay By Link allows to pay with multiple payment methods.

Request

Payload (object)

operation_type (enum[string]): Defines the type of operation. To perform a payment, the value of the field must be sell.
operation_properties:
- backend (string): Indicates that multiple payment methods are to be displayed. The value of the field must be pwall.
- checkmode (enum[string]): DEFAULT = "3ds"
  
  Parameter Description
  3ds Sale with authentication.
  none Sale without authentication.
- expiration (integer): DEFAULT = 2592000 (30 days). Validity (in seconds) of the link from when it is sent to the user.
- result_interactive (boolean): DEFAULT = true. True if an intermediate results page is used.
- url_callback (string, required): URL for capturing responses from the Sipay Plus internal API.
- payment_details_template (object, required): Definition of fields for rendering the form.
  - title (string, required): Title of the webpage containing the form.
  - description (string, required): Description that the user will see above the form.
  - logo_url (string, required): Link to the image with the desired logo.
notification_templates (array, required): Contains email and SMS templates.
- type (enum[string], required): Type of message to define.
  
  Parameter Description
  data_request For the template that will be sent informing that there is a pending operation.
- transport (enum[string], required): Communication channel.
  
  Parameter Description
  mail Send the notification only by email.
  sms Send the notification only by SMS.
- data (object, required): Contains fields for the email subject (subject) and body of the email (body) and SMS (text).
  - subject (string, required): For transport mail, subject of the email to be sent to the customer.
  - body (string, required): For transport mail, body of the email to be sent to the customer.
  - text (string, required) For transport sms, body of the SMS to be sent to the customer.
message_recipients (array, required): Container of users and parameters that define a request. These parameters can be used in request messages or on payment screens.
- full_name (string, required): User's name.
- email (string, required): User's email address.
- phone_number (string, required): User's mobile phone number, always including the extension.
- order (string, required): Operation ticket.
- amount (string, required): Fixed amount of the operation in cents.
- currency (string, required): Currency used in the operation. ISO 4217 three-letter code.
- datetime (string, required): Date and time of the operation.
- client (string, required): Name of the merchant making the operation.
- reconciliation (string): Identifier for bank reconciliation. Restrictions: can contain up to 255 alphanumeric characters. Example: "1234-sipay".
- preferred_transport (enum[string]): Indicates the default delivery channel for a specific user. Possible values are:
  
  Parameter Description
  SMS Send the notification only by SMS.
  mail Send the notification only by email.
- notify_on_creation (boolean): false to generate a link without sending the notification.
- notification_datetime (string): Date and time at which to send the notification. Example format: ""2021-06-11T10:14:00Z". If a date earlier than the current one is sent, the notification will be sent immediately.
- notification_templates (array): By re-specifying the type, transport, and the fields of the data, it is possible to customize the messages to be sent for a specific user.
- product_description (string, optional): Description of the product that will appear in the payment template.
- product_title (string, optional): Name of the product that will appear in the payment template.

Parameter	Description
3ds	Sale with authentication.
none	Sale without authentication.

Parameter	Description
data_request	For the template that will be sent informing that there is a pending operation.

Parameter	Description
mail	Send the notification only by email.
sms	Send the notification only by SMS.

Parameter	Description
SMS	Send the notification only by SMS.
mail	Send the notification only by email.

Response

The response will have two possible formats depending on the value of notify_on_creation defined in the request. In the examples, a response of each is added.

Request with notify_on_creation=true

Payload (object)

order_uuid_map (object): Object that will contain the link to process the payment.
- order_operation
real_uuid_map (object): Object that will contain the operation identifier for future operations.
- order_operation
errors (object):

Request with notify_on_creation=false

Payload (object)

order_uuid_map (object):
- order_operation(array) Array that will contain the link to process the payment and the operation identifier for future operations.
real_uuid_map (object): Empty.
errors (object):

Examples

Payment with Multiple Methods Example

Request

{
  "key": "{{key}}",
  "nonce": "{{nonce}}",
  "mode": "sha256",
  "resource": "{{resource}}",
  "payload": {
    "operation_type": "sell",
    "operation_properties": {
      "backend": "pwall",
      "expiration": 121313123123,
      "ko_redirect": true,
      "url_callback": "https://endqq52hn9wkxzt.m.pipedream.net",
      "url_ko": "https://endqq52hn9wkxzt.m.pipedream.net/ko",
      "url_result": "https://endqq52hn9wkxzt.m.pipedream.net/ok",
      "payment_details_template": {
        "title": "Pwall_Test",
        "description": "Custom description",
        "logo_url": "https://www.sipay.es/wp-content/uploads/Recurso-2@2x.png"
      }
    },
    "notification_templates": [
      {
        "type": "data_request",
        "transport": "mail",
        "data": {
          "body": "<html><head><b>Dear {{full_name}}</b>,</head><br><br>We inform you that the payment will be made through the Sipay platform.<br>To do this, on {{datetime}} a payment link with ticket {{ticket_number}} has been generated that allows you to pay {{amount}} {{currency}} securely (complying with International PCI-DSS Regulations) through various payment methods. When opening it, you must select the payment method and continue with the process.<br>This link will be active for 24 hours.<br>To manage your payment, click on the following link:<br>{{link}}<br>Once confirmed by our banking entity, you will receive the receipt at your email address.<br>Do not reply to this email. If you need more information, find the link expired or have any problems with it, contact support@cliente.es or at www.cliente-web.es.<br>Thank you for your trust in {{client}}.<br>Accounting and Working Capital Department.<br><br></html>",
          "subject": "Payment template"
        }
      },
      {
        "type": "data_request",
        "transport": "sms",
        "data": {
          "text": "Dear {{full_name}},\nWe inform you that the payment will be made through the following link: {{link}}"
        }
      }
    ],
    "message_recipients": [
      {
        "full_name": "Customer Name",
        "email": "customer_email@mail.com",
        "notify_on_creation": true,
        "phone_number": "",
        "order": "example_documentation_multiple_payment_methods",
        "amount": 1000,
        "currency": "EUR",
        "datetime": "31/01/2022 09:00",
        "client": "Sipay",
        "preferred_transport": "mail"
      }
    ]
  }
}

Response with notification sent

{
  "type": "app.status",
  "code": "0",
  "detail": "Success",
  "payload": {
    "order_uuid_map": {
      "ejemplo_documentacion_varios_metodos_de_pago": "https://sandbox.sipay.es/s/mm2at4"
    },
    "real_uuid_map": {
      "ejemplo_documentacion_varios_metodos_de_pago": "1a283efc-e0d6-11ec-b3ab-0242ac110024"
    },
    "errors": {}
  },
  "request_id": "6295fe0efca3a4d8081e6478",
  "uuid": "6295fe0efca3a4d8081e6478"
}

Response generating only the link

{
  "type": "app.status",
  "code": "0",
  "detail": "Success",
  "payload": {
    "order_uuid_map": {
      "ejemplo_documentacion_varios_metodos_de_pago": [
        "e61fa602-e1b3-11ec-b3ab-0242ac110024",
        "https://sandbox.sipay.es/s/m4djt2"
      ]
    },
    "real_uuid_map": {},
    "errors": {}
  },
  "request_id": "6297722bfca3a4d8081e6618",
  "uuid": "6297722bfca3a4d8081e6618"
}

Callback response example

"body": {
  "amount": "0",
  "approval": "516587",
  "authorizator": "CAIXABANK, S.A.",
  "card_brand": "VISA",
  "card_country": "undefined",
  "card_mask": "4548 81** **** 0004",
  "card_trade": "undefined",
  "card_type": "undefined",
  "code": "0",
  "cof_id": "792022152040232",
  "currency": "EUR",
  "expiration": "null",
  "expired_at": "2023-10-31",
  "masked_card": "4548 81** ****0004",
  "order": "ejemplo_documentacion_varios_metodos_de_pago",
  "reconciliation": "",
  "request_id": "920f6934-e1a5-11ec-b3ab-0242ac110024",
  "transaction_id": "000027346264324827822",
  "type": "success"
}

Payment with Card + Tokenization

POST /moto/api/v1/mail_order

Pay By Link allows for payments using a card and its tokenization.

Request

Payload (object)

operation_type (enum[string]): Defines the type of operation. For a sale, it must be sell.
operation_properties:
- tokenize (boolean, required): True if the card should be tokenized.
- checkmode (enum[string]): DEFAULT = "3ds"
  
  Parameter Description
  3ds Sale with authentication.
  none Sale without authentication.
- expiration (integer): DEFAULT = 2592000 (30 days). Validity (in seconds) of the link, starting from when it is sent to the user.
- result_interactive (boolean): DEFAULT = true. True if an intermediate results page is used.
- ko_redirect (boolean): True to activate specific redirection in case of failure, via url_ko.
- url_callback (string, required): URL for capturing responses from the internal Sipay Plus API.
- url_ko (): URL for redirection after an erroneous process completion.
- url_result (): URL for redirection after the process completion.
- payment_details_template (object, required): Definition of fields for rendering the form.
  - title (string, required): Title of the webpage containing the form.
  - description (string, required): Description that the user will see above the form.
  - logo_url (string, required): Link to the desired logo image.
  - button (string, required): Text of the button to be pressed when submitting the form.
  - msg_result_ok (string): Message to display on the intermediate results screen if the operation was successful.
  - msg_result_ko (string): Message to display on the intermediate results screen if the operation failed.

Parameter	Description
3ds	Sale with authentication.
none	Sale without authentication.

notification_templates (array, required): Contains email and SMS templates.

type (enum[string], required): Type of message to define.

Parameter	Description
data_request	For the template to be sent informing of a pending operation.
data_result_ok	For the template to be sent if the operation was successful.
data_result_ko	For the template to be sent if the operation failed.

transport (enum[string], required): Communication channel.

Parameter Description
mail Send the notification only by email.
sms Send the notification only by SMS.
data (object, required): Contains fields for the email subject (subject) and email body (body) and SMS (text).
- subject (string, required): For transport mail, subject of the email to be sent to the client.
- body (string, required): For transport mail, body of the email to be sent to the client.
- text (string, required) For transport SMS, body of the SMS to be sent to the client.

message_recipients (array, required): Container of users and parameters that define a request. These parameters can be used in request messages or on payment screens.
- full_name (string, required): User's name.
- email (string, required): User's email address.
- phone_number (string, required): User's mobile phone number, always including the extension.
- order (string, required): Ticket of the operation.
- amount (string, required): Fixed amount of the operation in cents.
- currency (string, required): Currency used in the operation. ISO 4217 three-letter code.
- datetime (string, required): Date and time of the operation.
- client (string, required): Name of the business conducting the operation.
- token (string): Required if tokenize is true. Name of the token to be created.
- reconciliation (string): Identifier for bank reconciliation. Restrictions: can contain up to 255 alphanumeric characters. Example: "1234-sipay".
- custom (object): Customizable fields. This field will be rendered in the form and can also be used in the messages to be sent. Up to 5 such fields are available.
  - custom1 (string):
  - custom2 (string):
  - custom3 (string):
  - custom4 (string):
  - custom5 (string):
- preferred_transport (enum[string]): Indicates the default sending channel for a specific user. Possible values are:
  
  Parameter Description
  SMS Send the notification only via SMS.
  mail Send the notification only via email.
- notify_on_creation (boolean): false to generate a link without sending the notification.
- notification_datetime (string): Date and time when the notification should be sent. Example format: "2021-06-11T10:14:00Z". If a date earlier than the current one is sent, the notification will be sent immediately.
- notification_templates (array): By re-specifying the type, transport, and fields in the data, it is possible to customize the messages to be sent to a specific user.

Parameter	Description
mail	Send the notification only by email.
sms	Send the notification only by SMS.

Parameter	Description
SMS	Send the notification only via SMS.
mail	Send the notification only via email.

Response

The response will have two possible formats, depending on the value of notify_on_creation defined in the request. Each example includes a response for each case.

Request with notify_on_creation=true

Payload (object)

order_uuid_map (object): Object that will contain the link to process the payment.
- order_operation
real_uuid_map (object): Object that will contain the identifier of the operation for future operations.
- order_operation
errors (object):

Request with notify_on_creation=false

Payload (object)

order_uuid_map (object):
- order_operation (array) Array that will contain the link to process the payment and the identifier of the operation for future operations.
real_uuid_map (object): Empty.
errors (object):

Examples

Payment + Tokenization example

Request

{
  "key": "{{key}}",
	"nonce": "{{nonce}}",
	"mode": "sha256",
	"resource": "{{resource}}",
	"payload": {
		"operation_type": "sell",
		"operation_properties":
			{
				"tokenize": true ,
				"checkmode": "3ds",
				"expiration": 3999999,
				"result_interactive": true,
				"url_callback": "https://en9a2kjo69pp7r6.m.pipedream.net",
				"url_result": "http://httpbin.org/get?type=ok",
        "url_ko":"http://httpbin.org/get?type=ko",
				"payment_details_template": {
					"title": "Process payment test",
					"description": "Complete your card details",
					"logo_url": "https://sipay.es/wp-content/uploads/logo@0.75x.png",
					"button": "Pay test",
					"msg_result_ok": "Everything went well :)",
					"msg_result_ko": "Something went wrong :("
				}
			},
		"notification_templates":  [
			{
				"type": "data_request",
				"transport": "mail",
				"data": {
					"body": "<html><head><b>Apreciado/a {{full_name}}</b>,</head><br><br>We inform you that the payment for your purchase receipt will be processed through the Sipay platform.<br><br>For this, a payment link with ticket {{ticket_number}} has been generated as of {{datetime}}, allowing you to pay {{amount}} {{currency}} securely (in compliance with International PCI-DSS Regulations) through your debit/credit card. When you open it, you will need to enter the details related to the card number, expiration date, and CVV.<br><br>This link will be active for 24 hours.<br><br>To manage your payment, click on the following link:<br><br>{{link}}<br><br>Once the payment is confirmed by our bank, you will receive the receipt at your email address.<br><br>Please do not reply to this email. If you need more information, find the link expired or have any issues with it, contact us at soporte@cliente.es or visit www.cliente-web.es.<br><br>We appreciate your trust.<br><br>Best regards.<br><br><html>",
					"subject": "Payment template"
				}
			},
			{
				"type": "data_result_ok",
				"transport": "mail",
				"data": {
					"body": "Dear {{full_name}},<br><br>We inform you that the payment has been successful.<br><br>We appreciate your trust in {{client}}.",
					"subject": "Payment Result"
				}
			},
			{
				"type": "data_result_ko",
				"transport": "mail",
				"data": {
					"body": "Dear {{full_name}},<br><br>We inform you that the payment has been successful.<br><br>We appreciate your trust in {{client}}.",
					"subject": "Payment Result"
				}
			},
			{
				"type": "data_request",
				"transport": "sms",
				"data": {
					"text": "Dear {{full_name}},\nWe inform you that the payment for your purchase receipt will be processed through the following link: {{link}}"
				}
			},
			{
				"type": "data_result_ok",
				"transport": "sms",
				"data": {
					"text": "Dear {{full_name}},\nWe inform you that the payment has been successful.\nWe appreciate your trust in {{client}}."
				}
			},
			{
				"type": "data_result_ko",
				"transport": "sms",
				"data": {
					"text": "Dear {{full_name}},\nWe inform you that the payment has failed.."
				}
			}
		],
		"message_recipients": [
			{
				"full_name": "Client Name",
				"email": "mail_client@mail.es",
				"phone_number": "XXXXXXXXXXX",
        "notify_on_creation":true,
        "notification_datetime":"2022-06-01T00:00:00Z",
				"order": "example_docs_card_tokenization",
				"amount": 1,
				"currency": "EUR",
        "reconciliation": "SipayQA",
				"datetime": "31/01/2022 08:00",
				"client": "Sipay Plus",
        "token" : "token_example_docs"
				"custom": {
					"custom1":"<b>Poliza</b>: test",
					"custom5":"<b>Poliza</b>: test"
				},
				"preferred_transport": "mail",
				"notification_templates": [
                    {
					"type": "data_request",
					"transport": "mail",
					"data": {
						"subject": "replacement request. Payment link: {{link}}",
						"body": "replacement body.Payment link: {{link}}"
					}
				},
                {
					"type": "data_result_ok",
					"transport": "mail",
					"data": {
						"subject": "replacement subject OK",
						"body": "replacement body OK"
					}
				},
				{
					"type": "data_result_ko",
					"transport": "mail",
					"data": {
						"subject": "replacement subject KO",
						"body": "replacement body KO"
					}
				}]
			}
		]
	}
}

Response with notification sent

{
  "type": "app.status",
  "code": "0",
  "detail": "Success",
  "payload": {
    "order_uuid_map": {
      "ejemplo_documentacion_tarjeta_tokenizacion": "https://sandbox.sipay.es/s/mm2at4"
    },
    "real_uuid_map": {
      "ejemplo_documentacion_tarjeta_tokenizacion": "1a283efc-e0d6-11ec-b3ab-0242ac110024"
    },
    "errors": {}
  },
  "request_id": "6295fe0efca3a4d8081e6478",
  "uuid": "6295fe0efca3a4d8081e6478"
}

Response generating only the link

{
  "type": "app.status",
  "code": "0",
  "detail": "Success",
  "payload": {
    "order_uuid_map": {
      "ejemplo_documentacion_tarjeta_tokenizacion": [
        "e61fa602-e1b3-11ec-b3ab-0242ac110024",
        "https://sandbox.sipay.es/s/m4djt2"
      ]
    },
    "real_uuid_map": {},
    "errors": {}
  },
  "request_id": "6297722bfca3a4d8081e6618",
  "uuid": "6297722bfca3a4d8081e6618"
}

Response callback example

  "body": {
    "amount": "0",
    "approval": "516587",
    "authorizator": "CAIXABANK, S.A.",
    "card_brand": "VISA",
    "card_country": "undefined",
    "card_mask": "4548 81** **** 0004",
    "card_trade": "undefined",
    "card_type": "undefined",
    "code": "0",
    "cof_id": "792022152040232",
    "currency": "EUR",
    "expiration": "null",
    "expired_at": "2023-10-31",
    "masked_card": "4548 81** ****0004",
    "order": "example_docs_card_tokenization",
    "reconciliation": "",
    "request_id": "920f6934-e1a5-11ec-b3ab-0242ac110024",
    "token": "token_example_docs",
    "transaction_id": "000027346264324827822",
    "type": "success"
}

Pay with Token

POST /moto/api/v1/mail_order

Pay By Link allows for charging with a card and its tokenization.

Request

Payload (object) This will be similar to the card payment payload but with the following modifications:

operation_type: To make a sale through a token, it must be sell_stored_token.
It is not necessary to include the tokenize attribute.
The value of token must be from an existing token.

Response

Payload (object)

order_uuid_map (object): Object that will contain the link to process the payment.
- order_operation
real_uuid_map (object): Object that will contain the identifier of the operation for future operations.
- order_operation
errors (object):

Example

Sale through a Token

Request

{
  "key": "{{key}}",
  "nonce": "{{nonce}}",
  "mode": "sha256",
  "resource": "{{resource}}",
  "payload": {
    "operation_type": "sell_stored_token",
    "operation_properties": {
      "tokenize": false,
      "checkmode": "3ds",
      "expiration": 2592000,
      "result_interactive": true,
      "url_callback": "https://en9a2kjo69pp7r6.m.pipedream.net",
      "url_result": "http://httpbin.org/get?type=ok",
      "url_ko": "http://httpbin.org/get?type=ko",
      "payment_details_template": {
        "title": "Pay with stored token test",
        "description": "Check your card details",
        "logo_url": "https://sipay.es/wp-content/uploads/logo@0.75x.png",
        "button": "Renew test",
        "msg_result_ok": "Everything went well :)",
        "msg_result_ko": "Something went wrong :("
      }
    },
    "notification_templates": [
      {
        "type": "data_request",
        "transport": "mail",
        "data": {
          "body": "<html><head><b>Dear {{full_name}}</b>,</head><br><br>We inform you that the payment for your purchase receipt will be processed through the Sipay platform.<br><br>For this, on {{datetime}}, a payment link with ticket {{ticket_number}} has been generated, allowing you to pay {{amount}} {{currency}} securely (complying with the PCI-DSS International Standards) through your debit/credit card. Upon opening it, you will need to confirm your purchase.<br><br>This link will be active for 24 hours.<br><br>To manage your payment, click the following link:<br><br>{{link}}<br><br>Once the payment is confirmed by our banking entity, you will receive the receipt at your email address.<br><br>Please do not reply to this email. If you need more information, find the link expired, or have any issues with it, contact support@cliente.es or visit www.cliente-web.es.<br><br>Thank you for your trust.<br><br>Best regards.<br><br><html>",
          "subject": "Payment Template"
        }
      },
      {
        "type": "data_result_ok",
        "transport": "mail",
        "data": {
          "body": "Dear {{full_name}},<br><br>We inform you that the payment has been successfully processed.<br><br>Thank you for your trust in {{client}}.",
          "subject": "Payment Result"
        }
      },
      {
        "type": "data_result_ko",
        "transport": "mail",
        "data": {
          "body": "Dear {{full_name}},<br><br>We inform you that the payment update has failed.<br><br>Thank you for your trust in {{client}}.",
          "subject": "Payment Result"
        }
      },
      {
        "type": "data_request",
        "transport": "sms",
        "data": {
          "text": "Dear {{full_name}},\nWe inform you that the payment for your purchase receipt will be processed through the following link: {{link}}"
        }
      },
      {
        "type": "data_result_ok",
        "transport": "sms",
        "data": {
          "text": "Dear {{full_name}},\nWe inform you that the payment has been successfully processed.\nThank you for your trust in {{client}}."
        }
      },
      {
        "type": "data_result_ko",
        "transport": "sms",
        "data": {
          "text": "Dear {{full_name}},\nWe inform you that the payment has failed."
        }
      }
    ],
    "message_recipients": [
      {
        "full_name": "Client Name",
        "email": "mail_client@mail.com",
        "phone_number": "XXXXXXXXXXX",
        "order": "token_documentation_example",
        "amount": 20,
        "currency": "EUR",
        "notify_on_creation": true,
        "notification_datetime": "2022-01-31T09:00:00Z",
        "token": "token_documentation_example",
        "datetime": "2021-02-29T19:12:00",
        "client": "Sipay Plus",
        "reconciliation": "SipayQA",
        "custom": {
          "custom1": "<b>Policy</b>: test",
          "custom5": "<b>Policy</b>: test"
        },
        "preferred_transport": "mail",
        "notification_templates": [
          {
            "type": "data_result_ok",
            "transport": "mail",
            "data": {
              "subject": "replacement subject OK",
              "body": "replacement body"
            }
          },
          {
            "type": "data_result_ko",
            "transport": "mail",
            "data": {
              "subject": "replacement subject KO",
              "body": "replacement body"
            }
          }
        ]
      }
    ]
  }
}

Response

{
  "type": "app.status",
  "code": "0",
  "detail": "Success",
  "payload": {
    "order_uuid_map": {
      "ejemplo_documentacion_token": "https://sandbox.sipay.es/s/mr55j3"
    },
    "real_uuid_map": {
      "ejemplo_documentacion_token": "9fdf03de-e183-11ec-b3ab-0242ac110024"
    },
    "errors": {}
  },
  "request_id": "6297212dfca3a4d8081e6588",
  "uuid": "6297212dfca3a4d8081e6588"
}

Update a Token

POST /moto/api/v1/mail_order

Request

Payload (object)

operation_type (enum[string]): Defines the type of operation. To update a token, it must be store_token.
operation_properties (object): Definition of the fields for the logic of the call.
- checkmode (enum[string]): DEFAULT = "3ds".
  
  Parameter Description
  3ds Sale with authentication.
  none Sale without authentication.
- expiration (integer): DEFAULT = 2592000 (30 days). Validity (in seconds) of the link, from the time it is sent to the user.
- result_interactive (boolean): DEFAULT = true. True if an intermediate results page is used.
- ko_redirect (boolean): True to enable specific redirection in case of failure, using url_ko.
- url_callback (string, required): URL for capturing responses from Sipay Plus's internal API.
- url_ko (string): URL to redirect to after an unsuccessful completion of the process.
- url_result (string): URL to redirect to after the completion of the process.
- payment_details_template (object, required): Definition of the fields for rendering the form.
  - title (string, required): Title of the webpage containing the form.
  - description (string, required): Description the user will see above the form.
  - logo_url (string, required): Link to an image with the desired logo.
  - button (string, required): Text of the button to be pressed when submitting the form.
  - msg_result_ok (string): Message to display on the intermediate results screen if the operation was successful.
  - msg_result_ko (string): Message to display on the intermediate results screen if the operation failed.

Parameter	Description
3ds	Sale with authentication.
none	Sale without authentication.

notification_templates (array, required): contains email and SMS templates.

type (enum[string], required): Type of message to define.

Parameter	Description
data_request	For the template to be sent informing that a pending operation exists.
data_result_ok	For the template to send if the operation was successful.
data_result_ko	For the template to send if the operation failed.

transport (enum[string], required): Communication channel.

Parameter Description
mail Send notification only via email.
sms Send notification only via SMS.
data (object): Contains fields for the email subject (subject) and email body (body) and SMS (text).
- subject (string, required): For transport mail, the subject of the email to be sent to the client.
- body (string, required): For transport mail, the body of the email to be sent to the client.
- text (string, required) For transport sms, the body of the SMS to be sent to the client.

message_recipients (array): Container of users and parameters that define a request. These parameters can be used in request messages or payment screens.
- full_name (string, required): User's name.
- email (string, required): User's email address.
- phone_number (string, required): User's mobile phone number, always including the extension.
- order (string, required): Operation ticket.
- amount (string, required): Must be equal to "0".
- currency (string): DEFAULT = EUR. Currency used in the operation. ISO 4217 code of three letters.
- datetime (string): Date and time of the operation.
- client (string, required): Name of the merchant executing the operation.
- token (string, required): Name of the token to update.
- reconciliation (string): Identifier for bank reconciliation. Restrictions: can contain up to 255 alphanumeric characters. Example: "1234-sipay".
- custom (object): Customizable fields. This field will be rendered in the form and can also be used in messages to be sent. Up to 5 fields of this type are available.
  - custom1 (string):
  - custom2 (string):
  - custom3 (string):
  - custom4 (string):
  - custom5 (string):
- preferred_transport (enum[string]): Indicates the default sending channel for a specific user. Possible values are:
  
  Parameter Description
  SMS Send notification only via SMS.
  mail Send notification only via email.
- notify_on_creation (boolean): false to generate a link without sending the notification.
- notification_datetime (string): Date and time when the notification is to be sent. Example format: ""2021-06-11T10:14:00Z" If a date earlier than the current date is sent, the notification will be sent immediately.
- notification_templates (array): By re-specifying the type, transport, and the fields of the data, it is possible to customize the messages sent to a specific user.

Parameter	Description
mail	Send notification only via email.
sms	Send notification only via SMS.

Parameter	Description
SMS	Send notification only via SMS.
mail	Send notification only via email.

Response

Payload (object)

order_uuid_map (object): Object that will contain the link to process the payment.
- order_operation
real_uuid_map (object): Object that will contain the identifier of the operation for future operations.
- order_operation
errors (object):

Examples

Update a Token

Request:

{
  "key": "{{key}}",
  "nonce": "1578911858712",
  "mode": "sha256",
  "resource": "{{resource}}",
  "payload": {
    "operation_type": "store_token",
    "operation_properties": {
      "checkmode": "3ds",
      "expiration": 2592000,
      "result_interactive": true,
      "url_callback": "https://en9a2kjo69pp7r6.m.pipedream.net",
      "url_result": "http://httpbin.org/get?type=ok",
      "url_ko": "http://httpbin.org/get?type=ko",
      "payment_details_template": {
        "title": "Renew the test card",
        "description": "Enter your card details",
        "logo_url": "https://sipay.es/wp-content/uploads/logo@0.75x.png",
        "button": "Renew test",
        "msg_result_ok": "Everything went well :)",
        "msg_result_ko": "Something went wrong :("
      }
    },
    "notification_templates": [
      {
        "type": "data_request",
        "transport": "mail",
        "data": {
          "body": "<html><head><b>Dear {{full_name}}</b>,</head><br><br>We inform you that the payment method update will be processed through the Sipay platform.<br><br>To do this, a link has been generated on {{datetime}} with ticket {{ticket_number}} that allows you to securely update your payment method (in compliance with PCI-DSS International Regulations). When opened, you will need to enter the details regarding the new card number, expiration date, and CVV.<br><br>This link will be active for 24 hours.<br><br>To manage your payment, click on the following link:<br><br>{{link}}<br><br>Once the payment is confirmed by our bank, you will receive the receipt at your email address.<br><br>Please do not reply to this email. If you need more information, find the link expired or have any problems with it, contact support@cliente.es or at www.cliente-web.es.<br><br>We thank you for your trust.<br><br>Best regards.<br><br><html>",
          "subject": "Payment Template"
        }
      },
      {
        "type": "data_result_ok",
        "transport": "mail",
        "data": {
          "body": "Dear {{full_name}},<br><br>We inform you that the payment has been successfully processed.<br><br>We appreciate your trust in {{client}}.",
          "subject": "Payment Result"
        }
      },
      {
        "type": "data_result_ko",
        "transport": "mail",
        "data": {
          "body": "Dear {{full_name}},<br><br>We inform you that the payment method update has failed.<br><br>We appreciate your trust in {{client}}.",
          "subject": "Payment Result"
        }
      },
      {
        "type": "data_request",
        "transport": "sms",
        "data": {
          "text": "Dear {{full_name}},\nWe inform you that the update of your payment method will be processed through the following link: {{link}}"
        }
      },
      {
        "type": "data_result_ok",
        "transport": "sms",
        "data": {
          "text": "Dear {{full_name}},\nWe inform you that the update of your payment method has been successfully completed.\nWe appreciate your trust in {{client}}."
        }
      },
      {
        "type": "data_result_ko",
        "transport": "sms",
        "data": {
          "text": "Dear {{full_name}},\nWe inform you that the update of your payment method has failed."
        }
      }
    ],
    "message_recipients": [
      {
        "full_name": "Client Name",
        "email": "mail_client@mail.es",
        "phone_number": "XXXXXXXXXXX",
        "amount": 0,
        "currency": "EUR",
        "order": "example_docs_update_token",
        "token": "token_example_docs",
        "datetime": "29/02/2021 09:12",
        "client": "Sipay Plus",
        "custom": {
          "custom1": "<b>Customizable1</b>: test",
          "custom5": "<b>Customizable2</b>: test"
        },
        "preferred_transport": "mail"
      }
    ]
  }
}

Response:

{
  "type": "app.status",
  "code": "0",
  "detail": "Success",
  "payload": {
    "order_uuid_map": {
      "ejemplo_documentacion_actualizar_token": "https://sandbox.sipay.es/s/myq3ck"
    },
    "real_uuid_map": {
      "ejemplo_documentacion_actualizar_token": "b830f426-e262-11ec-b3ab-0242ac110024"
    },
    "errors": {}
  },
  "request_id": "62989778fca3a4d8081e67b0",
  "uuid": "62989778fca3a4d8081e67b0"
}

Payment with Multiple Methods​

Request​

Response​

Examples​

Payment with Multiple Methods Example​

Payment with Card + Tokenization​

Request​

Response​

Examples​

Pay with Token​

Request​

Response​

Example​

Update a Token​

Request​

Response​

Examples​

Payment with Multiple Methods

Request

Response

Examples

Payment with Multiple Methods Example

Payment with Card + Tokenization

Request

Response

Examples

Pay with Token

Request

Response

Example

Update a Token

Request

Response

Examples