IBAN Service


http://webservices.gr8pay.net/v2/IBAN.svc

Account Details Method

Retrieves the detailed information for a particular account given the unique account number or IBAN.

Request Fields


FieldNameMandatory?Field TypeDescriptionSample
AccountNumberYesStringAccount Number

Response Fields


Field NameField TypeDescription
The service only returns a status message

C#JavaScriptPHP


Account List Method

Retrieves the detailed information for a particular account given the unique account number or IBAN.

Request Fields


FieldNameMandatory?Field TypeDescriptionSample
ClientNumberYesStringAccount Number

Response Fields


Field NameField TypeDescription
The service only returns a status message

C#JavaScriptPHP


Funding Instructions Method

Retrieves the Funding Instructions for the given AccountNumber and CorrespondentSwiftCode.

Request Fields


FieldNameMandatory?Field TypeDescriptionSample
AccountNumberYesStringAccount Number
CorrespondentSwiftCodeYesStringThe correspondents Swift Code

Response Fields


Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


Open Account Method

Opens an account with the information provided.

Request Fields


FieldName Mandatory?Field TypeDescriptionSample
ClientNumberYesStringThe Unique Client Number
AccountIdYesIntergerThe account ID Number
BranchIdYesStringThe Branch ID Number
CurrencyYesStringThe Currency of the account

Response Fields


Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


Block Amount Method

Retrieves the detailed information for a particular account given the unique account number or IBAN.

Request Fields


FieldName Mandatory?Field TypeDescriptionSample
AccountNumberYesStringThe unique account number
AmountYesDecimalThe amount to be blocked
ExpiryDateYesDatetimeThe date when block expires.(Valid Format: YYYY-MM-DD)
DetailsYesStringInformation about the block

Response Fields


Field NameField TypeDescription
The service only returns a status message

C#JavaScriptPHP


Unblock Amount Method

UnBlocks an Amount from the related account given the unique block amount ID.

Request Fields


FieldName Mandatory?Field TypeDescriptionSample
BlockAmountIDYesStringThe ID of the blocked amount

Response Fields


Field NameField TypeDescription
The service only returns a status message

C#JavaScriptPHP


Prospective Cards Method

Retrieve the Card types that the client has not opened yet.

Request Fields


FieldName Mandatory?Field TypeDescriptionSample
ClientNumberYesStringClient Number

Response Fields


Field NameField TypeDescription
The service only returns a status message

C#JavaScriptPHP


Add Identification Method

Adds an identification to a specific client given the unique client number and identification’s information.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
ClientNumberYesStringClient Number
TypeYesStringThe Account ID number
CountryIssuedYesStringThe Country the Identification was issued from. (Valid Format : Alpha2Code) e.g. CY for Cyprus
DateIssuedYesDateThe Date the Identification was issued. (Valid Format : YYYY-MM-DD) e.g. 1995-03-24
DateExpiredYesDateThe Date the Identification will expire. (Valid Format : YYYY-MM-DD) e.g. 2026-03-24
LocationIssuedYesStringThe location the Identification was issued
NumberYesStringThe identifications unique number

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


Beneficiary Details Method

Retrieves all Beneficiary’s details of a client given the unique client number.

Request Fields

FieldName Mandatory?Field TypeDescriptionSample
isFromAdminYesBooleanThe unique client number

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


ClientApply(Individual) Method

