Processing Methods

Deposit - Merchant

This section describes the parameters required to perform deposits. The customer finalizes the transaction on a 3rd party site not in the merchant system; usually logging in their online banking or entering a security code to complete the transaction.

To implement this method:

The merchant securely obtains all the information needed to start a transaction;
The merchant initiates a HTTPS POST method to the Intrapay endpoint URL with all the necessary information as url-encoded key-value pairs and MUST redirect the customer in the same API call to the Payment platform.
URL: payment.intrapay.com/deposit/merchant
The system will respond to the Merchant by redirecting back the customer to the designated return URL used above;
The Merchant shows the result of the transaction to the end user.

Deposit - Merchant Fields

Order (pSign)	Field Name	Details	Min	Max	Type	Required
01	merchantID	Merchant id supplied by Intrapay	1	8	Number	Yes
02	amount	The purchase amount (ex. 1.99)	1	12	Decimal	Yes
03	currency	The purchase currency (ISO 4217)	3	3	String	Yes
04	orderID	The unique Merchant Order ID	1	64	String	Yes
05	returnURL	Merchant URL that will handle the customer redirect back	1	300	String	Yes
06	notifyURL	Merchant URL for server to server asynchronous notifications	1	300	String	No
07	customerEmail	Customer's email address	1	120	String	Yes
08	customerPhone	Customer's telephone number	7	16	String	Yes
09	customerFirstName	Customer's first name	1	128	String	Yes
10	customerLastName	Customer's last name	1	128	String	Yes
11	customerAddress1	Customer's address line 1	1	128	String	Yes
12	customerAddress2	Customer's address line 2	1	128	String	No
13	customerCity	Customer's city name	1	128	String	Yes
14	customerZipCode	Customer's zip / postal code	1	16	String	Yes
15	customerStateProvince	Customer's state / province	1	128	String	No*
16	customerCountry	Customer's country code (ISO 3166-2)	2	2	String	Yes
17	customerDob	Customer's Date of Birth (yyyy-mm-dd)	10	10	String	No*
18	customerId	Customer's national ID.	1	30	Number	No*
19	bankCode	Bank Code where the customer is paying in.	1	64	String	Yes
20	bankAccountNumber	Customer's bank account number	1	45	String	No*
21	custom1	Additional bank required field	1	64	String	No*
22	custom2	Additional bank required field	1	64	String	No*
23	custom3	Additional bank required field	1	64	String	No*
24	descriptor	Defines the text on the consumer's proof of payment (e.g. bank statement record and similar)	1	40	String	No*
25	paymentMethod	Refer to the Payment Methods section.	1	64	String	No**
26	description	Transaction or Product short description	1	64	String	No
27	pSign	The SHA signature used to secure protocol	40	40	String	Yes

* Please note that some Gateways / Banks / Payment Methods do not support/use these parameters, or may consider them as mandatory! Our technical team will specify if any of these are required/supported.
** If no payment method was sent, a form will be displayed for the customer to choose one. Also, some payment methods have additional field requirement from the merchant and/or the customer. Refer to the Payment Methods section.

Example Deposit - Merchant request:

[POST URL] https://payment.intrapay.com/deposit/merchant

[POST PARAMS]

merchantID=1&amount=10.00&currency=USD&orderID=20170117-54251122342
&returnURL=https%3A%2F%2Fwww.mysite.com%2Freturn
&customerEmail=david.crown40dcrown23.org&customerPhone=+447522829132
&customerFirstName=David&customerLastName=Crown&customerAddress1=Remington+St+45
&customerAddress2=&customerCity=London&customerZipCode=ATE223&customerStateProvince=London
&customerCountry=GB&customerId=00003548967&bankCode=apm&paymentMethod=dummy
&custom1=%7B%22dummyField1%22%3A%22test1%22%7D&custom2=%7B%22dummyField2%22%3A%22test2%22%7D
&custom3=%7B%22dummyField3%22%3A%22test3%22%7D&pSign=8abbaf8f48d8c2c616655d7684ed8466e98bd5f7

Example Deposit - Merchant response:

https://www.mysite.com/return?responseCode=1&reasonCode=1&transactionID=20170117-EEFFD6BD0D7C034C40AC-91EB7580D8E6073974D0
&amount=10.00¤cy=USD&orderID=2017-01-17-3391&executed=2017-01-17+15%3A29%3A45&bankResultCode=
&bankAuthCode=&pSign=80a98892db2c4e9072a372d443f6441adb1669b5