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:

  1. The merchant securely obtains all the information needed to start a transaction;
  2. 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
  3. The system will respond to the Merchant by redirecting back the customer to the designated return URL used above;
  4. The Merchant shows the result of the transaction to the end user.

Deposit - Merchant Fields

Order (pSign)Field NameDetailsMinMaxTypeRequired
01merchantIDMerchant id supplied by Intrapay18NumberYes
02amountThe purchase amount (ex. 1.99)112DecimalYes
03currencyThe purchase currency (ISO 4217)33StringYes
04orderIDThe unique Merchant Order ID164StringYes
05returnURLMerchant URL that will handle the customer redirect back1300StringYes
06notifyURLMerchant URL for server to server asynchronous notifications1300StringNo
07customerEmailCustomer's email address1120StringYes
08customerPhoneCustomer's telephone number716StringYes
09customerFirstNameCustomer's first name1128StringYes
10customerLastNameCustomer's last name1128StringYes
11customerAddress1Customer's address line 11128StringYes
12customerAddress2Customer's address line 21128StringNo
13customerCityCustomer's city name1128StringYes
14customerZipCodeCustomer's zip / postal code116StringYes
15customerStateProvinceCustomer's state / province1128StringNo*
16customerCountryCustomer's country code (ISO 3166-2)22StringYes
17customerDobCustomer's Date of Birth (yyyy-mm-dd)1010StringNo*
18customerIdCustomer's national ID.130NumberNo*
19bankCodeBank Code where the customer is paying in.164StringYes
20bankAccountNumberCustomer's bank account number145StringNo*
21custom1Additional bank required field164StringNo*
22custom2Additional bank required field164StringNo*
23custom3Additional bank required field164StringNo*
24descriptorDefines the text on the consumer's proof of payment (e.g. bank statement record and similar)140StringNo*
25paymentMethodRefer to the Payment Methods section.164StringNo**
26descriptionTransaction or Product short description164StringNo
27pSignThe SHA signature used to secure protocol4040StringYes

* 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