POST api/ESB/GetMetadata

Request Information

URI Parameters

None.

Body Parameters

string

Request Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'String'.

Response Information

Resource Description

GetMetaDataResponse

Name	Type	Additional information
header	Header	None.
requiredDocuments	Collection of RequiredDocument	None.
accountDetails	AccountDetails	None.
accountList	Collection of AccountList	None.
detailOfApplicant	DetailOfApplicant	None.
paymentInstruction	PaymentInstruction	None.
deals	Collection of Deal	None.
applicantBank	ApplicantBank	None.
benificiaryRemitterDetails	BenificiaryRemitterDetails	None.
info	BopInfo	None.
thirdPartyInfos	Collection of ThirdPartyInfo	None.
fundsTransferInstruction	FundsTransferInstruction	None.
signers	Collection of Signer	None.
Success	boolean	None.
Message	string	None.
TransactionId	string	None.
OcrDataAvailable	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "header": {
    "TypeOfTransaction": "sample string 1",
    "TransactionUniqueIdentifier": "sample string 2"
  },
  "requiredDocuments": [
    {
      "DocumentIdentifier_6": "sample string 1"
    },
    {
      "DocumentIdentifier_6": "sample string 1"
    }
  ],
  "accountDetails": {
    "AccountNumber_5": "sample string 1",
    "TransactionDate_2": "2025-12-10T01:37:32.9412713+00:00"
  },
  "accountList": [
    {
      "AccountNumber": "sample string 1",
      "AccountName": "sample string 2",
      "VatNumber": "sample string 3"
    },
    {
      "AccountNumber": "sample string 1",
      "AccountName": "sample string 2",
      "VatNumber": "sample string 3"
    }
  ],
  "detailOfApplicant": {
    "CIFNumber_2": "sample string 1",
    "ApplicantType": "sample string 2",
    "Surname_14": "sample string 3",
    "EntityName_14": "sample string 4",
    "FirstNames_15": "sample string 5",
    "CustomsClientNo_17": "sample string 6",
    "ResidentialStreet": "sample string 7",
    "ResidentialCity": "sample string 8",
    "ResidentialProvince": "sample string 9",
    "ResidentialZipCode": "sample string 10",
    "ResidentialCountry": "sample string 11",
    "PostalStreet": "sample string 12",
    "PostalCity": "sample string 13",
    "PostalProvince": "sample string 14",
    "PostalZipCode": "sample string 15",
    "TelephoneNumber_29": "sample string 16",
    "MobileNumber": "sample string 17",
    "EmailAddress_31": "sample string 18",
    "IDTypeLabel": "sample string 19",
    "IdentityNumber_32": "sample string 20",
    "DateOfBirth_33": "2025-12-10T01:37:32.9412713+00:00",
    "TaxNumber_41": "sample string 21"
  },
  "paymentInstruction": {
    "ValueDate_8": "2025-12-10T01:37:32.9412713+00:00",
    "CrossBorderCurrency_9": "sample string 1",
    "TotalCrossBorderAmount": 1.0,
    "TotalCounterAmount": 1.0,
    "CounterCurrency": "sample string 2",
    "SwiftRef": "sample string 3"
  },
  "deals": [
    {
      "DealNumber_7": "sample string 1",
      "DealType": "sample string 2",
      "ForeignCurrencyAmount_10": 1.0,
      "ExchangeRate_11": 1.0,
      "RandAmount_12": 1.0
    },
    {
      "DealNumber_7": "sample string 1",
      "DealType": "sample string 2",
      "ForeignCurrencyAmount_10": 1.0,
      "ExchangeRate_11": 1.0,
      "RandAmount_12": 1.0
    }
  ],
  "applicantBank": {
    "BankName_46": "sample string 1",
    "BranchNameAndCode_49": "sample string 2",
    "BranchName": "sample string 3",
    "BranchCode": "sample string 4",
    "BankAddress": "sample string 5",
    "City_47": "sample string 6",
    "Country_48": "sample string 7",
    "SwiftAddress_50": "sample string 8",
    "CorrespondentCode": "sample string 9"
  },
  "benificiaryRemitterDetails": {
    "BankAccountNumber_52a": "sample string 1",
    "SurnameOrEntityName_53": "sample string 2",
    "FirstNames_54": "sample string 3",
    "Gender_55": "sample string 4",
    "ResidentialStreet": "sample string 5",
    "ResidentialCity": "sample string 6",
    "ResidentialProvince": "sample string 7",
    "ResidentialZipCode": "sample string 8",
    "ResidentialCountry": "sample string 9",
    "ResidentialCountryCode": "sample string 10",
    "PassportNo_59": "sample string 11",
    "PassportCountry_60": "sample string 12",
    "RSAResident_61": true,
    "DetailsOfTransfer": "sample string 14",
    "BeneficiaryReference": "sample string 15",
    "DetailsOfCharges_65": "sample string 16",
    "RecieverInformation": "sample string 17",
    "CanEdit": true
  },
  "info": {
    "FCYCurrency": "sample string 1",
    "FCYTotalAmount": 1.0,
    "TaxClearanceCertificateReference_44": "sample string 2",
    "SARS_APN": "sample string 3",
    "LoanReferenceNo_69": "sample string 4",
    "LoanTenor_70": "sample string 5",
    "SARBAuthApplicationNo": "sample string 6",
    "CryptoTrade": true,
    "SARBAuthReferenceNo": "sample string 7",
    "BOPs": [
      {
        "Category_67": "sample string 1",
        "SubCategory_68": "sample string 2",
        "FCYAmount": 1.0,
        "SDAFIA": "sample string 3",
        "TCS": "sample string 4"
      },
      {
        "Category_67": "sample string 1",
        "SubCategory_68": "sample string 2",
        "FCYAmount": 1.0,
        "SDAFIA": "sample string 3",
        "TCS": "sample string 4"
      }
    ],
    "LoanInterestRate_71": 8.0,
    "ContactName_38": "sample string 9",
    "ContactSurname": "sample string 10",
    "ContactCellNumber_39": "sample string 11",
    "VatNumber_40": "sample string 12",
    "UCRNumber": "sample string 13",
    "PreviousCryptoDealID": "sample string 14"
  },
  "thirdPartyInfos": [
    {
      "Surname_108": "sample string 1",
      "Name_109": "sample string 2",
      "IdentityType": "sample string 3",
      "IdentityNo_110": "sample string 4",
      "DateOfBirth_111": "2025-12-10T01:37:32.9412713+00:00",
      "Gender_112": "sample string 5",
      "Country": "sample string 6",
      "TaxNo_116": "sample string 7",
      "VatNo_117": "sample string 8",
      "EntityCCN_118": "sample string 9",
      "TelephoneNo_119": "sample string 10",
      "CellNo_120": "sample string 11",
      "EmailAddress_122": "sample string 12",
      "ResidentialStreet": "sample string 13",
      "ResidentialCity": "sample string 14",
      "ResidentialProvince": "sample string 15",
      "ResidentialZipCode": "sample string 16",
      "PostalStreet": "sample string 17",
      "PostalCity": "sample string 18",
      "PostalProvince": "sample string 19",
      "PostalZipCode": "sample string 20"
    },
    {
      "Surname_108": "sample string 1",
      "Name_109": "sample string 2",
      "IdentityType": "sample string 3",
      "IdentityNo_110": "sample string 4",
      "DateOfBirth_111": "2025-12-10T01:37:32.9412713+00:00",
      "Gender_112": "sample string 5",
      "Country": "sample string 6",
      "TaxNo_116": "sample string 7",
      "VatNo_117": "sample string 8",
      "EntityCCN_118": "sample string 9",
      "TelephoneNo_119": "sample string 10",
      "CellNo_120": "sample string 11",
      "EmailAddress_122": "sample string 12",
      "ResidentialStreet": "sample string 13",
      "ResidentialCity": "sample string 14",
      "ResidentialProvince": "sample string 15",
      "ResidentialZipCode": "sample string 16",
      "PostalStreet": "sample string 17",
      "PostalCity": "sample string 18",
      "PostalProvince": "sample string 19",
      "PostalZipCode": "sample string 20"
    }
  ],
  "fundsTransferInstruction": {
    "BenfAmount_74": 1.0,
    "AmountInWords": "sample string 2",
    "BenfName_75": "sample string 3",
    "BenfAddress_76": "sample string 4",
    "BenfAccountNumber_77": "sample string 5",
    "BenfAccountType_78": "sample string 6",
    "BenfBankName_79": "sample string 7",
    "BenfBankBranch_80": "sample string 8",
    "BenfBranchSortCode_81": "sample string 9",
    "BenfReference_82": "sample string 10"
  },
  "signers": [
    {
      "RSAResident": true,
      "OnBehalfOf": "sample string 2",
      "Capacity": "sample string 3",
      "Surname": "sample string 4",
      "Name": "sample string 5",
      "IdentityNo": "sample string 6",
      "MobileNumber": "sample string 7",
      "Email": "sample string 8",
      "SignerType": "sample string 9"
    },
    {
      "RSAResident": true,
      "OnBehalfOf": "sample string 2",
      "Capacity": "sample string 3",
      "Surname": "sample string 4",
      "Name": "sample string 5",
      "IdentityNo": "sample string 6",
      "MobileNumber": "sample string 7",
      "Email": "sample string 8",
      "SignerType": "sample string 9"
    }
  ],
  "Success": true,
  "Message": "sample string 2",
  "TransactionId": "sample string 3",
  "OcrDataAvailable": true
}

