GPN DATA - Documentation

Alternative Payments Integration

Overview
API Commands

GPN DATA MERCHANT API
INTEGRATION GUIDE

API INTEGRATION GUIDE FOR ALTERNATIVE PAYMENTS

cURL Request Sample

Test Server: https://txtest.txpmnts.com/api/transaction/

PROD. Server: https://txpmnts.com/api/transaction/

   
        $ch = curl_init();
         
         
        //Set up curl parameters
		curl_setopt($ch, CURLOPT_URL, 'https://txtest.txpmnts.com/api/transaction/');        // set remote address
        curl_setopt($ch, CURLOPT_POSTFIELDS, $requestMessage);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);    // Make CURL pass the response as a curl_exec return value instead of outputting to STDOUT
        curl_setopt($ch, CURLOPT_POST, 1);                // Activate the POST method
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
        curl_setopt($ch, CURLOPT_VERBOSE, 0);
        // curl_setopt($ch, CURLOPT_HEADER, 0);
        curl_setopt($ch, CURLOPT_HTTPHEADER, [
            'Content-type: text/xml',
            'Accept: text/xml'
        ]);
         
        //execute the connection
        $result = curl_exec($ch);
         
        echo "
Result Code:".$result.']]>';
         
        $debugoutput = curl_getinfo($ch);
         
        $curl_error_message = curl_error($ch); // must retrieve an error message (if any) before closing the curl object
         
        echo "
Curl Error message:".$curl_error_message;
         
        curl_close($ch);
 
         
        //Trim headers
        $pos = strstr($result, "\n");
        echo '
Result'.$pos;

GPN DATA MERCHANT API

API Commands are send from merchant’s system to the Gateway with HTTP protocol. Request need to be sent to URL provided by GPN Data. Data is transmitted as POST parameter strrequest , which contain XML string with the API Command required details.

700 – Start Credit Card charge (3DS Enabled)

Description: Allows the merchant to submit a charge to the cardholder’s Credit Card and includes 3DS capability when 3DS is specified in the Merchant Agreement. (See Appendix for “3DS Explanation”).

700 Request Data description:

