POST api/Payment/CreatePaymentRequest?beneficiaryId={beneficiaryId}&amount={amount}&costType={costType}&ocrId={ocrId}

Request Information

URI Parameters

Name	Type	Additional information
beneficiaryId	globally unique identifier	Required
amount	decimal number	Required
costType	integer	Required
ocrId	globally unique identifier	None.

Body Parameters

None.

Response Information

Resource Description

PaymentRequestViewModel

Name	Type	Additional information
PaymentRequestId	globally unique identifier	None.
Amount	decimal number	None.
CostType	CostType	None.
CostAmount	decimal number	None.
NecessaryFiles	Collection of string	None.
Currency	string	None.
PaymentReasonId	integer	None.
ProfileId	integer	None.
PaymentVeryfiOcrViewModel	PaymentVeryfiOcrViewModel	None.
BeneficiaryId	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

{
  "paymentRequestId": "9abf4d84-4078-4764-8927-20e16807ed99",
  "amount": 1.0,
  "costType": 1,
  "costAmount": 2.0,
  "necessaryFiles": [
    "sample string 1",
    "sample string 2"
  ],
  "currency": "sample string 3",
  "paymentReasonId": 1,
  "profileId": 1,
  "paymentVeryfiOcrViewModel": {
    "id": "cdaaf21b-4b97-4bab-8b36-e602ad8daa4c",
    "veryfiId": 1,
    "createdAt": "2025-10-20T02:09:33.4242831+03:00",
    "amount": 1.0,
    "currency": "sample string 3",
    "beneficiaryName": "sample string 4",
    "bankCountry": "sample string 5",
    "bankAccountDetails": "sample string 6",
    "bankAccountNo": "sample string 7",
    "beneficiaryAddress": "sample string 8",
    "invoicePayerName": "sample string 9",
    "invoiceDate": "2025-10-20T02:09:33.4242831+03:00",
    "invoiceNo": "sample string 10",
    "invoiceQuantity": 1,
    "fileName": "sample string 11",
    "imgUrl": "sample string 12",
    "fileId": "b910f34c-c908-444b-a58d-d262f25a4fe3",
    "executedAmount": 1.0,
    "isActive": true,
    "ocrPreference": {
      "id": "3ba8548b-363f-4737-aa41-184c5d806243",
      "preferedCurrency": "sample string 1",
      "costType": 1,
      "beneficiaryId": "d4103b53-e581-4a70-b20b-980abef18043",
      "amount": 1.0,
      "paymentVeryfiOCRID": "8ce1e105-5b42-4627-acbc-2b3cfa47e197"
    }
  },
  "beneficiaryId": "2a2918bb-9052-46e6-95e0-e1556a0de2d9"
}

application/xml, text/xml

Sample:

<PaymentRequestViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EvenEdgeService.Models">
  <Amount>1</Amount>
  <BeneficiaryId>2a2918bb-9052-46e6-95e0-e1556a0de2d9</BeneficiaryId>
  <CostType>regular</CostType>
  <Currency>sample string 3</Currency>
  <NecessaryFiles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </NecessaryFiles>
  <PaymentReasonId>1</PaymentReasonId>
  <PaymentRequestId>9abf4d84-4078-4764-8927-20e16807ed99</PaymentRequestId>
  <PaymentVeryfiOcrViewModel>
    <Amount>1</Amount>
    <BankAccountDetails>sample string 6</BankAccountDetails>
    <BankAccountNo>sample string 7</BankAccountNo>
    <BankCountry>sample string 5</BankCountry>
    <BeneficiaryAddress>sample string 8</BeneficiaryAddress>
    <BeneficiaryName>sample string 4</BeneficiaryName>
    <CreatedAt>2025-10-20T02:09:33.4242831+03:00</CreatedAt>
    <Currency>sample string 3</Currency>
    <ExecutedAmount>1</ExecutedAmount>
    <FileId>b910f34c-c908-444b-a58d-d262f25a4fe3</FileId>
    <FileName>sample string 11</FileName>
    <Id>cdaaf21b-4b97-4bab-8b36-e602ad8daa4c</Id>
    <ImgUrl>sample string 12</ImgUrl>
    <InvoiceDate>2025-10-20T02:09:33.4242831+03:00</InvoiceDate>
    <InvoiceNo>sample string 10</InvoiceNo>
    <InvoicePayerName>sample string 9</InvoicePayerName>
    <InvoiceQuantity>1</InvoiceQuantity>
    <IsActive>true</IsActive>
    <OcrPreference>
      <Amount>1</Amount>
      <BeneficiaryId>d4103b53-e581-4a70-b20b-980abef18043</BeneficiaryId>
      <CostType>1</CostType>
      <Id>3ba8548b-363f-4737-aa41-184c5d806243</Id>
      <PaymentVeryfiOCRID>8ce1e105-5b42-4627-acbc-2b3cfa47e197</PaymentVeryfiOCRID>
      <PreferedCurrency>sample string 1</PreferedCurrency>
    </OcrPreference>
    <veryfiId>1</veryfiId>
  </PaymentVeryfiOcrViewModel>
  <ProfileId>1</ProfileId>
</PaymentRequestViewModel>