application/xml, text/xml

Sample:

<GetMetaDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MercantileEventHandler.ViewModels.ESB">
  <Message>sample string 2</Message>
  <OcrDataAvailable>true</OcrDataAvailable>
  <Success>true</Success>
  <TransactionId>sample string 3</TransactionId>
  <accountDetails>
    <AccountNumber_5>sample string 1</AccountNumber_5>
    <TransactionDate_2>2025-12-10T01:37:32.9412713+00:00</TransactionDate_2>
  </accountDetails>
  <accountList>
    <AccountList>
      <AccountName>sample string 2</AccountName>
      <AccountNumber>sample string 1</AccountNumber>
      <VatNumber>sample string 3</VatNumber>
    </AccountList>
    <AccountList>
      <AccountName>sample string 2</AccountName>
      <AccountNumber>sample string 1</AccountNumber>
      <VatNumber>sample string 3</VatNumber>
    </AccountList>
  </accountList>
  <applicantBank>
    <BankAddress>sample string 5</BankAddress>
    <BankName_46>sample string 1</BankName_46>
    <BranchCode>sample string 4</BranchCode>
    <BranchName>sample string 3</BranchName>
    <BranchNameAndCode_49>sample string 2</BranchNameAndCode_49>
    <City_47>sample string 6</City_47>
    <CorrespondentCode>sample string 9</CorrespondentCode>
    <Country_48>sample string 7</Country_48>
    <SwiftAddress_50>sample string 8</SwiftAddress_50>
  </applicantBank>
  <benificiaryRemitterDetails>
    <BankAccountNumber_52a>sample string 1</BankAccountNumber_52a>
    <BeneficiaryReference>sample string 15</BeneficiaryReference>
    <CanEdit>true</CanEdit>
    <DetailsOfCharges_65>sample string 16</DetailsOfCharges_65>
    <DetailsOfTransfer>sample string 14</DetailsOfTransfer>
    <FirstNames_54>sample string 3</FirstNames_54>
    <Gender_55>sample string 4</Gender_55>
    <PassportCountry_60>sample string 12</PassportCountry_60>
    <PassportNo_59>sample string 11</PassportNo_59>
    <RSAResident_61>true</RSAResident_61>
    <RecieverInformation>sample string 17</RecieverInformation>
    <ResidentialCity>sample string 6</ResidentialCity>
    <ResidentialCountry>sample string 9</ResidentialCountry>
    <ResidentialCountryCode>sample string 10</ResidentialCountryCode>
    <ResidentialProvince>sample string 7</ResidentialProvince>
    <ResidentialStreet>sample string 5</ResidentialStreet>
    <ResidentialZipCode>sample string 8</ResidentialZipCode>
    <SurnameOrEntityName_53>sample string 2</SurnameOrEntityName_53>
  </benificiaryRemitterDetails>
  <deals>
    <Deal>
      <DealNumber_7>sample string 1</DealNumber_7>
      <DealType>sample string 2</DealType>
      <ExchangeRate_11>1</ExchangeRate_11>
      <ForeignCurrencyAmount_10>1</ForeignCurrencyAmount_10>
      <RandAmount_12>1</RandAmount_12>
    </Deal>
    <Deal>
      <DealNumber_7>sample string 1</DealNumber_7>
      <DealType>sample string 2</DealType>
      <ExchangeRate_11>1</ExchangeRate_11>
      <ForeignCurrencyAmount_10>1</ForeignCurrencyAmount_10>
      <RandAmount_12>1</RandAmount_12>
    </Deal>
  </deals>
  <detailOfApplicant>
    <ApplicantType>sample string 2</ApplicantType>
    <CIFNumber_2>sample string 1</CIFNumber_2>
    <CustomsClientNo_17>sample string 6</CustomsClientNo_17>
    <DateOfBirth_33>2025-12-10T01:37:32.9412713+00:00</DateOfBirth_33>
    <EmailAddress_31>sample string 18</EmailAddress_31>
    <EntityName_14>sample string 4</EntityName_14>
    <FirstNames_15>sample string 5</FirstNames_15>
    <IDTypeLabel>sample string 19</IDTypeLabel>
    <IdentityNumber_32>sample string 20</IdentityNumber_32>
    <MobileNumber>sample string 17</MobileNumber>
    <PostalCity>sample string 13</PostalCity>
    <PostalProvince>sample string 14</PostalProvince>
    <PostalStreet>sample string 12</PostalStreet>
    <PostalZipCode>sample string 15</PostalZipCode>
    <ResidentialCity>sample string 8</ResidentialCity>
    <ResidentialCountry>sample string 11</ResidentialCountry>
    <ResidentialProvince>sample string 9</ResidentialProvince>
    <ResidentialStreet>sample string 7</ResidentialStreet>
    <ResidentialZipCode>sample string 10</ResidentialZipCode>
    <Surname_14>sample string 3</Surname_14>
    <TaxNumber_41>sample string 21</TaxNumber_41>
    <TelephoneNumber_29>sample string 16</TelephoneNumber_29>
  </detailOfApplicant>
  <fundsTransferInstruction>
    <AmountInWords>sample string 2</AmountInWords>
    <BenfAccountNumber_77>sample string 5</BenfAccountNumber_77>
    <BenfAccountType_78>sample string 6</BenfAccountType_78>
    <BenfAddress_76>sample string 4</BenfAddress_76>
    <BenfAmount_74>1</BenfAmount_74>
    <BenfBankBranch_80>sample string 8</BenfBankBranch_80>
    <BenfBankName_79>sample string 7</BenfBankName_79>
    <BenfBranchSortCode_81>sample string 9</BenfBranchSortCode_81>
    <BenfName_75>sample string 3</BenfName_75>
    <BenfReference_82>sample string 10</BenfReference_82>
  </fundsTransferInstruction>
  <header>
    <TransactionUniqueIdentifier>sample string 2</TransactionUniqueIdentifier>
    <TypeOfTransaction>sample string 1</TypeOfTransaction>
  </header>
  <info>
    <BOPs>
      <BOP>
        <Category_67>sample string 1</Category_67>
        <FCYAmount>1</FCYAmount>
        <SDAFIA>sample string 3</SDAFIA>
        <SubCategory_68>sample string 2</SubCategory_68>
        <TCS>sample string 4</TCS>
      </BOP>
      <BOP>
        <Category_67>sample string 1</Category_67>
        <FCYAmount>1</FCYAmount>
        <SDAFIA>sample string 3</SDAFIA>
        <SubCategory_68>sample string 2</SubCategory_68>
        <TCS>sample string 4</TCS>
      </BOP>
    </BOPs>
    <ContactCellNumber_39>sample string 11</ContactCellNumber_39>
    <ContactName_38>sample string 9</ContactName_38>
    <ContactSurname>sample string 10</ContactSurname>
    <CryptoTrade>true</CryptoTrade>
    <FCYCurrency>sample string 1</FCYCurrency>
    <FCYTotalAmount>1</FCYTotalAmount>
    <LoanInterestRate_71>8</LoanInterestRate_71>
    <LoanReferenceNo_69>sample string 4</LoanReferenceNo_69>
    <LoanTenor_70>sample string 5</LoanTenor_70>
    <PreviousCryptoDealID>sample string 14</PreviousCryptoDealID>
    <SARBAuthApplicationNo>sample string 6</SARBAuthApplicationNo>
    <SARBAuthReferenceNo>sample string 7</SARBAuthReferenceNo>
    <SARS_APN>sample string 3</SARS_APN>
    <TaxClearanceCertificateReference_44>sample string 2</TaxClearanceCertificateReference_44>
    <UCRNumber>sample string 13</UCRNumber>
    <VatNumber_40>sample string 12</VatNumber_40>
  </info>
  <paymentInstruction>
    <CounterCurrency>sample string 2</CounterCurrency>
    <CrossBorderCurrency_9>sample string 1</CrossBorderCurrency_9>
    <SwiftRef>sample string 3</SwiftRef>
    <TotalCounterAmount>1</TotalCounterAmount>
    <TotalCrossBorderAmount>1</TotalCrossBorderAmount>
    <ValueDate_8>2025-12-10T01:37:32.9412713+00:00</ValueDate_8>
  </paymentInstruction>
  <requiredDocuments>
    <RequiredDocument>
      <DocumentIdentifier_6>sample string 1</DocumentIdentifier_6>
    </RequiredDocument>
    <RequiredDocument>
      <DocumentIdentifier_6>sample string 1</DocumentIdentifier_6>
    </RequiredDocument>
  </requiredDocuments>
  <signers>
    <Signer>
      <Capacity>sample string 3</Capacity>
      <Email>sample string 8</Email>
      <IdentityNo>sample string 6</IdentityNo>
      <MobileNumber>sample string 7</MobileNumber>
      <Name>sample string 5</Name>
      <OnBehalfOf>sample string 2</OnBehalfOf>
      <RSAResident>true</RSAResident>
      <SignerType>sample string 9</SignerType>
      <Surname>sample string 4</Surname>
    </Signer>
    <Signer>
      <Capacity>sample string 3</Capacity>
      <Email>sample string 8</Email>
      <IdentityNo>sample string 6</IdentityNo>
      <MobileNumber>sample string 7</MobileNumber>
      <Name>sample string 5</Name>
      <OnBehalfOf>sample string 2</OnBehalfOf>
      <RSAResident>true</RSAResident>
      <SignerType>sample string 9</SignerType>
      <Surname>sample string 4</Surname>
    </Signer>
  </signers>
  <thirdPartyInfos>
    <ThirdPartyInfo>
      <CellNo_120>sample string 11</CellNo_120>
      <Country>sample string 6</Country>
      <DateOfBirth_111>2025-12-10T01:37:32.9412713+00:00</DateOfBirth_111>
      <EmailAddress_122>sample string 12</EmailAddress_122>
      <EntityCCN_118>sample string 9</EntityCCN_118>
      <Gender_112>sample string 5</Gender_112>
      <IdentityNo_110>sample string 4</IdentityNo_110>
      <IdentityType>sample string 3</IdentityType>
      <Name_109>sample string 2</Name_109>
      <PostalCity>sample string 18</PostalCity>
      <PostalProvince>sample string 19</PostalProvince>
      <PostalStreet>sample string 17</PostalStreet>
      <PostalZipCode>sample string 20</PostalZipCode>
      <ResidentialCity>sample string 14</ResidentialCity>
      <ResidentialProvince>sample string 15</ResidentialProvince>
      <ResidentialStreet>sample string 13</ResidentialStreet>
      <ResidentialZipCode>sample string 16</ResidentialZipCode>
      <Surname_108>sample string 1</Surname_108>
      <TaxNo_116>sample string 7</TaxNo_116>
      <TelephoneNo_119>sample string 10</TelephoneNo_119>
      <VatNo_117>sample string 8</VatNo_117>
    </ThirdPartyInfo>
    <ThirdPartyInfo>
      <CellNo_120>sample string 11</CellNo_120>
      <Country>sample string 6</Country>
      <DateOfBirth_111>2025-12-10T01:37:32.9412713+00:00</DateOfBirth_111>
      <EmailAddress_122>sample string 12</EmailAddress_122>
      <EntityCCN_118>sample string 9</EntityCCN_118>
      <Gender_112>sample string 5</Gender_112>
      <IdentityNo_110>sample string 4</IdentityNo_110>
      <IdentityType>sample string 3</IdentityType>
      <Name_109>sample string 2</Name_109>
      <PostalCity>sample string 18</PostalCity>
      <PostalProvince>sample string 19</PostalProvince>
      <PostalStreet>sample string 17</PostalStreet>
      <PostalZipCode>sample string 20</PostalZipCode>
      <ResidentialCity>sample string 14</ResidentialCity>
      <ResidentialProvince>sample string 15</ResidentialProvince>
      <ResidentialStreet>sample string 13</ResidentialStreet>
      <ResidentialZipCode>sample string 16</ResidentialZipCode>
      <Surname_108>sample string 1</Surname_108>
      <TaxNo_116>sample string 7</TaxNo_116>
      <TelephoneNo_119>sample string 10</TelephoneNo_119>
      <VatNo_117>sample string 8</VatNo_117>
    </ThirdPartyInfo>
  </thirdPartyInfos>
</GetMetaDataResponse>