Payment page

Allows you to login to an Easytransac payment page dedicated to a single secure payment.

Our hosted payment page is the ideal solution for offering your customers online payments on your ecommerce site. It combines great versatility with minimal requirements. Your PCI-DSS constraints are very low, Easytransac handles the processing of sensitive data.

Request

Body Params application/x-www-form-urlencoded

Amount

number

required

Transaction amount in cents

ClientIp

string

required

Customer IP address

string

optional

The customer's email address associated with the payment

SendEmail

enum<string>

optional

Sends an email with the link to the payment page directly to the customer (no by default)

Allowed values:

yesno

SendSMS

enum<string>

optional

Sends an SMS with the link to the payment page directly to the customer (no by default)

Allowed values:

yesno

3DS

enum<string>

optional

Use 3DSecure or not (enabled by default).

Allowed values:

yesno

OrderId

number

optional

Your unique transaction identifier (or order number)

Description

number

optional

Description of the transaction (use \n to make a line break)

AskAmount

enum<string>

optional

Leave the amount free, the end customer will have to enter it

Allowed values:

yesno

AskInvoiceNumber

enum<string>

optional

Force entry of the invoice number

Allowed values:

yesno

PreAuth

enum<string>

optional

For a card payment; make a pre-authorization only, the payment must be completed via the webservice "capture".

Allowed values:

yesno

PreAuthDuration

number

optional

For a card payment; duration of reservation of an amount during a pre-authorization, in days (1 to 6)

SaveCard

enum<string>

optional

Save the card for future use

Allowed values:

yesno

B2B

enum<string>

optional

For a direct debit only, in B2B mode it will not be contestable by the customer
This mode is only used to manage the collection of payments between companies. It does not apply to individuals or self-employed persons

Allowed values:

yesno

SendLater

string <YYY-MM-DD>

optional

The payment page is sent later by email or SMS

OperationType

enum<string>

optional

Transaction category (credit card payment, SDD direct debit or bank transfer)

Allowed values:

paymentdebitpaybybank

ReturnUrl

string

optional

URL to which the customer is redirected once the payment is made
The status of the transaction is systematically returned in POST on this return URL

CancelUrl

string

optional

URL to which the customer is redirected after clicking on "Abort"
The status of the transaction is returned in POST on this URL

ReturnMethod

enum<string>

optional

The ReturnUrl parameter passing is by default in POST, you can force it in GET
Only the "essential" parameters are returned in this case

Allowed values:

GETPOST

ClientId

string

optional

Unique Easytransac customer identifier (if you have already made a payment for this customer)

Uid

string

optional

Your customer unique identifier

Firstname

string

optional

Customer's first name

Lastname

string

optional

Customer's last name

Address

string

optional

Customer's address

ZipCode

string

optional

Customer's postal code

City

string

optional

Customer's city

Country

string

optional

Customer's country of residence

BirthDate

string <YYYY-MM-DD>

optional

Customer's birth date

Nationality

string

optional

Customer's nationality (ISO 3166-1 Alpha 3)

CallingCode

string

optional

Customer's calling code

Phone

string

optional

Customer's phone number

MultiplePayments

enum<string>

optional

Allows you to split the transaction into several payments (for example, for an amount of 300 euros, the deposit will be 100 euros by default, a payment of 100 euros will take place 30 days later, then a final payment of 100 euros after 60 days)

Allowed values:

yesno

MultiplePaymentsRepeat

string

optional

Number of payments to be made in total when paying in installments, including deposit (default is 3)

DownPayment

number

optional

Deposit for a payment in several instalments (33% of the total by default, if payment in 3 instalments for example) or amount of the first payment (for a subscription, if the first payment is different from the following)

Rebill

enum<string>

optional

Activate or not the subscription (recurring payments)

Allowed values:

yesno

Recurrence

enum<string>

optional

Frequency of direct debit of subscriptions (monthly by default)

Allowed values:

yearlymonthlybimonthlyweeklydailybiannualquarterly

PayToEmail

string

optional

Allows you to redirect the collection of this transaction to the account of another Easytransac user

PayToId

number

optional

Allows you to redirect the collection of this transaction to the account of another Easytransac user, by his unique ID

InvoiceContent

string

optional

Invoice PDF content (base64 encoded), it will be attached to the email sent to your customer and visible on the payment page

InvoiceExtension

enum<string>

optional

Type of file transmitted

Allowed value:

PDF

InvoiceName

string

optional

Name given to the PDF document when it is downloaded

UserAgent

string

optional

Indicates the capabilities of the client browser

Language

string

optional

Language of the payment page

Signature

string

required

Signature to verify the integrity of the data sent

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Response

application/json

Body

Code

integer

optional

Example:

Signature

string

optional

Example:

1f51786246a940677afe71f6968972fd46500bd1

Result

object

optional

RequestId

string

optional

Example:

a1b2c3d4e5f6

OperationType

enum<string>

optional

Allowed values:

paymentdebit

Example:

payment

PaymentMethod

enum<string>

optional

Allowed values:

ApiManualMailNfcSmsQRCodeMessengerWhatsappFlashEmv

Example:

mail

Status

enum<string>

optional

Allowed values:

tosendpendingexpiredcancelledlockeddone

Example:

pending

Date

string

optional

Example:

2019-06-03 17:05:30

DateSent

string

optional

Example:

2019-06-03 17:05:30

Amount

string

optional

Example:

29.99

3DSecure

enum<string>

optional

Allowed values:

yesno

Example:

PageUrl

string

optional

Example:

https://www.easytransac.com/pay/a1b2c3d4e5f6

string

optional

Example:

john@doe.com

Phone

string

optional

Example:

0612131415

Live

enum<string>

optional

Allowed values:

yesno

Example:

yes

Language

string

optional

Example:

FRE

Example

{
  "Code": 0,
  "Signature": "1f51786246a940677afe71f6968972fd46500bd1",
  "Result": {
    "RequestId": "a1b2c3d4e5f6",
    "OperationType": "payment",
    "PaymentMethod": "Api",
    "Status": "tosend",
    "Date": "2019-06-03 17:05:30",
    "DateSent": "2019-06-03 17:05:30",
    "Amount": "29.99",
    "3DSecure": "yes",
    "PageUrl": "https://www.easytransac.com/pay/a1b2c3d4e5f6",
    "Email": "john@doe.com",
    "Phone": "0612131415",
    "Live": "yes",
    "Language": "FRE"
  }
}