POST api/AskFriend/AddTopupRequest

Request Information

URI Parameters

None.

Body Parameters

TopupRequestModel
NameDescriptionTypeAdditional information
ID

globally unique identifier

None.

UserID

globally unique identifier

None.

BankCardTopupID

globally unique identifier

None.

SourcePaymentID

integer

None.

Message

string

None.

DateCreated

date

None.

DateUpdated

date

None.

IPAddress

string

None.

Status

integer

None.

RequestLink

string

None.

BankCardTopup

BankCardTopupViewModel

None.

CheckoutLink

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": "00a00f3c-7e2f-4849-a1a3-1bb60d49b889",
  "UserID": "f26bc2b2-2dd7-46ba-90e8-2cd0bc64cbfd",
  "BankCardTopupID": "03e6acc8-0c04-41a5-89eb-56ae19a081fb",
  "SourcePaymentID": 4,
  "Message": "sample string 5",
  "DateCreated": "2024-10-15T08:17:58.3806446+00:00",
  "DateUpdated": "2024-10-15T08:17:58.3806446+00:00",
  "IPAddress": "sample string 7",
  "Status": 1,
  "RequestLink": "sample string 8",
  "BankCardTopup": {
    "BankCardProcessID": "b14c0d31-8330-47aa-bbe5-e595e1a6c21e",
    "CheckoutToken": "sample string 2",
    "CurrencyCountryID": "sample string 3",
    "UnloadFeeTransactionId": "3addba68-b473-4c95-8e78-acacb6b4bf57",
    "ID": "35902e64-5391-4114-af0b-2b75af8cf701",
    "UserID": "78ffaa8d-c74e-4eea-b694-9d5b28092126",
    "Amount": 6.1,
    "AdditionalAmount": 7.1,
    "DateProcessed": "2024-10-15T08:17:58.3806446+00:00",
    "SourcePaymentID": 8,
    "Description": "sample string 9",
    "TransactionID": "sample string 10",
    "DateCreated": "2024-10-15T08:17:58.3806446+00:00",
    "LoadAmount": 12.1,
    "LoadAdditionalAmount": 13.1,
    "LoadCurrencyCountryID": "sample string 14",
    "LoadTransactionID": "sample string 15",
    "ConversionRate": 16.1,
    "LoadPercentage": 17.1,
    "BankCardTopupID": "f7756d3b-bd74-4c35-9f84-534bc839dee4",
    "BankCardID": "d757f2aa-31a9-4080-a120-e57a8e81663a",
    "isFirst": true,
    "SponsorProductId": "68819b5b-fb87-40d5-9a7b-3bd50ddccc4c",
    "PaymentGateway": 20,
    "PaytabResponseCode": "sample string 21",
    "SelectedAccountNo": "sample string 22",
    "SelectedAccountId": "sample string 23",
    "SelectedEntityId": "sample string 24",
    "BankiomAccount": "sample string 25",
    "SelectedAccount": {
      "id": "sample string 1",
      "account_id": "sample string 2",
      "account_name": "sample string 3",
      "account_number": "sample string 4",
      "iban": "sample string 5",
      "balance": 6.1,
      "currency": "sample string 7",
      "balance_last_updated": "2024-10-15T08:17:58.3806446+00:00"
    },
    "OrderId": "sample string 26",
    "Platform": "sample string 27",
    "TopupStatusTypeID": 28,
    "AskAFriendPaymentLink": "sample string 29",
    "FeeTypeCode": "sample string 30",
    "FeeId": "7e566008-dcee-4654-a865-1b887c97199c",
    "FeeCalculationType": 0,
    "LoadedInCard": 1.1,
    "LoadedInCardAED": 1.1
  },
  "CheckoutLink": "sample string 9"
}

application/xml, text/xml