Node	Include in Checksum (in this order)	Optional	Data Type	Description
apiUser	YES (1)	YES	Character max 50.	The API user assigned by the Gateway to the merchant. Can be obtained from the website inside your merchant account.
apiPassword	YES (2)	YES	Character max 50.	The API password assigned by Gateway to the merchant. Can be obtained from the website inside your merchant account.
apiCmd	YES (3)	YES	700	3 digit numeric transaction code must be 700
transaction		YES	Xml Node	Section containing Transaction Information
transaction->merchanttransid	YES (4)	YES	Character max 50.	Merchant transaction id must be included in the request. Merchant transaction id must be unique for each transaction.
transaction->amount	YES (5)	YES	Number with point decimal	Full amount to charge in currency specified. The amount must be specified as a number with decimal point and 2 digits to the right of the decimal point. Decimal separator must be point (.). example: 3500.25 = Three thousand five hundred units of currency and twenty five hundredths of a single unit of currency.
transaction->curcode	YES (6)	YES	Character 3.	May only use currencies specified in the Merchant Agreement.
transaction->description		YES	Character max 100.	Description of the charge. When available, that description may be used in the billing statement of the card holder.
transaction->merchantspecific1		OPT	Character max 200.	Merchant specific data for merchant use only. Data sent in this field will be stored and sent in any communication or response to the merchant.
transaction->merchantspecific2		OPT	Character max 200.	Merchant specific data for merchant use only. Data sent in this field will be stored and sent in any communication or response to the merchant.
transaction->merchantspecific3		OPT	Character max 200.	Merchant specific data for merchant use only. Data sent in this field will be stored and sent in any communication or response to the merchant.
transaction->merchantspecific4		OPT	Character max 200.	Merchant specific data for merchant use only. Data sent in this field will be stored and sent in any communication or response to the merchant.
transaction->merchantspecific5		OPT	Character max 200.	Merchant specific data for merchant use only. Data sent in this field will be stored and sent in any communication or response to the merchant.
rebill		No	Xml Node	Section containing Rebill Information. Note: Availability is subject to terms of Merchant Agreement. This tag must be present to indicate that this is the initiation of a Rebill sequence. If no other rebill tag is used, you must use or Note: Merchants not authorized for should not use these tags.
rebill->freq		No	Character max 5.	Rebilling frequency. Valid values are: d (days), w (weeks), m (months), y (years). Examples: 7d = rebill every 7 days 1m = rebill every month If not provided, default frequency from Merchant account profile will be used.
rebill->start		No	Date format yyyy-mm-dd	Optional start date for rebill period. Additional rebills will be calculated from this date at rebill->freq for number of occurrences in rebill->count (this date counts as the first of rebill->count). If not provided, default start date from Merchant account profile will be used.
rebill->amount		No	Number with point decimal	Rebilling amount to charge in currency specified. If not provided, default amount from Merchant account profile will be used.
rebill->desc		No	Character max 100.	Rebilling description. If not provided, default description from Merchant account profile will be used.
rebill->count		No	Number 1-2 digits	Maximum number of Rebilling transactions. If not provided, default count from Merchant account profile will be used.
rebill->followup_time		No	Date format yyyy-mm-dd	Date at which transaction followup (conversion) will be scheduled. If not present, default date from Merchant account profile may be used. See detailed description of followup in Appendix
rebill->followup_amount		No	Number with point decimal	Transaction followup (conversion) amount to charge in currency specified. If not provided, default followup amount from Merchant account profile may be used. See detailed description of followup in Appendix
customer		YES	Xml Node	Section containing Customer Information
customer->firstname		YES	Character max 50.	First name of the Customer.
customer->lastname		YES	Character max 50.	Last name of the Customer.
customer->birthday		YES*	Number 1-2 digits	Day of birth of the Customer (1-31) Important Note: If Merchant cannot provide such data, he/she should contact GPN’s Sales Account Manager. Tag will be set as “Optional” only with GPN’s Sales Account Manager approval.
customer->birthmonth		YES*	Number 1-2 digits	Month of birth of the customer (1-12) Important Note: If Merchant cannot provide such data, he/she should contact GPN’s Sales Account Manager. Tag will be set as “Optional” only with GPN’s Sales Account Manager approval.
customer->birthyear		YES*	Number 4 digits	Year of birth of the customer (1900-2100) Important Note: If Merchant cannot provide such data, he/she should contact GPN’s Sales Account Manager. Tag will be set as “Optional” only with GPN’s Sales Account Manager approval.
customer->email		YES	Character max 100.	Email of the Customer.
customer->countryiso		YES	Character exactly 3.	3 letter ISO country code of the Customer. Full list of codes can be obtained from the website inside your merchant account.
customer->stateregioniso		YES	Character max 3.	1-3 character ISO 3166 state/region/province code of the Customer. Full list of codes can be obtained from the website inside your merchant account.
customer->zippostal		YES	Character max 15.	Customer’s Zipcode or postal code.
customer->city		YES	Character max 50.	Customer’s City
customer->address1		YES	Character max 75.	Customer’s address line 1
customer->address2		OPT	Character max 75.	Customer’s address line 2
customer->phone1phone		YES	Character max 20.	Customer’s phone number, including country code and area code. Digits only, without (+) character
customer->phone2phone		OPT	Character max 20.	Customer’s phone number, including country code and area code. Digits only, without (+) character
customer->accountid		YES	Character max 50.	Customer unique account id used inside the merchant organization.
customer->ipaddress		YES	Character max 15.	Full IP address of the customer used for this transaction
creditcard		COND	Xml Node	Section containing sepa bank account Information. Required for sepa transactions, forbidden for credit card transactions.
creditcard->ccnumber	YES (7)	YES	Character max 16.	Full credit card number without dashes or separators. Only numbers.
creditcard->cccvv	YES (8)	YES	Character max 4.	Verification Code of the Credit Card
creditcard->expmonth		YES	Numeric 1-2	Expiration month of the credit card.
creditcard->expyear		YES	Numeric 4	Expiration year of the credit card.
creditcard->nameoncard	YES (9)	YES	Character max 50.	Name as shown your financial institution (if not, fist and last name)
creditcard->billingcountryiso		YES	Character exactly 3.	3-digits ISO country code of the Customer. Full list of codes can be obtained from the website inside your merchant account.
creditcard->billingstateregioniso		YES	Character max 5.	ISO 3166 state/region/province code of the Customer. Full list of codes can be obtained from the website inside your merchant account.
creditcard->billingzippostal		YES	Character max 15.	Customer’s Zip code or postal code.
creditcard->billingcity		YES	Character max 50.	Customer’s City
creditcard->billingaddress1		YES	Character max 75.	Customer’s address line 1
creditcard->billingaddress2		OPT	Character max 75.	Customer’s address line 2
creditcard->billingphone1phone		YES	Character max 20.	Customer’s phone number, including country code and area code. Digits only, without (+) character
creditcard->issuemonth		OPT	Numeric 1-2	Issuing month of the credit card.
creditcard->issueyear		OPT	Numeric 4	Issuing year of the credit card.
sepa		COND	Xml Node	Section containing sepa bank account Information. Required for sepa transactions, forbidden for credit card transactions.
sepa->iban	YES (7)	YES	Characters min 16, max 40.	Full international bank account number without dashes or separators. Only alphanumeric characters.
sepa->bic	YES (8)	YES	Character min 8, max 11.	Bank identitfication code (a.k.a. SWIFT code) without dashes or separators. Only alphanumeric characters.
checksum		YES	Character 36	SHA-1 calculated using the fields specified by the transaction plus the API key assigned by gateway to the merchant. This field must be calculated using the fields marked as “Include in checksum” (in the order indicated) plus the API key at the end.
auth		YES	Xml Node	Section containing authorization type
auth->type		YES	Character max. 6	This tag Must be present. Valid values are Direct = non- 3DS Charge (Auth/Capture) Auth = non-3DS Auth Only 3DS = 3DS Charge (Auth/Capture) Auth3DS = 3DS Auth Only Note: only those choices available as indicated in the Merchant Profile are accepted.
auth->sid		COND	Character no limit*	This tag is used only during 3D Secure transactions. It is intended to use as a session identification string and it is forwarded to you as a part of your Return URL. (See Appendix for “3D Secure Integration”) Note: Keep in mind that URL length (your Return URL + SID) must be under 2 000 characters
auth-> mdstatus		COND	Character 1	This tag Must be present. Valid values are Y (or lower case) = Authentication process was successful A (or lower case) = Authentication process was attempted U (or lower case) = Unable to authenticate N (or lower case) = Authentication process failed To be taken from ACS Response.
auth->xid		COND	28 byte-long	base-64 encoded XID : Unique Internet transaction ID To be taken from ACS Response.
auth->eci		COND	Numeric 2	Valid values are 01,02,05,06,07 MasterCard: 01 / 02 Visa: 05 / 06 / 07 empty for non-3D transactions To be taken from ACS Response.
auth->cavv		COND	Character 28	contains a 20-byte value that has been Base64 encoded, giving a 28 byte result. To be taken from ACS Response.
auth->cavvAlgorithm		COND	Numeric 1	Digit from [0-9] depending on ACS response. To be taken from ACS Response.

700 – Response

The response to a 700-Start Credit card Charge Transaction is:
• The completion of the transaction if the Merchant Agreement does NOT require 3DS.
• The completion of the transaction if the Merchant Agreement DOES require 3DS and the Issuing Bank is NOT a 3DS participant.
• The end of the first step for a 3DS transaction if the Issuing Bank IS a 3DS participant. The merchant must continue with the 705 command to complete the transaction IF the merchant receives a response from the redirect screen (see Appendix “3DS Explanation” for more information).

Response Data description:

Node	Optional	Data Type	Description
result	YES	Character	Indicates the result of the transaction. SUCCESS: Customer’s Credit Card account has been charged (or AUTHORIZED) with the amount of the transaction. DECLINED: transaction was declined. ERROR: An error has been detected in the request. PENDING: If the Issuing bank has been determined to participate in the 3DS program, this is the normal response and it will include the PaReq and ACS data. The merchant must present a redirect screen to the cardholder, using the URL supplied in the ACS tag and supply the PaReq as a POST parameter. For further instructions see the Appendix “3DS Explanation”
merchanttransid	YES	Character max 50.	Unique merchant transaction id received in the request.
transref	COND	Integer	Gateway’s transaction reference number. Will be sent in the response only if the result is not ERROR. Merchant should save this reference number for support and troubleshooting.
gatetransid	COND	Character 36	Gateway transaction ID. Will be sent in the response only if the result is not ERROR. Merchant should save this reference number for refunds and other transaction activity performed through API.
errorcode	YES	Character 3	Error Code of the transaction or 000 if no error condition found.
errormessage	OPT	Character max 100	Full description of the error.
description	OPT	Character no limit	Optional details of the transaction except in the case of DECLINED and then the reason for the decline. May be null.
ACS	NO	Character string No limit	Not present if not a 3DS transaction or if it is a 3DS transaction and the Issuing Bank is not a participant in the 3DS program. If present, this is the URL for the redirect screen (see Appendix “3DS Explanation”)
parameters	COND	XML node	Not present if not a 3DS transaction or if it is a 3DS transaction and the Issuing Bank is not a participant in the 3DS program. If present, ALL child elements must be transmitted in the redirect screen (see Appendix “3DS Explanation”)
parameters ->PaReq	COND	Encoded character string no limit	This string must be transmitted in the redirect screen (see Appendix “3DS Explanation”)
parameters ->MD	COND	Character string max 50	This is the authorization process ID for the redirect screen (see Appendix “3DS Explanation”). It must be stored and forwarded in API Call 705
parameters ->TermUrl	COND	Character string max 2000	This is the URL where Access Control Server sends response, which need to be forwarded to the Gateway. Depending on Acquiring bank this value may be different than 3DS Return URL provided by merchant
parameters->…	NO	Character string	Optional other parameters that must be transmitted in the redirect screen
rebillwindows	NO	XML Node	Not present unless this is a Rebill Transaction and the Manual Rebill Request has been authorized in the Merchant Agreement and is selected in the Merchant Profile. Section containing valid Manual Rebill Periods (windows of opportunity)
rebillwindows->window	NO	XML attribute	Not present unless this is a Rebill Transaction and the Manual Rebill Request has been authorized in the Merchant Agreement and is selected in the Merchant Profile. No data is contained in this tag, rather the XML tag has two date attributes, each formatted as YYYY-MM-DD HH:MM:SS in UTC. The number of window tags equals transaction->rebill_count and represents the exclusive time periods when a 756 Manual Rebill Request will be accepted and not return an Error

The 700 request is plain XML that contains the following data:

  <?xmlversion="1.0" encoding="utf-8" ?>
	<transaction>
	<apiUser> </apiUser>
	<apiPassword> </apiPassword>
	<apiCmd> </apiCmd>
		<transaction> 
			<merchanttransid> </merchanttransid>
			<amount> </amount>
			<curcode> </curcode>
			<description> </description>
			<merchantspecific1> </merchantspecific1>
			<merchantspecific2> </merchantspecific2>
			<merchantspecific3> </merchantspecific3>
			<merchantspecific4> </merchantspecific4>
			<merchantspecific5> </merchantspecific5>
		</transaction>
		<rebill> 
			<freq> </freq>
			<start> </start>
			<amount> </amount>
			<desc> </desc>
			<count> </count>
			<followup_time> </followup_time>
			<followup_amount> </followup_amount>
		</rebill>
		<customer> 
			<firstname> </firstname>
			<lastname> </lastname>
			<birthday> </birthday>
			<birthmonth> </birthmonth>
			<birthyear> </birthyear>
			<email> </email>
			<countryiso> </countryiso>
			<stateregioniso> </stateregioniso>
			<zippostal> </zippostal>
			<city> </city>
			<address1> </address1>
			<address2> </address2>
			<phone1phone> </phone1phone>
			<phone2phone> </phone2phone>
			<accountid> </accountid>
			<ipaddress> </ipaddress>					
		</customer>
		<creditcard> 
			<ccnumber> </ccnumber>
			<cccvv> </cccvv>
			<expmonth> </expmonth>
			<expyear> </expyear>
			<nameoncard> </nameoncard>
			<billingcountryiso> </billingcountryiso>
			<billingstateregioniso> </billingstateregioniso>
			<billingzippostal> </billingzippostal>
			<billingcity> </billingcity>
			<billingaddress1> </billingaddress1>
			<billingaddress2> </billingaddress2>
			<billingphone1phone> </billingphone1phone>
		</creditcard> 	
		<sepa> 	
			<iban> </iban>
			<bic> </bic>
		</sepa> 
		<checksum> </checksum>
		<auth> 
			<type> </type>
			<sid> </sid>
		</auth> 
	</transaction>

The 700 response is plain XML that contains the following data:


	<?xmlversion="1.0" encoding="utf-8" ?>
	<transaction>
	<result> </result>
	<merchanttransid> </merchanttransid>
	<transref> </transref>
	<gatetransid> </gatetransid>
	<errorcode> </errorcode>
	<errormessage> </errormessage>
	<description> </description>
	<ACS> </ACS>
	<parameters> 
		<PaReq> </PaReq>
		<MD> </MD>
		<TermUrl> </TermUrl>
	</parameters> 
	<rebillwindows> 
<window from="2012-08-15 18:00:00" to="2012-08-19 18:00:00"></window> 
<window from="2012-09-15 18:00:00" to="2012-08-19 18:00:00"></window> 
<window from="2012-10-15 18:00:00" to="2012-08-19 18:00:00"></window> 
	</rebillwindows> 
	</transaction>

QIWI Request Data description:

Payment Option	Supported Country (ISO Code)	Processing Currency
QIWI	RU	‎₽ RUB

Node	Include in Checksum (in this order)	Optional	Data Type	Description
qiwi	COND	XML node	Character max 50.	Section containing qiwi bank account Information. Required for qiwi transactions, forbidden for credit card transactions.
countryiso	YES (2)	YES	Character max 50.	2 or 3 letter ISO country code of the Customer. Full list of codes can be obtained from the website inside your merchant account.
returnurl	YES (3)	YES	Character string No limit	You must specify returnUrl parameter. In response, returnUrl will be returned where customer needs to finish his payment.
holder	YES (4)	YES	Character max 50.	Name as shown your financial institution (if not, fist and last name)

QIWI Response Data description

