FxHubPartnersApi

<back to all web services

EditForm25

Requires Authentication
The following routes are available for this service:
PUT/form25/edit
EditForm25 Parameters:
NameParameterData TypeRequiredDescription
Form25bodyForm25No
Form25 Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ClientIdformintNo
FullNamesformstringNo
FirstLastNameformstringNo
IdNumberformstringNo
CifNumberformstringNo
SignedAtformstringNo
PaymentDateformDateTime?No
TransferAccountNumberformstringNo
RandAmountformdecimal?No
RandAmountInWordsformstringNo
BeneficiaryNameformstringNo
BillerPaymentformbool?No
BeneficiaryAddressformstringNo
BeneficiaryAccountformstringNo
AccountTypeformstringNo
BankNameformstringNo
BranchNameformstringNo
BankCodeformstringNo
BeneficiaryRefformstringNo
StpformstringNo
ProofOfPaymentformstringNo
PopEmailformstringNo
SignatoryNameformstringNo
SignatoryIdNumberformstringNo
SignatoryCapacityformstringNo
IsThirdPartyPaymentformbool?No
EditForm25Response Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
MessageformstringNo

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

HTTP + CSV

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

PUT /form25/edit HTTP/1.1 
Host: api.fxlink.co.za 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"form25":{"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}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"result":false,"message":"String"}