POST V1/Payments.{ext}/GeneratePaymentFile?companyId={companyId}&notificationId={notificationId}&paymentFileDate={paymentFileDate}

Generate Payment File for the List of FSDetails(bills/Transactions) from different Funding Statements and one payment file can have bills/transactions from different clients.
Mandatory Fields : companyId,fsDetailsList,notificationId, paymentFileDate
Optional Fields : N/A.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyId

Company id

string

Required

notificationId

Notification id

string

Required

paymentFileDate

Payment file date

string

Required

ext

Which media types are acceptable for the response, such as json/xml

If no matches are found, the content negotiator tries to match on the media type of the request body, if any. For example, if the request contains JSON data, the content negotiator looks for a JSON formatter.

string

Content-Type: application/json OR application/xml

Body Parameters

Funding statement detail list

Collection of EMS.Payments.Entities.FsDetailSummary
NameDescriptionTypeAdditional information
FsId

Funding statement id

string

None.

FSDetailId

Funding statement details ids

string

None.

ACHIDS

ACHIDS

string

None.

CHECKIDS

CHECKIDS

string

None.

SUCCIDS

SUCCIDS

string

None.

TransactionId

Transaction Id

string

None.

DeliveryMethod

Delivery Method

string

None.

PaymentMethod

Payment Method

string

None.

Amount

Amount

string

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "fsId": "sample string 1",
    "fsDetailId": "sample string 2",
    "achids": "sample string 3",
    "checkids": "sample string 4",
    "succids": "sample string 5",
    "transactionId": "sample string 6",
    "deliveryMethod": "sample string 7",
    "paymentMethod": "sample string 8",
    "amount": "sample string 9"
  },
  {
    "fsId": "sample string 1",
    "fsDetailId": "sample string 2",
    "achids": "sample string 3",
    "checkids": "sample string 4",
    "succids": "sample string 5",
    "transactionId": "sample string 6",
    "deliveryMethod": "sample string 7",
    "paymentMethod": "sample string 8",
    "amount": "sample string 9"
  }
]

application/xml, text/xml

Sample:
<ArrayOfFsDetailSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EMS.Payments.Entities">
  <FsDetailSummary>
    <ACHIDS>sample string 3</ACHIDS>
    <Amount>sample string 9</Amount>
    <CHECKIDS>sample string 4</CHECKIDS>
    <DeliveryMethod>sample string 7</DeliveryMethod>
    <FSDetailId>sample string 2</FSDetailId>
    <FsId>sample string 1</FsId>
    <PaymentMethod>sample string 8</PaymentMethod>
    <SUCCIDS>sample string 5</SUCCIDS>
    <TransactionId>sample string 6</TransactionId>
  </FsDetailSummary>
  <FsDetailSummary>
    <ACHIDS>sample string 3</ACHIDS>
    <Amount>sample string 9</Amount>
    <CHECKIDS>sample string 4</CHECKIDS>
    <DeliveryMethod>sample string 7</DeliveryMethod>
    <FSDetailId>sample string 2</FSDetailId>
    <FsId>sample string 1</FsId>
    <PaymentMethod>sample string 8</PaymentMethod>
    <SUCCIDS>sample string 5</SUCCIDS>
    <TransactionId>sample string 6</TransactionId>
  </FsDetailSummary>
</ArrayOfFsDetailSummary>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

EMSResponseOfEMS.Common.TransactionResult
NameDescriptionTypeAdditional information
ResponseType

No description available

string

None.

Response

No description available

EMS.Common.TransactionResult

None.

Error

No description available

EMS.Common.Error

None.

Response Formats

application/json, text/json

Sample:
{
  "responseType": "TransactionResult",
  "response": {
    "status": "sample string 1",
    "message": "sample string 2",
    "result": "sample string 3"
  },
  "error": {
    "errorCode": "sample string 1",
    "errorDescription": "sample string 2"
  }
}

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.