Post Transaction
Last updated
Last updated
In this API Service, if the member has a deal with the Merchant, the merchant has to register the Member for recurring transactions.
The endpoint URL is a feedback URL that will process the data in the post from the merchant system. For the implementation of the testing, UAT can use URL development.
| Integration Method | Development |
|---|---|
| Parameter | Data Type | M/O/C | Description |
|---|---|---|---|
Notes:
(an) is an alphanumeric format.
can insert up to 5 dates on process_date (use "," (comma) as separator)
see point 3.1 for signature &authkeyalgoritmcode in PHP
parameter “recurring_accumulate_at” is in days, fill with 0 (zero) to use parameter at process_date
parameter “process_date” can be filled only with one date if “recurring_accumulate_at” is not filled with 0 (zero)
recurring_type format:
- 1: New Member
- 2: Update Card
Payment Window Response:
Following are the standard parameters that the payment result will pass back as a response. Transaction request that has insufficient parameters or incorrect values, will be rejected by Faspay Credit card and not stored in the system.
In addition, depending on the acquiring bank and payment modes, you may have some additional information returned from your acquiring bank.
As different acquiring banks may return different additional parameters, we would advise you to check with your acquiring bank and service provider if these additional parameters are made available to you in the response parameter. Certain parameters may not be returned to you if it’s not stored on the Faspay Credit card server.
Payment Window Response Specific to Credit Card:
| Action | Description |
|---|---|
| Parameter | Data Type | M/O/C | Description |
|---|---|---|---|
| Parameter | Data Type | M/O/C | Description |
|---|---|---|---|
Merchant Window API
Merchant Direct API
lang*
Varchar (10)
O
Defined the language to be used if the merchant support multiple languages payment window. This requires configuration at merchant settings. Ignore this parameter if there is no such requirement. Refer Appendix F for coded values.
merchantid
Varchar (30)
M
Your Faspay Credit card Merchant ID
txn_password
Varchar(12)
M
Your Faspay Credit card transaction password
merchant_tranid
Varchar(100)
M
Your own assigned unique ID for this transaction.
payment_method*
Varchar(1)
M
For recurring transaction, please fill with type = 3
currencycode*
Varchar(3)
M
Fill with IDR, Indicate the currency of this transaction.
E.g. MYR, USD, SGD etc.
amount
Numeric
M
On this recurring process, Amount used for initial transaction member when register.
custname
Varchar(120)
M
Shopper’s / customer name.
custemail
Varchar(100)
M
Shopper’s / customer Email Address.
description
Varchar(100)
O
Short description of the order
return_url
Varchar(100)
M
URL that page will be redirected with the transaction response after transaction has been processed (also for Thank you page URL). Merchant should translate the response parameter pass back to this URL and display user-friendly message to cardholder.Responses parameters are passed back using HTTP POST.
signature
Varchar (40)
M
Transaction signature of request for data integrity check. Refer to Transaction Signature for details.
billing_address
Varchar(200)
O
Shopper’s billing address
billing_address_city
Varchar(50)
O
Shopper’s billing city
billing_address_region
Varchar(100)
O
Shopper’s billing region
billing_address_state
Varchar(100)
O
Shopper’s billing state
billing_address_poscode
Varchar(10)
O
Shopper’s billing postcode
billing_address_country_code*
Varchar(10)
O
Shopper’s billing country code
receiver_name_for_shipping
Varchar(100)
O
Shopper’s / customer name.
shipping_address
Varchar(200)
O
Shopper’s shipping address
shipping_address_ city
Varchar(50)
O
Shopper’s shipping city
shipping_address_region
Varchar(100)
O
Shopper’s shipping region
shipping_address_state
Varchar(100)
O
Shopper’s shipping state
shipping_address_poscode
Varchar(10)
O
Shopper’s shipping postcode
shipping_address_country_code*
Varchar(10)
O
Shopper’s shipping country code
shippingcost
Numeric
O
Amount of shipping cost. Supports up to 2 decimal point. E.g. amount is RM 52.50, set value as 52.50, amount is
IDR 10000, set value as 10000.
phone_no
Varchar(20)
O
Shopper’s phone number
mref1
Varchar(100)
O
Additional reference value for the transaction.
mref2
Varchar(100)
O
Additional reference value for the transaction.
mref3
Varchar(100)
O
Additional reference value for the transaction.
mref4
Varchar(100)
O
Additional reference value for the transaction.
mref5
Varchar(100)
O
Additional reference value for the transaction.
mref6
Varchar(100)
O
Additional reference value for the transaction.
mref7
Varchar(100)
O
Additional reference value for the transaction.
mref8
Varchar(100)
O
Additional reference value for the transaction.
mref9
Varchar(100)
O
Additional reference value for the transaction.
mref10
Varchar(100)
O
Additional reference value for the transaction.
mparam1
Varchar(50)
O
Additional parameter the merchant wish to receive back as response for processing.
This value is not stored by Faspay Credit card.
mparam2
Varchar(50)
O
Additional parameter the merchant wish to receive back as response for processing.
This value is not stored by Faspay Credit card.
customer_ref
Varchar(50)
O
Value that may be used by bank to refer to the transaction when liaising with customer.For credit card, this value will be passed to bank and display on cardholder’s statement if applicable. Actualvalue displayed may be truncated by bank.
The length could be vary for different bank but cannot be more than the specified max value.
pymt_ind
Varchar(20)
O
pymt_criteria
Varchar(20)
O
frisk1
Varchar(50)
O
Additional parameter that is passed to Fraud Detection
System (FDS)
frisk2
Varchar(50)
O
Additional parameter that is passed to Fraud Detection
System (FDS)
domicile_address
Varchar(200)
O
Shopper's desirable contact address
domicile_address_city
Varchar(50)
O
Shopper's desirable contact city
domicile_address_city
Varchar(100)
O
Shopper's desirable contact region
domicile_address_state
Varchar(100)
O
Shopper's desirable contact state
domicile_address_poscode
Varchar(10)
O
Shopper's desirable contact postcode
domicile_address_country_code
Varchar(10)
O
Shopper's desirable contact country code
domicile_phone_no
Varchar(20)
O
Shopper's desirable contact phone number
merchant_id
Numeric(5)
M
Merchant ID given by Faspay
member_id
Varchar(50)
M
Merchant’s Member ID for recurring (generated by merchant)
member_name
Varchar(50)
M
Merchant’s Member Name
member_email
Varchar(50)
M
Merchant's Member Email
member_email_notif
Varchar(1)
M
Merchant's Member Email Notification
process_date
Varchar
M
Process date, this parameters used for date of transaction and date of retry recurring if there is a failed recurring.
Sample : process_date = "12,15,20,25,01,05,10".
12 is a date for register new recurring transaction date.
15,20,25,01,05,10 is a date for retry recurring if any failed recurring to this member.
recurring_type
Numeric(1)
M
Recurring Type :
1 = Register new member
2 = Update Card
recurring_amount
Numeric(12)
M
Recurring Amount is used for transaction amount on recurring process.
recurring_start_date
Date(10)
M
Recurring Start Time (must be same day with the transaction date)
recurring_end_date
Date(10)
M
Recurring End Time
recurring_period
Varchar(1)
M
Recurring Period :
M = Monthly
Y = Yearly
recurring_perriod_at
Numeric(1)
M
Repetition of Recurring Period, sample case : if user fill recurring_period with M (monthly), recurring_perriod_at is used for repetition of deduction by period. Sample :
- recurring_period : M
- recurring_perriod_at : 1
so, recurring will process by system per months, if fill with 3, recurring will process per 3 months.
recurring_accumulate
Varchar(1)
M
Recurring Accumulate : t
recurring_accumulate_at
Numeric(1)
M
Repetition of Recurring Accumulate in Days
recurring_status
Varchar(1)
M
Recurring Status : t
recurring_signature
Varchar(10)
M
Recurring Signature sha5 (md5(user_id+password+member_id))
When
Receiving
What To Do
will get a response from Faspay and please keep the member_id from the response’s.
recurring_type*
Varchar(1)
M
Indicates the recurring type of transaction,1 for register new member.
member_name
Varchar(50)
M
Merchant’s Member Name
member_email
Varchar(50)
M
Merchant's Member Email
member_email_notif
Varchar(50)
M
Merchant's Member Email Notification
process_date
Varchar
M
Process date, this parameters used for date of transaction and date of retry recurring if there is a failed recurring.
Sample : process_date = "12,15,20,25,01,05,10". (Max 9 date)
12 is a date for register new recurring transaction date.
15,20,25,01,05,10 is a date for retry recurring if any failed recurring to this member.
reccuring_amount
Numeric(12)
M
Recurring Amount is used for transaction amount on recurring process.
recurring_start_date
Date(10)
M
Recurring Start Time (must be same day with the transaction date)
recurring_end_date
Date(10)
M
Recurring End Time
recurring_period
Varchar(1)
M
Recurring Period :
M = Monthly
Y = Yearly
recurring_period_at
Numeric(1)
M
Repetition of Recurring Period, sample case : if user fill recurring_period with M (monthly), recurring_perriod_at is used for repetition of deduction by period. Sample :
- recurring_period : M
- recurring_perriod_at : 1
so, recurring will process by system per months, if fill with 3, recurring will process per 3 months.
recurring_accumulate_at
Numeric(1)
M
Repetition of Recurring Accumulate in Days
recurring_status
Varchar(1)
M
1 for active, 0 for inactive
payment_method*
Varchar(1)
C
Indicates the payment mode used to process this transaction.In the event of error,this field may be empty.
Refer to Appendix E for Available Payment Methods
merchantid
Varchar (30)
M
Your Faspay Credit card MerchantID
merchant_tranid
Varchar(100)
M
Merchant’sown assigned transaction id as passed in from
The request.
err_code*
Varchar(10)
M
Error Code returns from Faspay Credit card.
If transaction is successful,this value will be 0.
Any other value than 0 will indicate that the transaction is not successful.
err_desc
Varchar(250)
M
Error description from Faspay Credit card based on the
ERR_CODE.
usr_code
Varchar(4)
C
User Code returns from Faspay Credit card.A user code
Will be used to indicate the appropriate action to be taken by shopper according to different bank response code obtained. In the case of pending status,this value is will an empty value
usr_msg*
Varchar(200)
C
User Message returns from Faspay Credit card.A user
message will be used to indicate the appropriate action to be takenby shopperaccordingto different bankresponsecode obtained. Inthecase of pending status,this value is will an empty value
txn_status*
Varchar(3)
M
Transaction status from Faspay Credit card. Please refer
To Appendix B for full list of transaction status.
A–Authorized
S –Sales
F–Notapproved
E –Error
B –Blocked
RC –Reconfirm
N –Pending
I–Incomplete
This value must be stored and it’s the indication whether the transaction is successful,declined or error.
custname
Varchar(120)
M
Shopper’s name as passed in from the request.
description
Varchar(100)
O
Transactiondescriptionaspassedin fromtherequest.
currencycode*
Varchar(3)
M
Currency code as passed in from the request. Refer to
Appendix for SupportedCurrencies
amount
Numeric(10)
M
Transaction amount as passed in fromtherequest.
signature
Varchar(40)
M
Transaction signature of response for data integrity checking.RefertoChapter 5TransactionSignaturefor details.
transactionid
Integer
M
Faspay Credit card assigned transaction id if the
Transaction was stored. This value must be stored and used as reference value to retrieve the transaction from Faspay Credit card.
In the event that if the request parameters are invalid, the transaction is rejected and not stored, this value will be 0.
trandate
Varchar (19)
C
Transaction date of when transaction is submitted to
Faspay Credit card.
Date formatin ‘DD-MM-YYYYhh:mm:ss’
e.g.24-05-200608:24:23
In the event of error, this field may be empty.
transactiontype
Varchar(2)
C
Indicate the transaction type used for this transaction. In the event of error, this field maybe empty.
is_blacklisted
Varchar(5)
C
Indicate whether the transaction is blacklisted. Value is ‘Yes’
or ‘No’ In the event of error, this field maybe empty.
fraudrisklevel
Integer
C
Indicate fraud risklevel. Valueas follow:
-1 : Error or notinused.
0–Very lowrisk
1– Lowrisk
2–Medium risk
3–High risk
4–Very high risk
In the event of error, this field maybe empty.
fraudriskscore
Numeric
C
Fraud risk score in two decimal values.
In the event of error, this field maybe empty.
exceed_high_risk
Varchar(3)
C
Indicate whether the transaction fraud score exceed the threshold value set for highrisk in merchant setting.
Possible value are:
Yes = Transaction fraud risk exceed merchant high risk threshold
No=Transactionfraudriskfallbellowsthemerchanthigh riskthreshold
NA=NotApplicable(fraudscore notavailable) In theeventof error,thisfieldmaybeempty.
mparam1
Varchar(50)
O
Additional parameter as what is passed in request. This value is not stored by Faspay Credit card.
mparam2
Varchar(50)
O
Additional parameter as what is passed in request. This value is not stored by Faspay Credit card.
acquirer_bank
VarcharI(30)
O
Your Faspay Credit card Acquirer ID
member_id
Varchar(50)
M
Merchant’s Member ID for recurring (generated by merchant)
cardtype
Varchar(1)
C
Indicate card type used.
MasterCard=M
Visa=V
JCB=J
Amex=A
In the event of error, this field maybe empty.
card_no_partial
Varchar(20)
C
Returns first 2 and last 4 digits of creditcard. E.g.: 45XXXXXXXXXX1234
In the event of error, this field maybe empty.
cardname
Varchar(100)
C
Name on the Credit Card
In the event of error, this field maybe empty.
acquirer_bank*
Varchar(3)
C
Acquiring bank that processed this credit card transaction. Coded value.Please refer to Appendix.
This parameter will only have value if the transaction request fulfills allthe mandatory parameters and passes all parameters validation checking inFaspay Credit card server.
It will be empty also if Faspay Credit card server does not sendin the transaction to any bank. This may happen, in few possible cases like, Faspay Credit card server cannot find any suitable acquirer setup to process the transaction, or the transaction is blocked based on merchant settings.
bank_res_code
Varchar(20)
C
Response code or error code from bank.
bank_res_msg
Varchar(250)
C
Bank description on the response based on
BANK_RES_CODE.
auth_id
Varchar(20)
C
Bank approval code (iftransaction is approved). If transaction is declined or error, this parameter will be empty.
bank_reference
Varchar(100)
O
Reference value from bank (if transaction is approved).If transaction hit error, this parameter maybe empty.
whitelist_card
Varchar(3)
C
Indicate whether the transaction is use whitelist card. Value
is ‘Yes’ or ‘No’
is_on_us
Varchar(3)
M
Indicate whether the transaction is using on uscard. Value
is ‘Yes’ or ‘No’