Node	Optional	Data Type	Description
result	YES	Character	Result indicates the result of the transaction. PENDING: A transfer has been created in the system and is awaiting an action. After the status has been changed, the results will be sent in the 850 Transaction State Notification that will be sent from the system server to the merchant server. Do NOT ASSUME the pending request as APPROVED or DECLINED. ERROR: means error detected in the request, no processing takes place, and transaction was not accepted by the system.
merchanttransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
gatetransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
errorcode	YES	Character 3	Error Code of the transaction or 000 if no error condition found.
errormessage	YES	Character max 100	Full description of the error.
description	OPT	Character no limit	Optional details of the transaction
gatetransid	OPT	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
ACS	YES	Character no limit	`ACS` will be returned where customer needs to finish his payment.

The QIWI request is plain XML that contains the following data:

  
<qiwi> 	
  <countryiso> </countryiso>
  <returnurl> </returnurl>
  <holder> </holder>
</qiwi>

The response to a QIWI - is plain xml un-encoded that contains the following data:


	<?xmlversion="1.0" encoding="utf-8" ?>
	<transaction>
		<result> </result>
		<merchanttransid> </merchanttransid>
		<transref> </merchanttransid>
		<gatetransid> </gatetransid>
		<errorcode> </errorcode>
		<errormessage> </errormessage>
		<description> </description>
		<parameters>
			<gatetransid> </gatetransid>
			<ACS/> 
		</transaction> 
	</transaction>

POLI Request Data description:

Payment Option	Supported Country (ISO Code)	Processing Currency
POLI	AU, NZ	AUD $, NZD $

Node	Include in Checksum (in this order)	Optional	Data Type	Description
POLI	COND	XML node	Character max 50.	Section containing POLI bank account Information. Required for qiwi transactions, forbidden for credit card transactions.
countryiso	YES (2)	YES	Character max 50.	2 or 3 letter ISO country code of the Customer. Full list of codes can be obtained from the website inside your merchant account.
returnurl	YES (3)	YES	Character string No limit	You must specify returnUrl parameter. In response, returnUrl will be returned where customer needs to finish his payment.
holder	YES (4)	YES	Character max 50.	Name as shown your financial institution (if not, fist and last name)

POLI Response Data description

Node	Optional	Data Type	Description
result	YES	Character	Result indicates the result of the transaction. PENDING: A transfer has been created in the system and is awaiting an action. After the status has been changed, the results will be sent in the 850 Transaction State Notification that will be sent from the system server to the merchant server. Do NOT ASSUME the pending request as APPROVED or DECLINED. ERROR: means error detected in the request, no processing takes place, and transaction was not accepted by the system.
merchanttransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
gatetransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
errorcode	YES	Character 3	Error Code of the transaction or 000 if no error condition found.
errormessage	YES	Character max 100	Full description of the error.
description	OPT	Character no limit	Optional details of the transaction
gatetransid	OPT	Character no limit	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
ACS	YES	Character no limit	`ACS` will be returned where customer needs to finish his payment.

The POLI request is plain XML that contains the following data:

  
<poli> 	
  <countryiso> </countryiso>
  <returnurl> </returnurl>
  <holder> </holder>
</poli>

The response to a POLI - is plain xml un-encoded that contains the following data:


	<?xmlversion="1.0" encoding="utf-8" ?>
	<transaction>
		<result> </result>
		<merchanttransid> </merchanttransid>
		<transref> </merchanttransid>
		<gatetransid> </gatetransid>
		<errorcode> </errorcode>
		<errormessage> </errormessage>
		<description> </description>
		<parameters>
			<gatetransid> </gatetransid>
			<ACS/> 
		</transaction> 
	</transaction>

IDEAL Request Data description:

Payment Option	Supported Country (ISO Code)	Processing Currency
IDEAL	NL	€ Euro

Node	Include in Checksum (in this order)	Optional	Data Type	Description
ideal	COND	XML node	Character max 50.	Section containing IDEAL bank account Information. Required for IDEAL transactions, forbidden for credit card transactions.
returnurl	YES (2)	YES	Character max 50.	You must specify returnUrl parameter. In response, returnUrl will be returned where customer needs to finish his payment.
holder	YES (3)	YES	Character string No limit	Name as shown your financial institution (if not, fist and last name)
bankcode	YES (4)	YES	Character max 50.	Customer’s Bank Code
Bank Codes			bankCode	Bank name
			ABN_AMRO	ABN Amro
			ASN_BANK	ASN Bank
			ING	ING
			KNAB_BANK	Knab Bank
			RABOBANK	Rabobank
			SNS_REGIO_BANK	SNS Regio Bank
			SNS_BANK	SNS Bank
			TRIODOS_BANK	Triodos Bank
			VAN_LANSCHOT_BANKIERS	Van Lanschot Bankiers

IDEAL Response Data description

Node	Optional	Data Type	Description
result	YES	Character	Result indicates the result of the transaction. PENDING: A transfer has been created in the system and is awaiting an action. After the status has been changed, the results will be sent in the 850 Transaction State Notification that will be sent from the system server to the merchant server. Do NOT ASSUME the pending request as APPROVED or DECLINED. ERROR: means error detected in the request, no processing takes place, and transaction was not accepted by the system.
merchanttransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
gatetransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
errorcode	YES	Character 3	Error Code of the transaction or 000 if no error condition found.
errormessage	YES	Character max 100	Full description of the error.
description	OPT	Character no limit	Optional details of the transaction
gatetransid	OPT	Character no limit	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
ACS	YES	Character no limit	`ACS` will be returned where customer needs to finish his payment.

The IDEAL request is plain XML that contains the following data:

  
<ideal> 	
  <countryiso> </countryiso>
  <returnurl> </returnurl>
  <holder> </holder>
  <bankcode> </bankcode>
</ideal>

The response to a IDEAL - is plain xml un-encoded that contains the following data:


	<?xmlversion="1.0" encoding="utf-8" ?>
	<transaction>
		<result> </result>
		<merchanttransid> </merchanttransid>
		<transref> </merchanttransid>
		<gatetransid> </gatetransid>
		<errorcode> </errorcode>
		<errormessage> </errormessage>
		<description> </description>
		<parameters>
			<gatetransid> </gatetransid>
			<ACS/> 
		</transaction> 
	</transaction>

ALIPAY Request Data description:

Payment Option	Supported Country (ISO Code)	Processing Currency
ALIPAY	CN	¥ CNY

