| Integration Method | Development |
|---|---|
| Merchant Window API | https://fpg-sandbox.faspay.co.id/payment/api |
| Merchant Direct API | https://fpg-sandbox.faspay.co.id/payment/api |
| Parameter | Data Type | M/O/C | Description |
|---|---|---|---|
| transactiontype | Varchar(2) | M | For query API, always used value ‘4’. |
| merchantid | Varchar (30) | M | Your Faspay e-Payment Merchant ID |
| merchant_tranid | Varchar(100) | M | Your own assigned unique ID for transaction. The value must match the original value submitted in; otherwise the request will be rejected with error. |
| amount | Numeric | M | Original amount of transaction. Supports up to 2 decimal point. E.g., amount is RM 52.50, pass in the value as 52.50, amount is IDR 10000, pass in as 10000.00. The value must match the original amount submitted in; otherwise the request will be rejected with error. |
| response_type | Varchar(1) | M | Indicate how the system should provide the transaction result. Please always use the value ‘3’ for Query API. The response parameters will be directly printed to stream with ‘;’ as separator for each response parameter. The sequence of the parameter may be different from one release to another, please do not rely on the sequence of parameter to process response. |
| signature | Varchar(40) | C | Transaction signature of request for data integrity check. |
| Parameter | Data Type | M/O/C | Description |
|---|---|---|---|
| payment_method | Varchar(1) | M | Indicates the payment mode used for this transaction. In the event of error, this field may be empty. |
| merchantid | Varchar (30) | M | Your Faspay e-Payment Merchant ID |
| merchant_tranid | Varchar(100) | M | Merchant’s own assigned transaction id as passed in from the request. |
| transactionid | Integer | M | Faspay e-Payment assigned transaction id if the transaction was stored. This value must be stored and used as reference value to retrieve the transaction from Faspay e-Payment. 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 e-Payment. Date format in ‘DD-MM-YYYY hh:mm:ss’ e.g. 24-05-2006 08:24:23 In the event of error, this field may be empty. |
| err_code | Varchar(10) | M | Error Code returns from Faspay e-Payment. 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 e-Payment based on the ERR_CODE. |
| txn_status | Varchar(3) | M | Transaction status from Faspay e-Payment. Please refer to Appendix B for full list of transaction status. A – Authorized (for authorized request) S – Sales (for sales request) F – Not approved 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) | C | Shopper’s name. In the event of error, this field may be empty. |
| description | Varchar(100) | O | Transaction description as passed in from the request. |
| currencycode | Varchar(3) | C | Indicate the currency of this transaction. Refer to Appendix I for Supported Currencies. E.g. IDR, USD, SGD etc. In the event of error, this field may be empty. |
| amount | Numeric(10) | M | Transaction amount as passed in from the request. |
| signature | Varchar(40) | M | Transaction signature of response for data integrity checking. |
| is_blacklisted | Varchar(5) | C | Indicate whether the transaction is blacklisted. Value is ‘Yes’ or ‘No’ In the event of error, this field may be empty. |
| fraudrisklevel | Integer | C | Indicate fraud risk level. Value as follow: -1 : Error or not in used. 0 – Very low risk 1 – Low risk 2 – Medium risk 3 – High risk 4 – Very high risk In the event of error, this field may be empty. |
| fraudriskscore | Numeric | C | Fraud risk score in two decimal values. In the event of error, this field may be empty. |
| eui | Varchar(3) | O | End User Indicator (EUI) is use to help merchant determine the response to display on merchant return URL. Please refer to Appendix section for further details. SUC = Success RTY = Retry/Failed ALT = Alert NA = Not Applicable |
| exceed_high_risk | Varchar(3) | C | Indicate whether the transaction fraud score exceed the threshold value set for high risk in merchant setting. Possible value are: Yes = Transaction fraud risk exceed merchant high risk threshold No = Transaction fraud risk fall bellows the merchant high risk threshold NA = Not Applicable (fraud score not available) In the event of error, this field may be empty. |
| transactiontype | Varchar(2) | M | Return transaction type as passed in from request. |
| acquirer_id | VarcharI(30) | O | Your Faspay e-Payment Acquirer ID |
| total_refund_amount | Numeric(10) | M | The total of refund amount that already done for the transaction. If the transaction not doing any refund, will return 0. |
| cardname | Varchar(100) | C | Name on the Credit Card. In the event of error, this field may be empty. |
| cardtype | Varchar(1) | C | Indicate card type used. MasterCard = M Visa = V In the event of error, this field may be empty. |
| card_no_partial | Varchar(20) | C | Returns first 6 and last 4 digits of credit card. E.g.: 455555XXXXXX1234 In the event of error, this field may be 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 all the mandatory parameters and passes all parameters validation checking in Faspay e-Payment server. It will be empty also if Faspay e-Payment server does not send in the transaction to any bank. This may happen, in few possible cases like, Faspay e-Payment 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. In the event of error, this field may be empty. |
| bank_res_msg | Varchar(250) | C | Bank description on the response based on BANK_RES_CODE. In the event of error, this field may be empty. |
| auth_id | Varchar(20) | O | Bank approval code (if transaction 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 may be empty. |
| is_on_us | Varchar(3) | M | Indicate whether the transaction is using on us card. Value is ‘Yes’ or ‘No’ |
| capture_date | Varchar (19) | C | Transaction date of when transaction is captured in Faspay e-Payment. Date format in ‘DD-MM-YYYY hh:mm:ss’ e.g. 24-05-2006 08:24:23 This parameter will only be provided if transaction status is successfully captured. |
| refund_date | Varchar (19) | C | Transaction date of when transaction is last refunded in Faspay e-Payment. Date format in ‘DD-MM-YYYY hh:mm:ss’ e.g. 24-05-2006 08:24:23 This parameter will only be provided if transaction status is successfully refunded. |
| whitelist_card | Varchar(3) | C | Indicate whether the transaction is use whitelist card. Value is ‘Yes’ or ‘No’ |
| pymt_token | Varchar(200) | C | The token to be used for retrieving credit card details in Tokenization Payment. |