API
HomeEasytransac
HomeEasytransac
  1. API - Payment
  • Start
    • API Domain Usage
    • Get an API key
    • Communication
  • Documentation
    • Errors
      • ApiError codes
    • Webhooks
      • PUSH Method
      • PULL Method
  • V2
    • Overview
    • Authentication
      • JWT access token - Generate
        POST
    • Endpoints
      • Open Banking
        • Open Banking - Initialize
      • SDD
        • SDD - Mandate - Create
        • SDD - Mandate - Debit
        • SDD - Mandate - Get status
      • Transaction
        • Transaction - Get status
  • V1
    • Documentation
      • Signature
    • Authentication
      • Overview
      • Security
      • PSD2 and 3DSecure
    • API - Payment
      • Recurring payments
      • Card payment
        POST
      • 1-click payment
        POST
      • SEPA Direct Debit
        POST
      • Transfer (Open Banking)
        POST
      • Payment page
        POST
      • Cancel a payment page
        POST
      • Resend the payment page
        POST
      • P2P Transfert
        POST
      • Update a subscription
        POST
      • Status
        POST
      • Refund
        POST
      • Capture
        POST
      • Cancellation
        POST
      • List of cards
        POST
      • List of IBANs
        POST
      • History
        POST
      • Payment requests
        POST
      • Card information
        POST
    • API - User
      • Add a merchant
      • Update a merchant
      • Search for a merchant
      • List of movements
      • Make a payout
      • List all payouts
      • Add a logo
      • Get the activity
      • Update activity
    • API - Document
      • Add a document
      • Get a document
      • List documents
  1. API - Payment

Transfer (Open Banking)

Sandbox
https://api.sandbox.easytransac.com/v2
Sandbox
https://api.sandbox.easytransac.com/v2
POST
/api/payment/bybank
API - Payment
Payment by bank transfer from the customer's bank directly. Authorisation is instantaneous but validation of the payment may take several days.
The customer should be redirected to their bank's page via RedirectUrl.

Request

Body Params application/x-www-form-urlencoded
Amount
number 
required
Transaction amount in cents
ClientIp
string 
required
Customer IP address
Email
string 
optional
The customer's email address associated with the payment
OrderId
number 
optional
Your unique transaction identifier (or order number)
Description
number 
optional
Description of the transaction (use \n to make a line break)
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
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
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
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
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/api/payment/bybank' \
--data-urlencode 'Amount=' \
--data-urlencode 'ClientIp=' \
--data-urlencode 'Signature='

Responses

🟢200Response
application/json
Body
Code
integer 
optional
Example:
0
Signature
string 
optional
Example:
1f51786246a940677afe71f6968972fd46500bd1
Result
object 
optional
OperationType
string 
optional
Example:
payment
PaymentMethod
string 
optional
Example:
Paybybank
ApplicationType
enum<string> 
optional
Allowed values:
ApiBackofficeIosAndroid
Example:
Api
Tid
string 
optional
Example:
4bEp3k1v
Uid
string 
optional
Example:
ccc
OrderId
string 
optional
Example:
test123
Status
enum<string> 
optional
Allowed values:
pendingfailed
Example:
pending
Date
string 
optional
Example:
2021-08-06 10:54:18
Amount
string 
optional
Example:
2.5
ClientIP
string 
optional
Example:
22.22.22.22
ClientIPCountry
string 
optional
Example:
USA
Currency
string 
optional
Example:
EUR
CurrencyText
string 
optional
Example:
Euro
FixFees
string 
optional
Example:
0
Message
string 
optional
Example:
Waiting for the customer to validate the payment
Test
enum<string> 
optional
Allowed values:
yesno
Example:
yes
Language
string 
optional
Example:
FRE
Error
string 
optional
Example:
Generic error
AdditionalError
array[string]
optional
Example:
["Do not honour"]
RedirectUrl
string 
optional
Example:
https://www.easytransac.com/api/payment/paybybank/aBcD1234
Client
object 
optional
Example
{
  "Code": 0,
  "Signature": "1f51786246a940677afe71f6968972fd46500bd1",
  "Result": {
    "OperationType": "payment",
    "PaymentMethod": "Paybybank",
    "ApplicationType": "Api",
    "Tid": "4bEp3k1v",
    "Uid": "ccc",
    "OrderId": "test123",
    "Status": "pending",
    "Date": "2021-08-06 10:54:18",
    "Amount": "2.5",
    "ClientIP": "22.22.22.22",
    "ClientIPCountry": "USA",
    "Currency": "EUR",
    "CurrencyText": "Euro",
    "FixFees": "0",
    "Message": "Waiting for the customer to validate the payment",
    "Test": "yes",
    "Language": "FRE",
    "Error": "Generic error",
    "AdditionalError": [
      "Do not honour"
    ],
    "RedirectUrl": "https://www.easytransac.com/api/payment/paybybank/aBcD1234",
    "Client": {
      "Id": "aaabbb1",
      "Email": "test@test.com",
      "Firstname": "John",
      "Lastname": "Doe",
      "Address": "26 green street",
      "ZipCode": "75001",
      "City": "Paris"
    }
  }
}
Previous
SEPA Direct Debit
Next
Payment page
Built with