POST api/v1/ghanagov/pay-invoice-with-cheque-from-merchant

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BankSortCode	string	None.
ChequeNumber	string	None.
BankName	string	None.
ValueDate	date	None.
PaymentReference	string	None.
collection_agent_branch_code	string	None.
SourceAccountNumber	string	None.
ClientReferenceId	string	None.
invoice_number	string	None.
currency	string	None.
amount	decimal number	None.
RequestId	string	Required Matching regular expression pattern: (^(?=.{4,50}$)([ A-Za-z0-9.\|/-]+$))
CountryId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "BankSortCode": "sample string 1",
  "ChequeNumber": "sample string 2",
  "BankName": "sample string 3",
  "ValueDate": "2025-12-11T07:15:15.6287097+00:00",
  "PaymentReference": "sample string 5",
  "collection_agent_branch_code": "sample string 6",
  "SourceAccountNumber": "sample string 7",
  "ClientReferenceId": "sample string 8",
  "invoice_number": "sample string 9",
  "currency": "sample string 10",
  "amount": 11.0,
  "RequestId": "sample string 12",
  "CountryId": "sample string 13"
}

application/xml, text/xml

Sample:

<GhanaGovPayInvoiceWithChequeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FirstBank.SingleBiller.CoreObject.DataTransferObjects">
  <CountryId>sample string 13</CountryId>
  <RequestId>sample string 12</RequestId>
  <ClientReferenceId>sample string 8</ClientReferenceId>
  <SourceAccountNumber>sample string 7</SourceAccountNumber>
  <amount>11</amount>
  <currency>sample string 10</currency>
  <invoice_number>sample string 9</invoice_number>
  <PaymentReference>sample string 5</PaymentReference>
  <collection_agent_branch_code>sample string 6</collection_agent_branch_code>
  <BankName>sample string 3</BankName>
  <BankSortCode>sample string 1</BankSortCode>
  <ChequeNumber>sample string 2</ChequeNumber>
  <ValueDate>2025-12-11T07:15:15.6287097+00:00</ValueDate>
</GhanaGovPayInvoiceWithChequeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.