Open Banking - Initialize

Initializes a PayByBank transfer directly from the customer's bank.
The payment authorisation is instantaneous but its validation may take several days.
The customer is redirected to its bank payment page via the returnUrl parameter.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

amount

integer

required

Transaction amount (cents)

>= 1

string <email>

required

Customer's email address associated with the payment

>= 6 characters<= 128 characters

returnUrl

string <uri>

required

URL to redirect the customer once the payment has been made

>= 12 characters<= 255 characters

clientIp

string <ipv4> | null

optional

Customer's IP (v4 or v6)

>= 7 characters<= 45 characters

returnMethod

enum<string> | enum<null>

optional

HTTP method used for the returnUrl parameter

>= 3 characters<= 4 characters

Allowed values:

GETPOST

Default:

POST

orderId

string | null

optional

Your own transaction/order ID

>= 1 characters<= 64 characters

description

string | null

optional

Description of the transaction

>= 1 characters<= 2048 characters

clientId

string | null

optional

Customer's Easytransac ID (only available if you have already made a payment for this customer)

>= 7 characters<= 7 characters

Match pattern:

^[A-Za-z0-9]{7}$

uid

string | null

optional

Your own customer ID

>= 1 characters<= 64 characters

Match pattern:

^[A-Za-z0-9]+$

firstname

string | null

optional

Customer's first name

>= 1 characters<= 128 characters

Match pattern:

^[A-Za-z0-9]+$

lastname

string | null

optional

Customer's last name

>= 1 characters<= 128 characters

Match pattern:

^[A-Za-z0-9]+$

address

string | null

optional

Customer's address

>= 1 characters<= 128 characters

Match pattern:

^[A-Za-z0-9]+$

zipCode

string | null

optional

Customer's postal code

>= 1 characters<= 16 characters

Match pattern:

^[A-Za-z0-9]+$

city

string | null

optional

Customer's city

>= 1 characters<= 64 characters

Match pattern:

^[A-Za-z0-9]+$

country

string | null

optional

Customer's country of residence (ISO 3166-1 Alpha 3)

>= 3 characters<= 3 characters

birthDate

string <date> | null

optional

Customer's birth date (ATOM)

>= 10 characters<= 10 characters

nationality

string | null

optional

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

>= 3 characters<= 3 characters

callingCode

integer | null

optional

Customer's calling code

>= 1<= 999

phone

string | null

optional

Customer's phone number

>= 5 characters<= 18 characters

Match pattern:

^[0-9]{5,18}$

payToEmail

string <email> | null

optional

Redirect the collection of this transaction to another Easytransac user account by its email

>= 6 characters<= 128 characters

payToId

integer | null

optional

Redirect the collection of this transaction to another Easytransac user account by its ID

>= 1<= 99999999999

userAgent

string | null

optional

Customer's browser's user agent

>= 1 characters<= 2048 characters

language

enum<string> | enum<null>

optional

Preferred language of the payment page (ISO 639)

>= 3 characters<= 3 characters

Allowed values:

DEUENGFREITASPA

Default:

FRE

Example

{
  "amount": 1000,
  "email": "abc@abc.com",
  "returnUrl": "https://example.com/paid"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

success

boolean

required

Whether the action was successful

date

string <date-time>

required

Date of response (ATOM)

>= 25 characters<= 25 characters

data

object

required

Additional data

tid

string

required

Transaction ID

>= 8 characters<= 14 characters

Match pattern:

^[A-Za-z0-9-]{8,14}$

status

enum<string>

required

Transaction status

>= 6 characters<= 10 characters

Allowed values:

authorizedcapturedfailedpendingrefunded

amount

integer

required

Transaction amount (cents)

>= 1

dateCreated

string <date-time>

required

Date of creation of the resource (ATOM)

orderId

string | null

optional

Your own transaction/order ID

>= 1 characters<= 64 characters

redirectUrl

string | null

optional

URL to redirect the customer to its bank payment page

>= 12 characters<= 255 characters

Example

{
  "success": true,
  "date": "2024-12-31T23:59:59+02:00",
  "data": {
    "tid": "ABC1-ABC1-ABC1",
    "status": "captured",
    "amount": 1000,
    "dateCreated": "2024-12-31T23:59:59+02:00",
    "orderId": "ABCabc123",
    "redirectUrl": "https://example.com/pay"
  }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠405405

🔴500Server Error

🔴502Bad Gateway

🔴504Gateway Timeout