Node	Include in Checksum (in this order)	Optional	Data Type	Description
alipay	COND	XML node	Character max 50.	Section containing ALIPAY bank account Information. Required for ALIPAY transactions, forbidden for credit card transactions.
countryiso	YES (2)	YES	Character max 50.	2 or 3 letter ISO country code of the Customer. Full list of codes can be obtained from the website inside your merchant account.
returnurl	YES (3)	YES	Character string No limit	You must specify returnUrl parameter. In response, returnUrl will be returned where customer needs to finish his payment.
holder	YES (4)	YES	Character max 50.	Name as shown your financial institution (if not, fist and last name)

ALIPAY Response Data description

Node	Optional	Data Type	Description
result	YES	Character	Result indicates the result of the transaction. PENDING: A transfer has been created in the system and is awaiting an action. After the status has been changed, the results will be sent in the 850 Transaction State Notification that will be sent from the system server to the merchant server. Do NOT ASSUME the pending request as APPROVED or DECLINED. ERROR: means error detected in the request, no processing takes place, and transaction was not accepted by the system.
merchanttransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
gatetransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
errorcode	YES	Character 3	Error Code of the transaction or 000 if no error condition found.
errormessage	YES	Character max 100	Full description of the error.
description	OPT	Character no limit	Optional details of the transaction
gatetransid	OPT	Character no limit	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
ACS	YES	Character no limit	`ACS` will be returned where customer needs to finish his payment.

The ALIPAY request is plain XML that contains the following data:

  
<alipay> 	
  <countryiso> </countryiso>
  <returnurl> </returnurl>
  <holder> </holder>
</alipay>

The response to a ALIPAY - is plain xml un-encoded that contains the following data:


	<?xmlversion="1.0" encoding="utf-8" ?>
	<transaction>
		<result> </result>
		<merchanttransid> </merchanttransid>
		<transref> </merchanttransid>
		<gatetransid> </gatetransid>
		<errorcode> </errorcode>
		<errormessage> </errormessage>
		<description> </description>
		<parameters>
			<gatetransid> </gatetransid>
			<ACS/> 
		</transaction> 
	</transaction>

SOFORT Request Data description:

Payment Option	Supported Country (ISO Code)	Processing Currency
SOFORT Überweisung	AT, BE, DE, IT, NL, ES, SK	€ Euro

Node	Include in Checksum (in this order)	Optional	Data Type	Description
sofort	COND	XML node	Character max 50.	Section containing SOFORT bank account Information. Required for SOFORT transactions, forbidden for credit card transactions.
bic	YES (2)	YES	Integer	Customer’s BIC
countryiso	YES (2)	YES	Character max 50.	2 or 3 letter ISO country code of the Customer. Full list of codes can be obtained from the website inside your merchant account.
returnurl	YES (3)	YES	Character No limit	You must specify returnUrl parameter. In response, returnUrl will be returned where customer needs to finish his payment.
holder	YES (4)	YES	Character max 50.	Name as shown your financial institution (if not, fist and last name)

SOFORT Response Data description

Node	Optional	Data Type	Description
result	YES	Character	Result indicates the result of the transaction. PENDING: A transfer has been created in the system and is awaiting an action. After the status has been changed, the results will be sent in the 850 Transaction State Notification that will be sent from the system server to the merchant server. Do NOT ASSUME the pending request as APPROVED or DECLINED. ERROR: means error detected in the request, no processing takes place, and transaction was not accepted by the system.
merchanttransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
gatetransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
errorcode	YES	Character 3	Error Code of the transaction or 000 if no error condition found.
errormessage	YES	Character max 100	Full description of the error.
description	OPT	Character no limit	Optional details of the transaction
gatetransid	OPT	Character no limit	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
ACS	YES	Character no limit	`ACS` will be returned where customer needs to finish his payment.

The SOFORT request is plain XML that contains the following data:

  
<sofort> 	
  <bic> </bic>
  <countryiso> </countryiso>
  <returnurl> </returnurl>
  <holder> </holder>
</sofort>

The response to a SOFORT - is plain xml un-encoded that contains the following data:


	<?xmlversion="1.0" encoding="utf-8" ?>
	<transaction>
		<result> </result>
		<merchanttransid> </merchanttransid>
		<transref> </merchanttransid>
		<gatetransid> </gatetransid>
		<errorcode> </errorcode>
		<errormessage> </errormessage>
		<description> </description>
		<parameters>
			<gatetransid> </gatetransid>
			<ACS/> 
		</transaction> 
	</transaction>

GIROPAY Request Data description:

Payment Option	Supported Country (ISO Code)	Processing Currency
GiroPay	DE	€ Euro

Node	Include in Checksum (in this order)	Optional	Data Type	Description
giropay	COND	XML node	Character max 50.	Section containing GIROPAY bank account Information. Required for GIROPAY transactions, forbidden for credit card transactions
bic	YES (2)	YES	Character max 50.	Customer’s BIC
countryiso	YES (2)	YES	Character max 50.	2 or 3 letter ISO country code of the Customer. Full list of codes can be obtained from the website inside your merchant account.
returnurl	YES (3)	YES	Character string No limit	You must specify returnUrl parameter. In response, returnUrl will be returned where customer needs to finish his payment.
holder	YES (4)	YES	Character max 50.	Name as shown your financial institution (if not, fist and last name)

GIROPAY Response Data description

Node	Optional	Data Type	Description
result	YES	Character	Result indicates the result of the transaction. PENDING: A transfer has been created in the system and is awaiting an action. After the status has been changed, the results will be sent in the 850 Transaction State Notification that will be sent from the system server to the merchant server. Do NOT ASSUME the pending request as APPROVED or DECLINED. ERROR: means error detected in the request, no processing takes place, and transaction was not accepted by the system.
merchanttransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
gatetransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
errorcode	YES	Character 3	Error Code of the transaction or 000 if no error condition found.
errormessage	YES	Character max 100	Full description of the error.
description	OPT	Character no limit	Optional details of the transaction
gatetransid	OPT	Character no limit	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
ACS	YES	Character no limit	`ACS` will be returned where customer needs to finish his payment.

The GIROPAY request is plain XML that contains the following data:

  
<giropay> 	
  <bic> </bic>
  <countryiso> </countryiso>
  <returnurl> </returnurl>
  <holder> </holder>
</giropay>