Sample:
<TopupRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.DataLayer.Common">
  <BankCardTopup>
    <AdditionalAmount>7.1</AdditionalAmount>
    <Amount>6.1</Amount>
    <AskAFriendPaymentLink>sample string 29</AskAFriendPaymentLink>
    <BankCardID>d757f2aa-31a9-4080-a120-e57a8e81663a</BankCardID>
    <BankCardProcessID>b14c0d31-8330-47aa-bbe5-e595e1a6c21e</BankCardProcessID>
    <BankCardTopupID>f7756d3b-bd74-4c35-9f84-534bc839dee4</BankCardTopupID>
    <BankiomAccount>sample string 25</BankiomAccount>
    <CheckoutToken>sample string 2</CheckoutToken>
    <ConversionRate>16.1</ConversionRate>
    <CurrencyCountryID>sample string 3</CurrencyCountryID>
    <DateCreated>2024-10-15T08:17:58.3806446+00:00</DateCreated>
    <DateProcessed>2024-10-15T08:17:58.3806446+00:00</DateProcessed>
    <Description>sample string 9</Description>
    <FeeCalculationType>Default</FeeCalculationType>
    <FeeId>7e566008-dcee-4654-a865-1b887c97199c</FeeId>
    <FeeTypeCode>sample string 30</FeeTypeCode>
    <ID>35902e64-5391-4114-af0b-2b75af8cf701</ID>
    <LoadAdditionalAmount>13.1</LoadAdditionalAmount>
    <LoadAmount>12.1</LoadAmount>
    <LoadCurrencyCountryID>sample string 14</LoadCurrencyCountryID>
    <LoadPercentage>17.1</LoadPercentage>
    <LoadTransactionID>sample string 15</LoadTransactionID>
    <LoadedInCard>1.1</LoadedInCard>
    <LoadedInCardAED>1.1</LoadedInCardAED>
    <OrderId>sample string 26</OrderId>
    <PaymentGateway>20</PaymentGateway>
    <PaytabResponseCode>sample string 21</PaytabResponseCode>
    <Platform>sample string 27</Platform>
    <SelectedAccount>
      <account_id>sample string 2</account_id>
      <account_name>sample string 3</account_name>
      <account_number>sample string 4</account_number>
      <balance>6.1</balance>
      <balance_last_updated>2024-10-15T08:17:58.3806446+00:00</balance_last_updated>
      <currency>sample string 7</currency>
      <iban>sample string 5</iban>
      <id>sample string 1</id>
    </SelectedAccount>
    <SelectedAccountId>sample string 23</SelectedAccountId>
    <SelectedAccountNo>sample string 22</SelectedAccountNo>
    <SelectedEntityId>sample string 24</SelectedEntityId>
    <SourcePaymentID>8</SourcePaymentID>
    <SponsorProductId>68819b5b-fb87-40d5-9a7b-3bd50ddccc4c</SponsorProductId>
    <TopupStatusTypeID>28</TopupStatusTypeID>
    <TransactionID>sample string 10</TransactionID>
    <UnloadFeeTransactionId>3addba68-b473-4c95-8e78-acacb6b4bf57</UnloadFeeTransactionId>
    <UserID>78ffaa8d-c74e-4eea-b694-9d5b28092126</UserID>
    <isFirst>true</isFirst>
  </BankCardTopup>
  <BankCardTopupID>03e6acc8-0c04-41a5-89eb-56ae19a081fb</BankCardTopupID>
  <CheckoutLink>sample string 9</CheckoutLink>
  <DateCreated>2024-10-15T08:17:58.3806446+00:00</DateCreated>
  <DateUpdated>2024-10-15T08:17:58.3806446+00:00</DateUpdated>
  <ID>00a00f3c-7e2f-4849-a1a3-1bb60d49b889</ID>
  <IPAddress>sample string 7</IPAddress>
  <Message>sample string 5</Message>
  <RequestLink>sample string 8</RequestLink>
  <SourcePaymentID>4</SourcePaymentID>
  <Status>1</Status>
  <UserID>f26bc2b2-2dd7-46ba-90e8-2cd0bc64cbfd</UserID>
</TopupRequestModel>

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 'TopupRequestModel'.

Response Information

Resource Description

OperationStatusOfTopupRequestModel
NameDescriptionTypeAdditional information
Result

TopupRequestModel

None.

HasNoData

boolean

None.

ErrorMsg

string

None.

Succeeded

boolean

None.

AlreadyExists

boolean

None.

NotFound

boolean

None.

Error

