Balance Object


http://webservices.gr8pay.com/v2/Balance.svc
The Balance object represents your Gr8Pay balance. You can also retrieve the balance history, which contains a list of transactions that contributed to the balance (charges, payouts, and so forth). The available and pending amounts for each currency are broken down further by payment currency types.

GetRequest Method

The getrequest service will return all the information about a specific balance transfer. From the reply you can determine the status of the request and the date of its confirmation. There are two types of balance transfer – direct or upon request – a direct transfer occurs when user pushes, an amount to another user , without a request.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
requestIdNoInt“6224A847-4867-41EE-851D-36CC8BA1B”

Response Fields

Field NameField TypeDescription
CodeInteger
IsSuccessBoolean
KeyString
MessageStringSee Return Codes Table*
NumberString
C#JavaScriptPHP

GetRequests Method

Allows to call for all requests by a certain currency or payment method limited to the logged in user – the service allows  limits to be applied to the number  of items per page.

Request Fields

FieldName Mandatory?Field TypeDescriptionSample
filtersNoarray“6224A847-4867-41EE-851D-36CC8BA1B”
CurrentIsoNostringGBP
StoredPaymentMethodIDNoint
sortAndPageNoarray
PageNumberNoint
PageSizeNoint

Response Fields

Field NameField TypeDescription
CodeInteger
IsSuccessBoolean
KeyString
MessageStringSee Return Codes Table*
NumberString
C#JavaScriptPHP

GetRows Method

The service will return all types of balance changes to the user, with information relevant to  the “source type” . Once the  source type has been identified,  you can call another service with the source ID to retrieve  the relevant information you need.The “source types” are:
  • System.Admin
  • System.Deposit
  • System.DepositFee
  • System.PedingCapture
  • System.Purchase
  • System.Transfer
  • System.TransferFee
  • System.Withdrawal
  • System.WithdrawalFee
  • Wires.AffiliateSettlement
  • Wires.PaymentRequest,
  • Wires.Settlement
  • Wires.SettlementFee
  • Wires.Wire

Request Fields

FieldName Mandatory?Field TypeDescriptionSample
filtersNoarray“6224A847-4867-41EE-851D-36CC8BA1B”
CurrentIsoNostringGBP
StoredPaymentMethodIDNoint
sortAndPageNoarray
PageNumberNoint
PageSizeNoint

Response Fields

Field NameField TypeDescription
CodeInteger
IsSuccessBoolean
KeyString
MessageStringSee Return Codes Table*
NumberString
C#JavaScriptPHP

GetTotal Method

The service returns the total available balance for the user – per currency

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
currencyIsoCodeNostringGBP

Response Fields

Field NameField TypeDescription
CodeInteger
IsSuccessBoolean
KeyString
MessageStringSee Return Codes Table*
NumberString
C#JavaScriptPHP

ReplyRequest Method

Once a request for an amount reaches a user , there is the  option to reply either “yes” or “no” –  and reply must be approved by the user  using the pin code.

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
requestIdNoint“6224A847-4867-41EE-851D-36CC8BA1B”
ApproveNoboolean
pinCodeNostring
TextNostring

Response Fields

Field NameField TypeDescription
CodeInteger
IsSuccessBoolean
KeyString
MessageStringSee Return Codes Table*
NumberString
C#JavaScriptPHP

RequestAmount Method

The basis of the balance service is to allow users to assist  other users and transfer money from one another.The request amount gives the user an option to ask for an amount from‘friends’ (Friends service will be described separately in the Customer’s service)

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
destAccountIdNostring“6224A847-4867-41EE-851D-36CC8BA1B”
AmountNodecimal
currencyIsoNostringGBP

Response Fields

Field NameField TypeDescription
CodeInteger
IsSuccessBoolean
KeyString
MessageStringSee Return Codes Table*
NumberString
C#JavaScriptPHP

TransferAmount Method

This service call will allow a user to “push” an amount to another user with an original request.The user will be prompted  for a Pin code to approve the transfer, in the same manner  as all balance transfer requests.Even push transfers have  a request ID (number), so that the request can be tracked at a later stage  

Request Fields

FieldNameMandatory?Field TypeDescriptionSample
destAccountIdNostring
AmountNodecimal
currencyIsoNostringGBP
pinCodeNostring
TextNostring

Response Fields

Field NameField TypeDescription
CodeInteger
IsSuccessBoolean
KeyString
MessageStringSee Return Codes Table*
NumberString
C#JavaScriptPHP