The response to a GIROPAY - is plain xml un-encoded that contains the following data:


	<?xmlversion="1.0" encoding="utf-8" ?>
	<transaction>
		<result> </result>
		<merchanttransid> </merchanttransid>
		<transref> </merchanttransid>
		<gatetransid> </gatetransid>
		<errorcode> </errorcode>
		<errormessage> </errormessage>
		<description> </description>
		<parameters>
			<gatetransid> </gatetransid>
			<ACS/> 
		</transaction> 
	</transaction>

PRZELEWY 24 Request Data description:

Payment Option	Supported Country (ISO Code)	Processing Currency
Przelewy24	PL	€ Euro

Node	Include in Checksum (in this order)	Optional	Data Type	Description
przelewy24	COND	XML node	Character max 50.	Section containing przelewy24 bank account Information. Required for przelewy24 transactions, forbidden for credit card transactions
countryiso	YES (2)	YES	Character max 50.	2 or 3 letter ISO country code of the Customer. Full list of codes can be obtained from the website inside your merchant account.
returnurl	YES (3)	YES	Character string No limit	You must specify returnUrl parameter. In response, returnUrl will be returned where customer needs to finish his payment.
holder	YES (4)	YES	Character max 50.	Name as shown your financial institution (if not, fist and last name)

PRZELEWY 24 Response Data description

Node	Optional	Data Type	Description
result	YES	Character	Result indicates the result of the transaction. PENDING: A transfer has been created in the system and is awaiting an action. After the status has been changed, the results will be sent in the 850 Transaction State Notification that will be sent from the system server to the merchant server. Do NOT ASSUME the pending request as APPROVED or DECLINED. ERROR: means error detected in the request, no processing takes place, and transaction was not accepted by the system.
merchanttransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
gatetransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
errorcode	YES	Character 3	Error Code of the transaction or 000 if no error condition found.
errormessage	YES	Character max 100	Full description of the error.
description	OPT	Character no limit	Optional details of the transaction
gatetransid	OPT	Character no limit	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
ACS	YES	Character no limit	`ACS` will be returned where customer needs to finish his payment.

The PRZELEWY 24 request is plain XML that contains the following data:

  
<przelewy24> 	
  <countryiso> </countryiso>
  <returnurl> </returnurl>
  <holder> </holder>
</przelewy24>

The response to a PRZELEWY 24 - is plain xml un-encoded that contains the following data:


	<?xmlversion="1.0" encoding="utf-8" ?>
	<transaction>
		<result> </result>
		<merchanttransid> </merchanttransid>
		<transref> </merchanttransid>
		<gatetransid> </gatetransid>
		<errorcode> </errorcode>
		<errormessage> </errormessage>
		<description> </description>
		<parameters>
			<gatetransid> </gatetransid>
			<ACS/> 
		</transaction> 
	</transaction>

CASHU Request Data description:

Payment Option	Supported Country (ISO Code)	Processing Currency
CashU	EG, JO, SA, AE	$ USD

Node	Include in Checksum (in this order)	Optional	Data Type	Description
cashu	COND	XML node	Character max 50.	Section containing CASHU bank account Information. Required for CASHU transactions, forbidden for credit card transactions
countryiso	YES (2)	YES	Character max 50.	2 or 3 letter ISO country code of the Customer. Full list of codes can be obtained from the website inside your merchant account.
returnurl	YES (3)	YES	Character string No limit	You must specify returnUrl parameter. In response, returnUrl will be returned where customer needs to finish his payment.
holder	YES (4)	YES	Character max 50.	Name as shown your financial institution (if not, fist and last name)

CASHU Response Data description

Node	Optional	Data Type	Description
result	YES	Character	Result indicates the result of the transaction. PENDING: A transfer has been created in the system and is awaiting an action. After the status has been changed, the results will be sent in the 850 Transaction State Notification that will be sent from the system server to the merchant server. Do NOT ASSUME the pending request as APPROVED or DECLINED. ERROR: means error detected in the request, no processing takes place, and transaction was not accepted by the system.
merchanttransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
gatetransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
errorcode	YES	Character 3	Error Code of the transaction or 000 if no error condition found.
errormessage	YES	Character max 100	Full description of the error.
description	OPT	Character no limit	Optional details of the transaction
gatetransid	OPT	Character no limit	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
ACS	YES	Character no limit	`ACS` will be returned where customer needs to finish his payment.

The CASHU request is plain XML that contains the following data:

  
<cashu> 	
  <countryiso> </countryiso>
  <returnurl> </returnurl>
  <holder> </holder>
</cashu>

The response to a CASHU - is plain xml un-encoded that contains the following data:


	<?xmlversion="1.0" encoding="utf-8" ?>
	<transaction>
		<result> </result>
		<merchanttransid> </merchanttransid>
		<transref> </merchanttransid>
		<gatetransid> </gatetransid>
		<errorcode> </errorcode>
		<errormessage> </errormessage>
		<description> </description>
		<parameters>
			<gatetransid> </gatetransid>
			<ACS/> 
		</transaction> 
	</transaction>

mCoinz Request Data description:

Payment Option	Supported Country (ISO Code)	Processing Currency
mCoinz	BH, EG, JO, KW, LB, OM, QA, AE	$ USD

Node	Include in Checksum (in this order)	Optional	Data Type	Description
mcoinz	COND	XML node	Character max 50.	Section containing mcoinz bank account Information. Required for mcoinz transactions, forbidden for credit card transactions
countryiso	YES (2)	YES	Character max 50.	2 or 3 letter ISO country code of the Customer. Full list of codes can be obtained from the website inside your merchant account.
returnurl	YES (3)	YES	Character string No limit	You must specify returnUrl parameter. In response, returnUrl will be returned where customer needs to finish his payment.
holder	YES (4)	YES	Character max 50.	Name as shown your financial institution (if not, fist and last name)
pincode	YES (4)	YES	String	mCoinz voucher pin code

mCoinz Response Data description

