POST v2/consumers/accounts/{accountId}/payment/initialize

Request Information

URI Parameters

Name	Description	Type	Additional information
accountId		globally unique identifier	Required

Body Parameters

InitializePaymentRequest_V2

Name	Type	Additional information
DeviceId	globally unique identifier	None.
RecipientIban	string	None.
RecipientName	string	None.
PaymentAmount	decimal number	None.
ReferenceNumber	string	None.
Message	string	None.
OwnMessage	string	None.
DueDate	date	None.
SaveRecipient	boolean	None.
SaveTemplate	boolean	None.
Bic	string	None.
PaymentTemplateId	globally unique identifier	None.
PaymentRecipientId	globally unique identifier	None.
SourceData	TransactionSourceData	None.

Request Formats

application/json, text/json

Sample:

{
  "DeviceId": "d0f8c200-27e4-4695-86dc-512a40c7d435",
  "RecipientIban": "sample string 1",
  "RecipientName": "sample string 2",
  "PaymentAmount": 3.0,
  "ReferenceNumber": "sample string 4",
  "Message": "sample string 5",
  "OwnMessage": "sample string 6",
  "DueDate": "2026-07-03T15:56:40.1036968+00:00",
  "SaveRecipient": true,
  "SaveTemplate": true,
  "Bic": "sample string 10",
  "PaymentTemplateId": "3c6f5ae7-7c16-45d4-a597-970ddd3d11fa",
  "PaymentRecipientId": "4e747e16-9fbc-47b8-a16a-629090731b2a",
  "SourceData": {
    "ChannelEnum": 0,
    "IdentificationTypeEnum": "NULL",
    "CreateTime": "2026-07-03T15:56:40.1036968+00:00",
    "IdentificationBankCode": "sample string 1",
    "IdentificationDetail": "sample string 2",
    "IpAddress": "sample string 3",
    "DeviceTypeCode": "sample string 4",
    "ApplicationSourceEnum": 0,
    "AffiliateSourceCode": "sample string 5",
    "AffiliateMediumCode": "sample string 6",
    "AffiliateCampaignCode": "sample string 7",
    "AffiliateTransactionCode": "sample string 8",
    "SearchEngineCode": "sample string 9",
    "SearchEngineTransactionCode": "sample string 10",
    "SearchKeyword": "sample string 11",
    "OperatingSystemCode": "sample string 12",
    "LandingPageUrl": "sample string 13",
    "PageUrl": "sample string 14",
    "IsMobileDevice": true,
    "TrackingCookieId": "sample string 15",
    "SessionCode": "sample string 16",
    "FirstVisitTime": "2026-07-03T15:56:40.1036968+00:00",
    "SessionStartTime": "2026-07-03T15:56:40.1036968+00:00",
    "PageVisitHistory": "sample string 17",
    "ReferrerUrl": "sample string 18",
    "ExternalCampaignCode": "sample string 19",
    "ExternalTransactionCode": "sample string 20",
    "UserName": "sample string 21",
    "UserRoleCode": "sample string 22",
    "ABTestingCode": "sample string 23"
  }
}

application/xml, text/xml

Sample:

<InitializePaymentRequest_V2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfMobileApi.Models">
  <SourceData>
    <ABTestingCode>sample string 23</ABTestingCode>
    <AffiliateCampaignCode>sample string 7</AffiliateCampaignCode>
    <AffiliateMediumCode>sample string 6</AffiliateMediumCode>
    <AffiliateSourceCode>sample string 5</AffiliateSourceCode>
    <AffiliateTransactionCode>sample string 8</AffiliateTransactionCode>
    <ApplicationSourceEnum>NULL</ApplicationSourceEnum>
    <ChannelEnum>NULL</ChannelEnum>
    <CreateTime>2026-07-03T15:56:40.1036968+00:00</CreateTime>
    <DeviceTypeCode>sample string 4</DeviceTypeCode>
    <ExternalCampaignCode>sample string 19</ExternalCampaignCode>
    <ExternalTransactionCode>sample string 20</ExternalTransactionCode>
    <FirstVisitTime>2026-07-03T15:56:40.1036968+00:00</FirstVisitTime>
    <IdentificationBankCode>sample string 1</IdentificationBankCode>
    <IdentificationDetail>sample string 2</IdentificationDetail>
    <IdentificationTypeEnum>NULL</IdentificationTypeEnum>
    <IpAddress>sample string 3</IpAddress>
    <IsMobileDevice>true</IsMobileDevice>
    <LandingPageUrl>sample string 13</LandingPageUrl>
    <OperatingSystemCode>sample string 12</OperatingSystemCode>
    <PageUrl>sample string 14</PageUrl>
    <PageVisitHistory>sample string 17</PageVisitHistory>
    <ReferrerUrl>sample string 18</ReferrerUrl>
    <SearchEngineCode>sample string 9</SearchEngineCode>
    <SearchEngineTransactionCode>sample string 10</SearchEngineTransactionCode>
    <SearchKeyword>sample string 11</SearchKeyword>
    <SessionCode>sample string 16</SessionCode>
    <SessionStartTime>2026-07-03T15:56:40.1036968+00:00</SessionStartTime>
    <TrackingCookieId>sample string 15</TrackingCookieId>
    <UserName>sample string 21</UserName>
    <UserRoleCode>sample string 22</UserRoleCode>
  </SourceData>
  <Bic>sample string 10</Bic>
  <DueDate>2026-07-03T15:56:40.1036968+00:00</DueDate>
  <Message>sample string 5</Message>
  <OwnMessage>sample string 6</OwnMessage>
  <PaymentAmount>3</PaymentAmount>
  <PaymentRecipientId>4e747e16-9fbc-47b8-a16a-629090731b2a</PaymentRecipientId>
  <PaymentTemplateId>3c6f5ae7-7c16-45d4-a597-970ddd3d11fa</PaymentTemplateId>
  <RecipientIban>sample string 1</RecipientIban>
  <RecipientName>sample string 2</RecipientName>
  <ReferenceNumber>sample string 4</ReferenceNumber>
  <SaveRecipient>true</SaveRecipient>
  <SaveTemplate>true</SaveTemplate>
  <DeviceId>d0f8c200-27e4-4695-86dc-512a40c7d435</DeviceId>
</InitializePaymentRequest_V2>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.