Payment authorization
Last updated
Last updated
After payment authorization, 2 actions are possible:
Payment capture - the amount will be debited from the Customer's account;
Cancel authorization - the amount will be unblocked, nothing will be debited from the Customer's account.
API endpoint (POST) |
---|
Parameter | Required | Type | Description |
---|---|---|---|
Example
Example
Example
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
https://api.maibmerchants.md/v1/hold
amount
YES
number(decimal)
≥1
Amount to be put on hold (blocked) on Customer's bank account. Format: X.XX
E.g: 10.25 (currency=USD) means $10 and 25 cents.
currency
YES
string(3)
Transaction currency (MDL/EUR/USD)
clientIp
YES
string(15)
Customer IP
language
NO
string(2)
Language maib ecomm checkout page.
Allowed values: ro/en/ru
If this parameter is not passed, the page will be displayed in English.
description
NO
string(124)
Payment description.
Displayed on maib ecomm checkout page.
clientName
NO
string(128)
Customer name
NO
string(40)
Customer email
phone
NO
string(40)
Customer phone
orderId
NO
string(36)
Order ID generated by Merchant website/app.
delivery
NO
number(decimal)
Shipping cost
items
NO
array
max. 50 items
The products or services ordered from the website/app.
id
no
string(36)
Product ID
name
no
string(128)
Product name
price
no
number(decimal)
Product price
quantity
no
integer(32)
Product quantity
callbackUrl
NO
string(2048
The link where the Merchant will receive the final response with the transaction status and data.
If this parameter is not passed, its value will be taken from maibmerchants.
okUrl
NO
string(2048)
The link where the Customer will be redirected if the transaction was successful.
(GET request: okUrl + payId&orderId)
If this parameter is not passed, its value will be taken from maibmerchants.
failUrl
NO
string(2048)
The link where the Customer will be redirected if the transaction was failed.
(GET request: failUrl + payId&orderId)
If this parameter is not passed, its value will be taken from maibmerchants.
result
Object
Object containing the transaction identifier and redirect link.
payId
String
Transaction identifier assigned by maib ecomm
orderId
String
Order ID generated by Merchant website/app
payUrl
String
The link to the maib ecomm checkout page where the Customer must be redirected to enter their card details (or pay via Apple Pay/Google Pay).
ok
Boolean
Request/transaction processing status.
true - no errors
false - an error occurred (error details will be in errors)
errors
Array
Request/transaction processing errors. Errors table
errorCode
String
Error code
errorMessage
String
Error description
errorArgs
Object
Object contains parameters with error details
result
Object
Object containing transaction data.
payId
String
Transaction identifier assigned by maib ecomm.
orderId
String
Order ID generated by Merchant website/app.
status
String
OK - successfully completed.
statusCode
String
Transaction status code.
statusMessage
String
Transaction status information message.
threeDs
String
3-D Secure authentication result
AUTHENTICATED - successfully authenticated.
rrn
String
RRN - Transaction ID generated by maib ecomm.
approval
String
Approval Code - The transaction approval code generated by the card issuing bank.
cardNumber
String
Masked number card.
amount
Number(decimal)
Hold amount. Format: X.XX
currency
String
Transaction currency (MDL/EUR/USD).
signature
String
Response validation signature