Exception

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "ID": "8a2f8f61-0eb0-4d39-886f-fc646c2f0b4a",
    "UserID": "80d4e528-979f-47ab-8f4c-8c10ee0ae7e7",
    "BankCardTopupID": "99560133-67fe-4b96-87d5-0a2855024208",
    "SourcePaymentID": 4,
    "Message": "sample string 5",
    "DateCreated": "2024-10-15T08:17:58.3962369+00:00",
    "DateUpdated": "2024-10-15T08:17:58.3962369+00:00",
    "IPAddress": "sample string 7",
    "Status": 1,
    "RequestLink": "sample string 8",
    "BankCardTopup": {
      "BankCardProcessID": "90f4ddc9-a447-4115-9f43-8671c29cb3c6",
      "CheckoutToken": "sample string 2",
      "CurrencyCountryID": "sample string 3",
      "UnloadFeeTransactionId": "ef641b24-161e-48f5-83ef-c54dc8ebcbfc",
      "ID": "05b666e6-f996-41f3-86cd-e9cada84ca78",
      "UserID": "2f4537cb-4588-4026-8afd-d6f58675ad82",
      "Amount": 6.1,
      "AdditionalAmount": 7.1,
      "DateProcessed": "2024-10-15T08:17:58.3962369+00:00",
      "SourcePaymentID": 8,
      "Description": "sample string 9",
      "TransactionID": "sample string 10",
      "DateCreated": "2024-10-15T08:17:58.3962369+00:00",
      "LoadAmount": 12.1,
      "LoadAdditionalAmount": 13.1,
      "LoadCurrencyCountryID": "sample string 14",
      "LoadTransactionID": "sample string 15",
      "ConversionRate": 16.1,
      "LoadPercentage": 17.1,
      "BankCardTopupID": "5387994b-9c46-476e-a010-8de5120477f5",
      "BankCardID": "f636b541-2120-4070-84f7-540e88185a89",
      "isFirst": true,
      "SponsorProductId": "aa01b54f-c8ac-48cf-b1d8-8dd09a06c4f8",
      "PaymentGateway": 20,
      "PaytabResponseCode": "sample string 21",
      "SelectedAccountNo": "sample string 22",
      "SelectedAccountId": "sample string 23",
      "SelectedEntityId": "sample string 24",
      "BankiomAccount": "sample string 25",
      "SelectedAccount": {
        "id": "sample string 1",
        "account_id": "sample string 2",
        "account_name": "sample string 3",
        "account_number": "sample string 4",
        "iban": "sample string 5",
        "balance": 6.1,
        "currency": "sample string 7",
        "balance_last_updated": "2024-10-15T08:17:58.3962369+00:00"
      },
      "OrderId": "sample string 26",
      "Platform": "sample string 27",
      "TopupStatusTypeID": 28,
      "AskAFriendPaymentLink": "sample string 29",
      "FeeTypeCode": "sample string 30",
      "FeeId": "af0e726e-3d99-48ee-b98e-990c7eb44ecd",
      "FeeCalculationType": 0,
      "LoadedInCard": 1.1,
      "LoadedInCardAED": 1.1
    },
    "CheckoutLink": "sample string 9"
  },
  "HasNoData": true,
  "ErrorMsg": "sample string 2",
  "Succeeded": true,
  "AlreadyExists": true,
  "NotFound": true,
  "Error": {
    "ClassName": "System.Exception",
    "Message": null,
    "Data": null,
    "InnerException": null,
    "HelpURL": "sample string 1",
    "StackTraceString": null,
    "RemoteStackTraceString": null,
    "RemoteStackIndex": 0,
    "ExceptionMethod": null,
    "HResult": 3,
    "Source": "sample string 2",
    "WatsonBuckets": null
  }
}

application/xml, text/xml

