Partner


http://webservices.gr8pay.com/v2/partner.svc

The Partner web service will enable you to create a peer to peer application or web interfaces. use this service along side to the customer web service.

AddNewPartner

This method allows to register partner’s within the gateways

Headers

To perform this request you need to add headers listed below.

HeaderMandatoryNotes
"Content-Type" : "application/json"Yes
"applicationToken" : YOUR_APP_TOKENYes
Credentials token headerYesYou must be logged in to use this service
Signature headerYesSHA256 the full body of the request along with the HASH key.

Request – Filters

ParameterMandatoryTypeDescription
CompanyNameYesstringPartner Name
BankNameYesstringPartner Bank Name
BankAddressYesstringSet amount of items per page here
AccountNumberYesstringBank Account Number
SortCodeYesstringSort Code
ContactEmailYesstringPartner Contact Email
CompanyUrlYesstringWebsite Url
CurrencyIsoCodeYesstringCurrency Code ISO4217*
IBANYesstringIBAN or Bank Branch Code

Response Parameters

ParameterTypeDescription
IsSuccessbooleanDefines whether service call was processed successfully or not
MessagestringResult message
PartnerIDIntPartnerID



C#JavaScriptPHP


UpdatePartner

Update any of the partners details within the system. This method also allows you to toggle the status of the partner between being Active or InActive on the system.

Headers

To perform this request you need to add headers listed below.

HeaderMandatoryNotes
"Content-Type" : "application/json"Yes
"applicationToken" : YOUR_APP_TOKENYes
Credentials token headerYesYou must be logged in to use this service
Signature headerYesSHA256 the full body of the request along with the HASH key.

Request – Filters

ParameterMandatoryTypeDescription
CompanyNameYesstringPartner Name
BankNameYesstringPartner Bank Name
BankAddressYesstringSet amount of items per page here
AccountNumberYesstringBank Account Number
SortCodeYesstringSort Code
ContactEmailYesstringPartner Contact Email
CompanyUrlYesstringWebsite Url
CurrencyIsoCodeYesstringCurrency Code ISO4217*
IBANYesstringIBAN or Bank Branch Code
PartnerIDYesintPartner ID

Response Parameters

ParameterTypeDescription
IsSuccessbooleanDefines whether service call was processed successfully or not
MessagestringResult message
PartnerIDIntPartnerID



C#JavaScriptPHP


GetPartner

Returns the stored data of a partner.

Headers

To perform this request you need to add headers listed below.

HeaderMandatoryNotes
"Content-Type" : "application/json"Yes
"applicationToken" : YOUR_APP_TOKENYes
Credentials token headerYesYou must be logged in to use this service
Signature headerYesSHA256 the full body of the request along with the HASH key.

Request – Filters

ParameterMandatoryTypeDescription
PartnerIDYesintPartnerID

Response Parameters

ParameterMandatoryTypeDescription
CompanyNameYesstringPartner Name
BankNameYesstringPartner Bank Name
BankAddressYesstringSet amount of items per page here
AccountNumberYesstringBank Account Number
SortCodeYesstringSort Code
ContactEmailYesstringPartner Contact Email
CompanyUrlYesstringWebsite Url
CurrencyIsoCodeYesstringCurrency Code ISO4217*
IBANYesstringIBAN or Bank Branch Code
IsActiveYesbooleanIndicates whether the Partner is able to process using the system.
PartnerIDYesintPartner ID



C#JavaScriptPHP


LoadBalance Method

The Service is used to load Balance to a customer using card number.

Headers

To perform this request you need to add headers listed below.

HeaderMandatoryNotes
"Content-Type" : "application/json"Yes
"applicationToken" : YOUR_APP_TOKENYes
Credentials token headerYesYou must be logged in to use this service
Signature headerYesSHA256 the full body of the request along with the HASH key.

Request – Filters

ParameterMandatoryTypeDescription
AmountYesDecimalAmount
CardExpDateYesDateCard Expiry Date
CardNumberYesstringCard Number
CurrencyIsoCodeYesstringCurrency Code ISO4217*
CvvYesstringCvv Number
IdNumberYesstringID Number
InstallmentsYesintInstallments ID
StoredPaymentMethodIDYesintStored Payment ID
strApplicationTokenYesstringApplication Token

Response Parameters

