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

Request Information

URI Parameters

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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": "1b7a9d69-7319-4e23-b4ef-bd71c1015ada",
  "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": "18eb94b0-119d-460e-9746-fcb81b2b73f8",
    "veryfiId": 1,
    "createdAt": "2025-05-13T03:40:59.6648315+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-05-13T03:40:59.6648315+03:00",
    "invoiceNo": "sample string 10",
    "invoiceQuantity": 1,
    "fileName": "sample string 11",
    "imgUrl": "sample string 12",
    "fileId": "0c5a9e52-43a0-4de8-9f14-65fd9176b318",
    "executedAmount": 1.0,
    "isActive": true,
    "ocrPreference": {
      "id": "21e89f28-15c7-434b-90ba-920e09a8d637",
      "preferedCurrency": "sample string 1",
      "costType": 1,
      "beneficiaryId": "4988c877-a2c4-4c5b-b250-2578ee59f2c6",
      "amount": 1.0,
      "paymentVeryfiOCRID": "9b9e5501-f56b-448e-998a-3b0eebfea498"
    }
  },
  "beneficiaryId": "10e475bb-e6e7-4878-8db1-8247e7efbc88"
}

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>10e475bb-e6e7-4878-8db1-8247e7efbc88</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>1b7a9d69-7319-4e23-b4ef-bd71c1015ada</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-05-13T03:40:59.6648315+03:00</CreatedAt>
    <Currency>sample string 3</Currency>
    <ExecutedAmount>1</ExecutedAmount>
    <FileId>0c5a9e52-43a0-4de8-9f14-65fd9176b318</FileId>
    <FileName>sample string 11</FileName>
    <Id>18eb94b0-119d-460e-9746-fcb81b2b73f8</Id>
    <ImgUrl>sample string 12</ImgUrl>
    <InvoiceDate>2025-05-13T03:40:59.6648315+03:00</InvoiceDate>
    <InvoiceNo>sample string 10</InvoiceNo>
    <InvoicePayerName>sample string 9</InvoicePayerName>
    <InvoiceQuantity>1</InvoiceQuantity>
    <IsActive>true</IsActive>
    <OcrPreference>
      <Amount>1</Amount>
      <BeneficiaryId>4988c877-a2c4-4c5b-b250-2578ee59f2c6</BeneficiaryId>
      <CostType>1</CostType>
      <Id>21e89f28-15c7-434b-90ba-920e09a8d637</Id>
      <PaymentVeryfiOCRID>9b9e5501-f56b-448e-998a-3b0eebfea498</PaymentVeryfiOCRID>
      <PreferedCurrency>sample string 1</PreferedCurrency>
    </OcrPreference>
    <veryfiId>1</veryfiId>
  </PaymentVeryfiOcrViewModel>
  <ProfileId>1</ProfileId>
</PaymentRequestViewModel>