Payment Integration API

Endpoint URL

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

Merchant Window API

https://fpg-sandbox.faspay.co.id/payment

Merchant Direct API

https://fpg-sandbox.faspay.co.id/payment

Request Parameter

Request parameters are parameters that the merchant's system must provide that can be integrated with the system Faspay.

Parameter

Type

M/O/C

Description

payment_method

Varchar(1)

For payment using credit/debit card, always set to 1.

merchantid

Varchar (30)

Your Faspay e-Payment Merchant ID

merchant_tranid

Varchar(100)

Your own assigned unique ID for this transaction.

pymt_ind

Varchar(20)

Specify the payment indicator to be used for this transaction. The payment indicator is used as the key identifier to set certain indication like card range to be processed. Certain card range of card can be processed. Ignore this parameter if there is not special requirement needed for the transaction. Note: PYMT_IND & PYMT_CRITERIA are to be in same sequence between the two parameters & each of the two parameters is to be separated by ';' only.

pymt_criteria

Varchar(20)

Specify the payment criteria to be used, together with the parameter PYMT_IND. This criteria will be set one the payment indicator had been defined. Ignore this parameter if there is not special requirement needed for the transaction. Note: PYMT_IND & PYMT_CRITERIA are to be in same sequence between the two parameters & each of the two parameters is to be separated by ';' only.

currencycode

Varchar(3)

Indicate the currency of this transaction. Refer to Appendix I for Supported Currencies E.g. IDR, USD, SGD etc.

amount

Numeric

Amount of transaction. Supports up to 2 decimal points. E.g. amount is RM 52.50, set value as 52.50, amount is IDR 10000, set value as 10000.00

signature

Varchar(40)

Transaction signature of request for data integrity check.

custname

Varchar(120)

Shopper’s name.

custemail

Varchar(100)

Shopper’s email address.

shopper_id

Varchar(15)

IP address of the customer. If customer is connecting via a proxy server, please make sure you can provide the actual IP address instead of the proxy server IP address.

description

Varchar(100)

Short description of the order

response_type

Varchar(1)

Indicate how the system should provide the transaction result. Default Value = 1 1 – Return response via browser redirection, using HTTP GET method 2 – Return response via browser with hidden form submission, i.e. using HTTP POST method 3 - 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)

return_url

Varchar(100)

URL that page will be redirected with the transaction response after transaction has been processed. Merchant should translate the response parameter pass back to this URL and display user-friendly message to cardholder. This field is mandatory if ‘RESPONSE_TYPE’ is set to 1 or 2.

cardno

Varchar (20)

Shopper’s Credit Card number. Only for the integration using the Merchant Direct API

cardname

Varchar (100)

Name on the Credit Card. Only for the integration using the Merchant Direct API

cardtype

Char(1)

Indicates the card type used.

MasterCard=M

Visa=V

JCB=J

Amex=A

Only for the integration using the Merchant Direct API

expirymonth

Char (2)

Use numeric representative of the month i.e. 01 - January

02 - February …

12 – December

Only for the integration using the Merchant Direct API

expiryyear

Char(4)

Format of year should be YYYY i.e.2005, 2006 and etc. Only for the integration using the Merchant Direct API

cardcvc

Char(4)

Card Verification Number (Last 3 digits located usually on the back of shopper’s credit card). This field can be optional if the Allow CVC field in Merchant Setting is disabled . Only for the integration using the Merchant Direct API

card_issuer_bank _country_code

Varchar (2)

Country of the credit card issuing bank

billing_address

Varchar(200)

Shopper’s billing address

billing_address _city

Varchar(50)

Shopper’s billing city

billing_address _region

Varchar(100)

Shopper’s billing region

billing_address _state

Varchar(100)

Shopper’s billing state

billing_address _poscode

Varchar(10)

Shopper’s billing postcode

billing_address _country_code

Varchar(10)

Shopper’s billing country code

receiver_name _for_shipping

Varchar(100)

Name of person to receive goods at the shipping address provided.

shipping_address

Varchar(200)

Shopper’s shipping address

shipping_address _city

Varchar(50)

Shopper’s shipping city

shipping_address _region

Varchar(100)

Shopper’s shipping region

shipping_address _state

Varchar(100)

Shopper’s shipping state

shipping_address _poscode