ParameterTypeDescription 
IsSuccessYesbooleanTrue if Successful or False if Unsuccesful



C#JavaScriptPHP


AddCardToCustomer Method

The Service is used to add a card to a customer.

Headers

To perform this request you need to add headers listed below.

HeaderMandatoryNotes
"Content-Type" : "application/json"Yes
"applicationToken" : YOUR_APP_TOKENYes
Credentials token headerYesYou must be logged in to use this service
Signature headerYesSHA256 the full body of the request along with the HASH key.

Request – Filters

ParameterMandatoryTypeDescription
strEmailYesstringUser Email
strApplicationTokenYesstringApplication Token
strCardNoYesstringCard Number

Response Parameters

ParameterMandatoryTypeDescription
CompanyNameYesstringPartner Name
BankNameYesstringPartner Bank Name
BankAddressYesstringSet amount of items per page here
AccountNumberYesstringBank Account Number
SortCodeYesstringSort Code
ContactEmailYesstringPartner Contact Email
CompanyUrlYesstringWebsite Url
CurrencyIsoCodeYesstringCurrency Code ISO4217*
IBANYesstringIBAN or Bank Branch Code
IsActiveYesbooleanIndicates whether the Partner is able to process using the system.
PartnerIDYesintPartner ID



C#JavaScriptPHP


GetCustomerBalance

The system allows users to store money using different currencies. This method allows to get a list of user’s balances, which match specified parameters. The first item in the list is user’s current balance, others are previous balance’s states. Be aware: in case user didn’t have anything on the specified currency balance yet, an empty array will be returned.

Request – Filters

ParameterMandatoryTypeDescription
applicationTokenNostringYour application token (same value you add to the request's header)
CustomerNumberNostringThe CustomerNumber you wish to the receive the data for.
currencyIsoCodeNostringDefine which currency the amount should be transferred in. Should contain currency ISO

Response Parameters

As a response this method returns an array which contains objects with info about matching items. Each object includes parameters represented in the table below.

ParameterTypeDescription
CurrencyIsostringBalance's currency ISO
CurrentdecimalCurrent amount for this balance
ExpecteddecimalExpected amount for this balance (current amount and pending amount together)
PendingdecimalPending amount for this balance (not confirmed transfers, etc.)



C#JavaScriptPHP


GetCustomer

This method allows to get full info about the currently logged in user.

Headers

To perform this request you need to add headers listed below.

HeaderMandatoryNotes
"Content-Type" : "application/json"Yes
"applicationToken" : YOUR_APP_TOKENYes
Credentials token headerYesYou must be logged in to use this service
Signature headerYesSHA256 the full body of the request along with the HASH key.

Request – Filters

ParameterMandatoryTypeDescription
This method has an empty body as it doesn't require any input parameters. It takes user's credentials token from the request's header automatically and this way detects data for which user has to be returned. Check Headers topic to get more info on how to add credentials token to request's headers.

Response Parameters

ParameterMandatoryTypeDescription
AddressLine1NostringPrimary address
AddressLine2NostringSecondary address
CityNostringCity
CountryIsoNostringCounty ISO
PostalCodeNostringPostal code
StateIsoNostringState ISO
CellNumberNostringUser's cell phone number
CustomerNumberNostringID of the user
DateOfBirthNodateTimeUser's date of birth
EmailAddressNostringUser's email
FirstNameNostringUser's first name
LastNameNostringUser's last name
PersonalNumberNostringUser's personal number
PhoneNumberNostringUser's phone number
ProfileImageNobase64BinaryUser's profile image
ProfileImageSizeNolongUser's profile image size
RegistrationDateNodateTimeUser's registration date
AboutMeNostringUse this field to save a short BIO about the user, you can save up to 5000 characters
GenderNostringThe Gender of the registered user (send: Male/Female)
IndustryNostringThe industry the user belongs to, a more general approach then SetPosition which includes all of the Job history for the user.
EducationNostringA short description of the educational level of the user.
MaritalStatusNostringSave the Marital Status of the user ( Married/Single/Divorced)
SignificantOtherNostringSave a customer number for the user's Significant Other
InterestsNoArrayOfstringSave the user's interests by listing them, comma separated.
SkillsNoArrayOfstringUse the International service to get the full list of Skills available, you can add additional Skills by sending them as part of the request.



C#JavaScriptPHP