FxHubPartnersApi

GetForm25

The following routes are available for this service:
GET	/form25/{Id}

**GetForm25** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	int	No
ClientId	query	int	No

**GetForm25Response** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Result	form	Form25	No

**Form25** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
ClientId	form	int	No
FullNames	form	string	No
FirstLastName	form	string	No
IdNumber	form	string	No
CifNumber	form	string	No
SignedAt	form	string	No
PaymentDate	form	DateTime?	No
TransferAccountNumber	form	string	No
RandAmount	form	decimal?	No
RandAmountInWords	form	string	No
BeneficiaryName	form	string	No
BillerPayment	form	bool?	No
BeneficiaryAddress	form	string	No
BeneficiaryAccount	form	string	No
AccountType	form	string	No
BankName	form	string	No
BranchName	form	string	No
BankCode	form	string	No
BeneficiaryRef	form	string	No
Stp	form	string	No
ProofOfPayment	form	string	No
PopEmail	form	string	No
SignatoryName	form	string	No
SignatoryIdNumber	form	string	No
SignatoryCapacity	form	string	No
IsThirdPartyPayment	form	bool?	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /form25/{Id} HTTP/1.1 
Host: api.fxhub.co.za 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	result: 
	{
		id: 0,
		clientId: 0,
		fullNames: String,
		firstLastName: String,
		idNumber: String,
		cifNumber: String,
		signedAt: String,
		paymentDate: 0001-01-01,
		transferAccountNumber: String,
		randAmount: 0,
		randAmountInWords: String,
		beneficiaryName: String,
		billerPayment: False,
		beneficiaryAddress: String,
		beneficiaryAccount: String,
		accountType: String,
		bankName: String,
		branchName: String,
		bankCode: String,
		beneficiaryRef: String,
		stp: String,
		proofOfPayment: String,
		popEmail: String,
		signatoryName: String,
		signatoryIdNumber: String,
		signatoryCapacity: String,
		isThirdPartyPayment: False
	}
}