Varchar(10)

Shopper’s shipping postcode

shipping_address _country_code

Varchar(10)

Shopper’s shipping country code

shippingcost

Numeric

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)

Shopper's phone number

mparam1

Varchar(200)

Additional parameter the merchant wish to receive back as response for processing. This value is not stored by Faspay e-Payment.

mparam2

Varchar(200)

Additional parameter the merchant wish to receive back as response for processing. This value is not stored by Faspay e-Payment.

<?php

$tranid = date("YmdGis");
$signaturecc=sha1('##'.strtoupper('sophia_store').'##'.strtoupper('ejeussad').'##'.$tranid.'##1000.00##'.'0'.'##');

$post = array(
"TRANSACTIONTYPE"               => '1',
"RESPONSE_TYPE"                 => '2',
"LANG"                          => '',                              
"MERCHANTID"                    => 'sophia_store',                            
"PAYMENT_METHOD"                => '1',
"TXN_PASSWORD"                  => 'ejeussad',
"MERCHANT_TRANID"               => $tranid,       
"CURRENCYCODE"                  => 'IDR',
"AMOUNT"                        => '1000.00',
"CUSTNAME"                      => 'John Doe',
"CUSTEMAIL"                     => 'john@gmail.com',
"DESCRIPTION"                   => 'Faber Castell Pencil',
"RETURN_URL"                    => 'http://localhost/creditcard/merchant_return_page.php', 
"SIGNATURE"                     => $signaturecc, 
"BILLING_ADDRESS"               => 'Jl. pintu air raya',
"BILLING_ADDRESS_CITY"          => 'Jakarta',
"BILLING_ADDRESS_REGION"        => 'DKI Jakarta',
"BILLING_ADDRESS_STATE"         => 'DKI Jakarta',
"BILLING_ADDRESS_POSCODE"       => '10710',
"BILLING_ADDRESS_COUNTRY_CODE"  => 'ID',
"RECEIVER_NAME_FOR_SHIPPING"    => 'John Doe',
"SHIPPING_ADDRESS"              => 'Jl. pintu air raya',
"SHIPPING_ADDRESS_CITY"         => 'Jakarta',
"SHIPPING_ADDRESS_REGION"       => 'DKI Jakarta',
"SHIPPING_ADDRESS_STATE"        => 'DKI Jakarta',
"SHIPPING_ADDRESS_POSCODE"      => '10710',
"SHIPPING_ADDRESS_COUNTRY_CODE" => 'ID',
"SHIPPINGCOST"                  => '0.00',
"PHONE_NO"                      => '0897867688989',
"MPARAM1"                       => '',
"MPARAM2"                       => '',
"PYMT_IND"                      => '', 
"PYMT_CRITERIA"                 => '', 
"PYMT_TOKEN"                    => '', 
 
 /* ==== customize input card page ===== */ 
 "style_merchant_name"         => 'black',
 "style_order_summary"         => 'black',
 "style_order_no"              => 'black',
 "style_order_desc"            => 'black',
 "style_amount"                => 'black',
 "style_background_left"       => '#fff',
 "style_button_cancel"         => 'grey',
 "style_font_cancel"           => 'white',
  /* ==== logo directly to your url source ==== */ 
 "style_image_url"           => 'http://url_merchant/image.png',
   );

//Dev ke = https://fpgdev.faspay.co.id/payment
$string = '<form method="post" name="form" action="https://fpg.faspay.co.id/payment">'; 
if ($post != null) {
foreach ($post as $name=>$value) {
$string .= '<input type="hidden" name="'.$name.'" value="'.$value.'">';
    }
 }

$string .= '</form>';
$string .= '<script> document.form.submit();</script>';
echo $string;
exit;

?>

Response Parameter

Response parameters are parameters that will be delivered by the system Faspay in response to the request parameters that have been sent by the merchant system. If no parameters are appropriate / value is incorrect, the transaction will be rejected in the system Faspay.

Parameter

Data Type

M/O/C

Description

payment_method

Varchar(1)

Indicates the payment mode used for this transaction.

merchantid

Varchar (30)

Your Faspay e-Payment Merchant ID

merchant_tranid

Varchar(100)

Merchant’s own assigned transaction id as passed in from the request.

err_code

Varchar(10)

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)