Node	Optional	Data Type	Description
result	YES	Character	Result indicates the result of the transaction. PENDING: A transfer has been created in the system and is awaiting an action. After the status has been changed, the results will be sent in the 850 Transaction State Notification that will be sent from the system server to the merchant server. Do NOT ASSUME the pending request as APPROVED or DECLINED. ERROR: means error detected in the request, no processing takes place, and transaction was not accepted by the system.
merchanttransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
gatetransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
errorcode	YES	Character 3	Error Code of the transaction or 000 if no error condition found.
errormessage	YES	Character max 100	Full description of the error.
description	OPT	Character no limit	Optional details of the transaction
gatetransid	OPT	Character no limit	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
ACS	YES	Character no limit	`ACS` will be returned where customer needs to finish his payment.

The mCoinz request is plain XML that contains the following data:

  
<mcoinz> 	
  <countryiso> </countryiso>
  <returnurl> </returnurl>
  <holder> </holder>
  <pincode> </pincode>
</mcoinz>

The response to a mCoinz - is plain xml un-encoded that contains the following data:


	<?xmlversion="1.0" encoding="utf-8" ?>
	<transaction>
		<result> </result>
		<merchanttransid> </merchanttransid>
		<transref> </merchanttransid>
		<gatetransid> </gatetransid>
		<errorcode> </errorcode>
		<errormessage> </errormessage>
		<description> </description>
		<parameters>
			<gatetransid> </gatetransid>
			<ACS/> 
		</transaction> 
	</transaction>

SafetyPay Request Data description:

Payment Option	Supported Country (ISO Code)	Processing Currency
SafetyPay	AT, CO, CR, DE, ES, MX, NI, NL, PA, PE	€ Euro

Node	Include in Checksum (in this order)	Optional	Data Type	Description
safetypay	COND	XML node	Character max 50.	Section containing SafetyPay bank account Information. Required for SafetyPay transactions, forbidden for credit card transactions.
Funding Country Code(3)	YES (2)	YES	String	2 or 3 letter ISO country code of the Customer. Full list of codes can be obtained from the website inside your merchant account.
Return URL	YES (3)	YES	Character no limit*	Customer’s Return URL
holder	YES (4)	YES	Character string No limit	Name as shown your financial institution (if not, fist and last name)

SafetyPay Response Data description

Node	Optional	Data Type	Description
result	YES	Character	Result indicates the result of the transaction. PENDING: A transfer has been created in the system and is awaiting an action. After the status has been changed, the results will be sent in the 850 Transaction State Notification that will be sent from the system server to the merchant server. Do NOT ASSUME the pending request as APPROVED or DECLINED. ERROR: means error detected in the request, no processing takes place, and transaction was not accepted by the system.
merchanttransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
gatetransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
errorcode	YES	Character 3	Error Code of the transaction or 000 if no error condition found.
errormessage	YES	Character max 100	Full description of the error.
description	OPT	Character no limit	Optional details of the transaction
gatetransid	OPT	Character no limit	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
ACS	YES	Character no limit	`ACS` will be returned where customer needs to finish his payment.

The SafetyPay request is plain XML that contains the following data:

  
<safetypay> 	
  <countryiso> </countryiso>
  <returnurl> </returnurl>
  <holder> </holder>
</safetypay>

The response to a SafetyPay - is plain xml un-encoded that contains the following data:


	<?xmlversion="1.0" encoding="utf-8" ?>
	<transaction>
		<result> </result>
		<merchanttransid> </merchanttransid>
		<transref> </merchanttransid>
		<gatetransid> </gatetransid>
		<errorcode> </errorcode>
		<errormessage> </errormessage>
		<description> </description>
		<parameters>
			<gatetransid> </gatetransid>
			<ACS/> 
		</transaction> 
	</transaction>

SEPA EXPRESS Request Data description:

Payment Option	Supported Country (ISO Code)	Processing Currency
SEPA	AT, BE, BG, HR, CY, CZ, DK, EE, FI, FR, DE, GI, GR, HU, IS, IE, IT, LV, LI, LT, LU, MC, MT, NL, NO, PL, PT, RO, SK, SI, SM, ES, SE, CH, GB*	€ Euro

Node	Include in Checksum (in this order)	Optional	Data Type	Description
sepa	COND	XML node	Character max 50.	Section containing SEPA bank account Information. Required for SEPA transactions, forbidden for credit card transactions
iban	YES (2)	YES	String	customer’s IBAN code
bic	YES (2)	YES	Character max 50.	Customer’s BIC
holder	YES (4)	YES	Character max 50.	Name as shown your financial institution (if not, fist and last name)

SEPA EXPRESS Response Data description

Node	Optional	Data Type	Description
result	YES	Character	Result indicates the result of the transaction. PENDING: A transfer has been created in the system and is awaiting an action. After the status has been changed, the results will be sent in the 850 Transaction State Notification that will be sent from the system server to the merchant server. Do NOT ASSUME the pending request as APPROVED or DECLINED. ERROR: means error detected in the request, no processing takes place, and transaction was not accepted by the system.
merchanttransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
gatetransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
errorcode	YES	Character 3	Error Code of the transaction or 000 if no error condition found.
errormessage	YES	Character max 100	Full description of the error.
description	OPT	Character no limit	Optional details of the transaction
gatetransid	OPT	Character no limit	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
ACS	YES	Character no limit	`ACS` will be returned where customer needs to finish his payment.

The SEPA EXPRESS request is plain XML that contains the following data:

  
<sepa> 	
  <iban> </iban>
  <bic> </bic>
  <holder> </holder>
</sepa>

The response to a SEPA - is plain xml un-encoded that contains the following data:


	<?xmlversion="1.0" encoding="utf-8" ?>
	<transaction>
		<result> </result>
		<merchanttransid> </merchanttransid>
		<transref> </merchanttransid>
		<gatetransid> </gatetransid>
		<errorcode> </errorcode>
		<errormessage> </errormessage>
		<description> </description>
		<parameters>
			<gatetransid> </gatetransid>
			<ACS/> 
		</transaction> 
	</transaction>

Boleto Bancario Request Data description:

Payment Option	Supported Country (ISO Code)	Processing Currency
Boleto Bancario	BR	R$ Brazil Real

Node	Include in Checksum (in this order)	Optional	Data Type	Description
brazilpayboleto	COND	XML node	Character max 50.	Section containing BrazilPay Bank Transfer bank account Information. Required for BrazilPay Bank Transfer transactions, forbidden for credit card transactions
Funding Country Code(3)	YES (2)	YES	String	3 letter ISO country code of the Customer. Full list of codes can be obtained from the website inside your merchant account.
Return URL	YES (3)	YES	Character no limit*	Customer’s Return URL
holder	YES (4)	YES	Character max 50.	Name as shown your financial institution (if not, fist and last name)
Document ID	YES (5)	YES	Integer	Customer’s Document Id

