- Start
- Documentation
- V2
- Overview
- Authentication
- Endpoints
- V1
Open Banking - Initialize
Sandbox
Sandbox
POST
/open-banking/init
open_banking
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
>= 1
email
string <email>
required
>= 6 characters<= 128 characters
returnUrl
string <uri>
required
>= 12 characters<= 255 characters
clientIp
string <ipv4> | null
optional
>= 7 characters<= 45 characters
returnMethod
enum<string> | enum<null>
optional
returnUrl parameter>= 3 characters<= 4 characters
Allowed values:
GETPOST
Default:
POST
orderId
string | null
optional
>= 1 characters<= 64 characters
description
string | null
optional
>= 1 characters<= 2048 characters
clientId
string | null
optional
>= 7 characters<= 7 characters
Match pattern:
^[A-Za-z0-9]{7}$
uid
string | null
optional
>= 1 characters<= 64 characters
Match pattern:
^[A-Za-z0-9]+$
firstname
string | null
optional
>= 1 characters<= 128 characters
Match pattern:
^[A-Za-z0-9]+$
lastname
string | null
optional
>= 1 characters<= 128 characters
Match pattern:
^[A-Za-z0-9]+$
address
string | null
optional
>= 1 characters<= 128 characters
Match pattern:
^[A-Za-z0-9]+$
zipCode
string | null
optional
>= 1 characters<= 16 characters
Match pattern:
^[A-Za-z0-9]+$
city
string | null
optional
>= 1 characters<= 64 characters
Match pattern:
^[A-Za-z0-9]+$
country
string | null
optional
>= 3 characters<= 3 characters
birthDate
string <date> | null
optional
>= 10 characters<= 10 characters
nationality
string | null
optional
>= 3 characters<= 3 characters
callingCode
integer | null
optional
>= 1<= 999
phone
string | null
optional
>= 5 characters<= 18 characters
Match pattern:
^[0-9]{5,18}$
payToEmail
string <email> | null
optional
>= 6 characters<= 128 characters
payToId
integer | null
optional
>= 1<= 99999999999
userAgent
string | null
optional
>= 1 characters<= 2048 characters
language
enum<string> | enum<null>
optional
>= 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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.sandbox.easytransac.com/v2/open-banking/init' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 1000,
"email": "abc@abc.com",
"returnUrl": "https://example.com/paid"
}'Responses
🟢200OK
application/json
Body
success
boolean
required
date
string <date-time>
required
>= 25 characters<= 25 characters
data
object
required
tid
string
required
>= 8 characters<= 14 characters
Match pattern:
^[A-Za-z0-9-]{8,14}$
status
enum<string>
required
>= 6 characters<= 10 characters
Allowed values:
authorizedcapturedfailedpendingrefunded
amount
integer
required
>= 1
dateCreated
string <date-time>
required
orderId
string | null
optional
>= 1 characters<= 64 characters
redirectUrl
string | null
optional
>= 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