Sample:
<OperationStatusOfTopupRequestModels25BU49F xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.DataLayer.Common">
  <AlreadyExists>true</AlreadyExists>
  <Error xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <ClassName xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">System.Exception</ClassName>
    <Message i:nil="true" xmlns="" />
    <Data i:nil="true" xmlns="" />
    <InnerException i:nil="true" xmlns="" />
    <HelpURL xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 1</HelpURL>
    <StackTraceString i:nil="true" xmlns="" />
    <RemoteStackTraceString i:nil="true" xmlns="" />
    <RemoteStackIndex xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">0</RemoteStackIndex>
    <ExceptionMethod i:nil="true" xmlns="" />
    <HResult xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">3</HResult>
    <Source xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 2</Source>
    <WatsonBuckets i:nil="true" xmlns="" />
  </Error>
  <ErrorMsg>sample string 2</ErrorMsg>
  <HasNoData>true</HasNoData>
  <NotFound>true</NotFound>
  <Result>
    <BankCardTopup>
      <AdditionalAmount>7.1</AdditionalAmount>
      <Amount>6.1</Amount>
      <AskAFriendPaymentLink>sample string 29</AskAFriendPaymentLink>
      <BankCardID>f636b541-2120-4070-84f7-540e88185a89</BankCardID>
      <BankCardProcessID>90f4ddc9-a447-4115-9f43-8671c29cb3c6</BankCardProcessID>
      <BankCardTopupID>5387994b-9c46-476e-a010-8de5120477f5</BankCardTopupID>
      <BankiomAccount>sample string 25</BankiomAccount>
      <CheckoutToken>sample string 2</CheckoutToken>
      <ConversionRate>16.1</ConversionRate>
      <CurrencyCountryID>sample string 3</CurrencyCountryID>
      <DateCreated>2024-10-15T08:17:58.3962369+00:00</DateCreated>
      <DateProcessed>2024-10-15T08:17:58.3962369+00:00</DateProcessed>
      <Description>sample string 9</Description>
      <FeeCalculationType>Default</FeeCalculationType>
      <FeeId>af0e726e-3d99-48ee-b98e-990c7eb44ecd</FeeId>
      <FeeTypeCode>sample string 30</FeeTypeCode>
      <ID>05b666e6-f996-41f3-86cd-e9cada84ca78</ID>
      <LoadAdditionalAmount>13.1</LoadAdditionalAmount>
      <LoadAmount>12.1</LoadAmount>
      <LoadCurrencyCountryID>sample string 14</LoadCurrencyCountryID>
      <LoadPercentage>17.1</LoadPercentage>
      <LoadTransactionID>sample string 15</LoadTransactionID>
      <LoadedInCard>1.1</LoadedInCard>
      <LoadedInCardAED>1.1</LoadedInCardAED>
      <OrderId>sample string 26</OrderId>
      <PaymentGateway>20</PaymentGateway>
      <PaytabResponseCode>sample string 21</PaytabResponseCode>
      <Platform>sample string 27</Platform>
      <SelectedAccount>
        <account_id>sample string 2</account_id>
        <account_name>sample string 3</account_name>
        <account_number>sample string 4</account_number>
        <balance>6.1</balance>
        <balance_last_updated>2024-10-15T08:17:58.3962369+00:00</balance_last_updated>
        <currency>sample string 7</currency>
        <iban>sample string 5</iban>
        <id>sample string 1</id>
      </SelectedAccount>
      <SelectedAccountId>sample string 23</SelectedAccountId>
      <SelectedAccountNo>sample string 22</SelectedAccountNo>
      <SelectedEntityId>sample string 24</SelectedEntityId>
      <SourcePaymentID>8</SourcePaymentID>
      <SponsorProductId>aa01b54f-c8ac-48cf-b1d8-8dd09a06c4f8</SponsorProductId>
      <TopupStatusTypeID>28</TopupStatusTypeID>
      <TransactionID>sample string 10</TransactionID>
      <UnloadFeeTransactionId>ef641b24-161e-48f5-83ef-c54dc8ebcbfc</UnloadFeeTransactionId>
      <UserID>2f4537cb-4588-4026-8afd-d6f58675ad82</UserID>
      <isFirst>true</isFirst>
    </BankCardTopup>
    <BankCardTopupID>99560133-67fe-4b96-87d5-0a2855024208</BankCardTopupID>
    <CheckoutLink>sample string 9</CheckoutLink>
    <DateCreated>2024-10-15T08:17:58.3962369+00:00</DateCreated>
    <DateUpdated>2024-10-15T08:17:58.3962369+00:00</DateUpdated>
    <ID>8a2f8f61-0eb0-4d39-886f-fc646c2f0b4a</ID>
    <IPAddress>sample string 7</IPAddress>
    <Message>sample string 5</Message>
    <RequestLink>sample string 8</RequestLink>
    <SourcePaymentID>4</SourcePaymentID>
    <Status>1</Status>
    <UserID>80d4e528-979f-47ab-8f4c-8c10ee0ae7e7</UserID>
  </Result>
  <Succeeded>true</Succeeded>
</OperationStatusOfTopupRequestModels25BU49F>