Register card in the maib ecomm system
API endpoint (POST) |
---|
https://api.maibmerchants.md/v1/savecard-recurring |
Request parameters (body)
Parameter | Required | Type | Description |
---|---|---|---|
billerExpiry | YES | string(4) | The date (month/year) until which the card data will be saved in maib ecomm system. Format: MMYY (e.g: 1229 -> 31 December 2029 / 23:59:59). If the validity of the card is lower than the value passed in this parameter, then the card data will be kept until the date of validity of the card. |
clientIp | YES | string(15) | Customer IP |
amount | NO* | number(decimal) ≥1 | Transaction amount. Format: X.XX E.g: 10.25 (currency=USD) means $10 and 25 cents. *If the parameter is passed, the amount will be debited from the Customer's account and the card data will be saved in the maib ecomm system. *If the parameter is not passed, then the card data will be saved without debiting anything from the Customer's account. |
currency | YES | string(3) | Transaction currency (MDL/EUR/USD). |
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 |
YES | 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. |
| no | string(36) | Product ID |
| no | string(128) | Product name |
| no | number(decimal) | Product price |
| 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&billerId) 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. |
Example
Intermediate response parameters
Parameter | Type | Description |
---|---|---|
result | Object | Object containing the transaction identifier and redirect link. |
| String | Transaction identifier assigned by maib ecomm |
| String | Order ID generated by Merchant website/app |
| 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 |
| String | Error code |
| String | Error description |
| Object | Object contains parameters with error details |
Example
Final response parameters
Parameter | Type | Description |
---|---|---|
result | Object | Object containing transaction data. |
| String | Transaction identifier assigned by maib ecomm. |
| String | Order ID generated by Merchant website/app. |
| String | Card identifier saved in maib ecomm system. The merchant will initiate the following payments by passing this identifier in the request (execute-recurring). |
| String | The date (month/year) until which the card data will be saved in maib ecomm system. Format: MMYY (e.g: 1229 - 31 December 2029 / 23:59:59). If the validity of the card is lower than the value previously sent in the request, then in the response you will receive the card's expiration date. |
| String | OK - If the amount parameter has been passed and the transaction is successful (the card data has been registered). PENDING - If the amount parameter was not passed (the card data has been registered). |
| String | Transaction status code |
| String | Transaction status information message |
| String | 3-D Secure authentication result AUTHENTICATED - successfully authenticated. |
| String | RRN - Transaction ID generated by maib ecomm. |
| String | Approval Code - The transaction approval code generated by the card issuing bank. |
| String | Masked number card. |
| Number (decimal) | Transaction amount. Format: X.XX |
| String | Transaction currency (MDL/EUR/USD) |
signature | String | Response validation signature |
Example
Last updated