Creates an Individual Client given all the necessary information.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
IsCorporateYesBooleanFor Individual Client creating we set False. (Valid Values: True, False )
ExternalClientNumberYesStringThe external client’s number
GenderYesStringThe gender of the client. (Valid Values: M for Male, F for Female)
TitleYesStringThe title of the client. (Valid Values: Mr, Mrs, Ms, Miss, Dr)
FirstNameYesStringThe first name of the client.
FamilyNameYesStringThe family name of the client.
MiddleNameYesStringThe middle name of the client.
FathersNameYesStringThe father's name of the client.
MothersNameYesStringThe mother's name of the client.
MothersSurnameYesStringThe mother's surname of the client.
DoBYesStringThe birth date of the client. (Valid Format: YYYY-MM-DD)
PlaceOfBirthYesStringThe birthplace of the client.
NationalityYesStringThe nationality of the client. (Valid Format: Alpha2Code) e.g. CY for Cyprus
MaritalYesStringThe marital status of the client. (Valid Values: Single, Married, Divorced, Widower)
TaxRefYesStringThe tax ref of the client.
TaxRefJurisdictionYesStringThe tax ref jurisdiction of the client. (Valid Format: Alpha2Code) e.g. CY for Cyprus
GeneralInfoYesStringThe general info of the client.
AddressYesStringThe legal address of the client.
Address2YesStringThe legal address 2 of the client.
PostalCodeYesStringThe postal code of the client.
CityYesStringThe city of the client.
CountryCodeYesStringThe country of the client. (Valid Format: Alpha2Code) e.g. CY for Cyprus
MailAddress1YesStringThe mail address of the client.
MailAddress2YesStringThe mail address 2 of the client.
MailPostalCodeYesStringThe mail postal code of the client.
MailCityYesStringThe mail city of the client.
MailCountryCodeYesStringThe mail country of the client.
MobilePhoneYesStringThe mobile phone of the client. (Valid Format: +CountryCodeXXXXXXXX) e.g. +35712345678
PhoneNoStringThe home phone of the client. (Valid Format: +CountryCodeXXXXXXXX) e.g. +35712345678
WorkPhoneNoStringThe work phone of the client. (Valid Format: +CountryCodeXXXXXXXX) e.g. +35712345678
FaxYesStringThe fax of the client. (Valid Format: +CountryCodeXXXXXXXX) e.g. +35712345678
EmailYesStringThe email of the client. (Valid Format: local-part@domain) e.g. example@example.com
ClientRiskNoStringThe client risk of the client. (Valid Values: Low Risk, Medium Risk, High Risk, BlackListed ) Default Value: Low Risk
PEPSanctionsRiskNoStringThe PEP sanction's risk of the client. (Valid Values: Unknown, Low Risk, Medium Risk, High Risk) Default Value: Unknown
CommercialRiskNoStringThe commercial risk of the client. (Valid Values: Unknown, Low Risk, Medium Risk, High Risk) Default Value: Unknown
IsAliveOrActiveVitalStatusNoStringThe vital status of the client. (Valid Values: True, False) Default Value: True
DataRecollectionDateNoStringThe data recollection date of the client. (Valid Format: YYYY-MM-DD). If not Provided the default value is Today.
CSMNoStringThe CSM of the client. If not provided a random existing CSM will be chosen by default.
UserNameNoStringThe username of the client. Default Value: System
BranchIDNoStringThe branchID number. Default Value: 001
SortKeyNoStringThe sort key of the client.
SponsorCLNO1NoStringThe existing client (Sponsor) who referred the current new client.
ReferralCommissionNoStringThe referral percentage commission (%) of the Sponsor. (Valid Values [0-100] )
PEPYNNoBooleanThe PEPYN of the client. (Valid Values: True, False) Default Value: False
TaxResidentCountryNoBooleanThe tax resident country of the client. (Valid Format: Alpha2Code) e.g. CY for Cyprus
TaxStatusNoDateThe tax status of the client. (Valid Values: Free, Local) Default Value: Free
ContactIsSelfEmployedNoBooleanIf the client is SelfEmployed. (Valid Values: True, False) Default Value: False
WasBornUSANoBooleanIf the client was born in USA. (Valid Values: True, False) Default Value: False
IsUSANationalNoBooleanIf the client has American Nationality. (Valid Values: True, False) Default Value: False
LegalCatNoBooleanThe legal category of the client.
IndustryNoBooleanThe Industry of the client.
SubIndustryNoBooleanThe SubIndustry of the client.

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


Client Address Method

Retrieves Client’s addresses (Legal and Mail) for the given Client Number.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
ClientNumberYesStringThe Unique client number

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


Client Contact Details Method

Retrieves client contact details given the unique client number.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
ClientNumberYesStringThe Unique client number

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


Client Documents Method

Retrieves all client documents for the given client number.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
ClientNumberYesStringThe Unique client number

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


Client Personal Details Method

Retrieves client personal details given the unique client number.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
ClientNumberYesStringThe Unique client number

Response Fields

FieldNameMandatory?Field TypeDescriptionSample
ClientNumberYesStringThe Unique client number


C#JavaScriptPHP


Client Referral Details Method

Retrieves client’s referral’s details given the unique client number.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
ClientNumberYesStringThe Unique client number

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


Identification Details Method

Retrieves all client’s identification details given the unique client number.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
ClientNumberYesStringThe Unique client number

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


Dependant Details Method

Retrieves all client’s relations details for the given client number.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
ClientNumberYesStringThe Unique client number

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


Change Client Status Method

Changes Client Status given the unique client number and new status.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
ClientNumberYesStringThe Unique client number
StatusYesStringThe New Status of the client. (Valid values: Pending, Approved, Authorized, Active, Terminated, Rejected)

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


All Exchange Rates By Base Currency Method

Returns exchange rates by base currency.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


Forex Exchange Rates Method

Retrieves all forex exchange rates for the currencies register on the system based on the base currency.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


All Exchange Rates By Date Method

Retrieves all exchange rates based on the date provided for base Currency. If no rates are available on the specific date the system will then make use of the latest rates stored.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
DateYesDateThe Date. (Valid Format: YYYY-MM-DD)

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


Loans For Credit Method

Retrieves all loans related to a client for the given client number.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
ClientNumberYesStringClient Number

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


GetLoans By Reference Number Method

Retrieves all loans related to a client for the given client number.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
ReferenceNumberYesStringThe unique Loan Reference Number

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


Authentication GenerateToken Method

Retrieves all loans related to a client for the given client number.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
ClientNumberYesStringClient Number

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


Client SignUp Method

Client Sign up.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


ViewStanding Orders Method

Views client’s standing orders given the unique client number.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
ClientNumberYesStringClient Number

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


Cancel Standing Orders Method

Cancels a standing order given the unique client number and standing order id.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
ClientNumberYesStringClient Number
StandingOrderIDYesStringThe unique standing order ID

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


Get AllIdentification Types Method

Retrieve all identification types.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


All Document Types Method

Retrieve All Document Types.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP


All Nostro Swift Code Method

Retrieve the list of all nostros that are permitted for the funding instructions given an account number.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
AccountNumberYesStringThe account number

Response Fields

Field NameField TypeDescription
The service only returns a status message


C#JavaScriptPHP