Error description from Faspay e-Payment based on the ERR_CODE.

usr_code

Varchar(4)

User Code returns from Faspay e-Payment. 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)

User Message returns from Faspay e-Payment. A user message 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

txn_status

Varchar(3)

Transaction status from Faspay e-Payment. Please refer to Appendix B for full list of transaction status.

A – Authorized

S – Sales

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.

description

Varchar(100)

Transaction description as passed in from the request.

currencycode

Varchar(3)

Indicate the currency of this transaction. Refer to Appendix I for Supported Currencies E.g. IDR, USD, SGD etc.

amount

Numeric(10)

Transaction amount as passed in from the request.

signature

Varchar(40)

Transaction signature of response for data integrity checking.

eui

Varchar(3)

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

transactionid

Integer

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)

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.

transactiontype

Varchar(2)

Return transaction type corresponding to the original request

is_blacklisted

Varchar(5)

Indicate whether the transaction is blacklisted. Value is ‘Yes’ or ‘No’ In the event of error, this field may be empty.

fraudrisklevel

Integer

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.

exceed_high_risk

Varchar(3)

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 empOnly for the integration using the Merchant Direct API

cardtype

Char(1)

Indicates the card type used.

MasterCard=M

Visa=V

JCB=J

AMEX=A

Only for the integration using the Merchant Direct API

card_no_partial

Varchar(20)

Returns first 6 and last 4 digits of credit card. E.g.: 455555XXXXXX1234 In the event of error, this field may be empty. Only for the integration using the Merchant Direct API

acquirer_bank

Varchar(3)

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)

Response code or error code from bank. In the event of error, this field may be empty.

bank_res_msg

Varchar(250)

Bank description on the response based on BANK_RES_CODE. In the event of error, this field may be empty.

auth_id

Varchar(20)

Bank approval code (if transaction is approved). If transaction is declined or error, this parameter will be empty.

mparam1

Varchar(200)

Additional parameter as what is passed in request. This value is not stored by Faspay e-Payment.

mparam2

Varchar(200)

Additional parameter as what is passed in request. This value is not stored by Faspay e-Payment

whitelist_card

Varchar(3)

Indicate whether the transaction is use whitelist card. Value is ‘Yes’ or ‘No’

custname

Varchar(120)

Shopper’s name.

acquirer_id

VarcharI(30)

Your Faspay e-Payment Acquirer ID

is_on_us

Varchar(3)

Indicate whether the transaction is using on us card. Value is ‘Yes’ or ‘No’

"PAYMENT_METHOD"       => '1',
"MERCHANTID"           => 'sophia_store',
"MERCHANT_TRANID"      => '2016/03/000072',
"ERR_CODE"             => 0,
"ERR_DESC"             => 'No error',
"USR_CODE"             => 101,
"USR_MSG"              => 'Transaction approved',
"TXN_STATUS"           => 'A',
"CUSTNAME"             => 'John Doe',
"DESCRIPTION"          => 'DeWalt Standard Heatgun',
"EUI"                  => 'SUC',
"CURRENCYCODE"         => 'IDR',
"AMOUNT"               => '780000.00',
"SIGNATURE"            => '387CF32EF09215C73011943F06CB44055CA3BE05',
"TRANSACTIONID"        => 21536,
"TRANSACTIONTYPE"      => 1,
"TRANDATE"             => '04-03-2016 15:22:46',
"ACQUIRER_ID"          => 'mandiri',
"MPARAM1"              => '',
"MPARAM2"              => '',
"IS_BLACKLISTED"       => 'No',
"FRAUDRISKSCORE"       => 75,
"FRAUDRISKLEVEL"       => 2,
"EXCEED_HIGH_RISK"     => 'Yes',
"CARDNAME"             => 'John Doe',
"CARD_NO_PARTIAL"      => '413718xxxxxx3783',
"CARDTYPE"             => 'V',
"is_on_us"             => 'Yes',
"ACQUIRER_BANK"        => 016,
"BANK_RES_CODE"        => 00,
"BANK_RES_MSG"         => 'APPROVED OR COMPLETED',
"AUTH_ID"              => 657399,
"BANK_REFERENCE"       => 10519,
"WHITELIST_CARD"       => 'No'

PreviousCredit Card NextAdditional API Integration

Last updated 6 months ago