Boleto Bancario Response Data description

Node	Optional	Data Type	Description
result	YES	Character	Result indicates the result of the transaction. PENDING: A transfer has been created in the system and is awaiting an action. After the status has been changed, the results will be sent in the 850 Transaction State Notification that will be sent from the system server to the merchant server. Do NOT ASSUME the pending request as APPROVED or DECLINED. ERROR: means error detected in the request, no processing takes place, and transaction was not accepted by the system.
merchanttransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
gatetransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
errorcode	YES	Character 3	Error Code of the transaction or 000 if no error condition found.
errormessage	YES	Character max 100	Full description of the error.
description	OPT	Character no limit	Optional details of the transaction
gatetransid	OPT	Character no limit	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
ACS	YES	Character no limit	`ACS` will be returned where customer needs to finish his payment.

The Boleto Bancario request is plain XML that contains the following data:

  
<brazilpaybanktransfer> 	
  <countryiso> </countryiso>
  <returnurl> </returnurl>
  <documentid> </documentid>
  <holder> </holder>
</brazilpaybanktransfer>

The response to a Boleto Bancario - is plain xml un-encoded that contains the following data:


	<?xmlversion="1.0" encoding="utf-8" ?>
	<transaction>
		<result> </result>
		<merchanttransid> </merchanttransid>
		<transref> </merchanttransid>
		<gatetransid> </gatetransid>
		<errorcode> </errorcode>
		<errormessage> </errormessage>
		<description> </description>
		<parameters>
			<gatetransid> </gatetransid>
			<ACS/> 
		</transaction> 
	</transaction>

BrazilPay Bank Transfer Request Data description:

Payment Option	Supported Country (ISO Code)	Processing Currency
BrazilPay Bank Transfer	BR	R$ Brazil Real

Node	Include in Checksum (in this order)	Optional	Data Type	Description
brazilpaybanktransfer	COND	XML node	Character max 50.	Section containing BrazilPay Bank Transfer bank account Information. Required for BrazilPay Bank Transfer transactions, forbidden for credit card transactions
Return URL	YES (3)	YES	Character no limit*	Customer’s Return URL
holder	YES (4)	YES	Character max 50.	Name as shown your financial institution (if not, fist and last name)
Document ID	YES (5)	YES	Integer	Customer’s Document Id
bankCode	YES (6)	YES	String	Customer’s Bank Code
Bank Codes			bankCode	Bank name
			banrisul	Banrisul
			bradesco	Bradesco
			bancodobrasil	Banco do Brasil
			hsbc	HSBC Bank
			itau	Itaú
Customer Object
customer->firstname	YES(7)	YES	Character max 50.	First name of the Customer.
customer->lastname	YES(8)	YES	Character max 50.	Last name of the Customer.
customer->email	YES(9)	YES	Character max 100.	Email of the Customer.
customer->address1	YES(10)	YES	Character max 75.	Customer’s address line 1
customer->address1	YES(11)	YES	Character max 75.	Customer’s address line 2
customer->city	YES(12)	YES	Character max 50.	Customer’s City
customer->zippostal	YES(13)	YES	Character max 15.	Customer’s Zipcode or postal code.
customer->stateregioniso	YES(14)	YES	Character max 3.	2 or 3 character ISO 3166 state/region/province code of the Customer. Full list of codes can be obtained from the website inside your merchant account.
customer->countryiso	YES(15)	YES	Character exactly 3.	2 or 3 letter ISO country code of the Customer. Full list of codes can be obtained from the website inside your merchant account.
customer->birthday	YES(16)	YES	Number 1-2 digits	Day of birth of the Customer (1-31) Important Note: If Merchant cannot provide such data, he/she should contact GPN’s Sales Account Manager. Tag will be set as “Optional” only with GPN’s Sales Account Manager approval.
customer->phone1phone	YES(17)	YES	Character max 20.	Customer’s phone number, including country code and area code. Digits only, without (+) character

BrazilPay Bank Transfer Response Data description

Node	Optional	Data Type	Description
result	YES	Character	Result indicates the result of the transaction. PENDING: A transfer has been created in the system and is awaiting an action. After the status has been changed, the results will be sent in the 850 Transaction State Notification that will be sent from the system server to the merchant server. Do NOT ASSUME the pending request as APPROVED or DECLINED. ERROR: means error detected in the request, no processing takes place, and transaction was not accepted by the system.
merchanttransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
gatetransid	YES	Character max 50.	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
errorcode	YES	Character 3	Error Code of the transaction or 000 if no error condition found.
errormessage	YES	Character max 100	Full description of the error.
description	OPT	Character no limit	Optional details of the transaction
gatetransid	OPT	Character no limit	Unique gateway internal transaction id refers to Authorized transaction for which the Capture has been requested.
ACS	YES	Character no limit	`ACS` will be returned where customer needs to finish his payment.

The BrazilPay Bank Transfer request is plain XML that contains the following data:

  
<brazilpaybanktransfer> 	
  <firstname> </firstname>
  <lastname> </lastname>
  <email> </email>
  <address1> </address1>
  <address2> </address2>
  <city> </city>
  <zippostal> </zippostal>
  <stateregioniso> </stateregioniso>
  <countryiso> </countryiso>
  <birthday> </birthday>
  <phone1phone> </phone1phone>
  <returnurl> </returnurl>
  <documentid> </documentid>
  <holder> </holder>
  <bankcode> </bankcode>
</brazilpaybanktransfer>

The response to a BrazilPay Bank Transfer - is plain xml un-encoded that contains the following data:


	<?xmlversion="1.0" encoding="utf-8" ?>
	<transaction>
		<result> </result>
		<merchanttransid> </merchanttransid>
		<transref> </merchanttransid>
		<gatetransid> </gatetransid>
		<errorcode> </errorcode>
		<errormessage> </errormessage>
		<description> </description>
		<parameters>
			<gatetransid> </gatetransid>
			<ACS/> 
		</transaction> 
	</transaction>

GPN DATA MERCHANT API INTEGRATION GUIDE API INTEGRATION GUIDE FOR ALTERNATIVE PAYMENTS