/IrisPayments/InitiatePayment

Purpose of InitiatePayment

This endpoint is used by the merchant/issuer to:

Create a short-lived IRIS payment request (1–3 minutes).

Generate a QR code to be displayed on a monitor.

Allow the final customer to scan and pay via mobile banking.

Endpoint: {domain}/paymentsapi/IrisPayments/InitiatePayment

Request Body Fields (InitiatePayment)

Field	Type	Required	Description
issuerTin	string	Yes	Tax Identification Number (TIN) of the merchant/issuer initiating the IRIS payment.
payeeInfo	object (PayeeInfo)	No	Information about the Payer (the customer who will pay via IRIS).
displayName	string	No	Display name of the Payer.
companyName	string	No	Legal company name of the Payer.
tin	string	No	TIN of the Payer.
amount	number	No	Amount of the IRIS payment (excluding tips).
validityPeriod	integer	No	Validity of the payment request in minutes (allowed values: 1–3).
orderDescription	string	No	Description of the order/purchase.
remittanceInformation	string	Yes	Reference for reconciliation (e.g. invoice number or order ID).
destination	string	No	Merchant's IRIS receiving account/identifier.
generateQrCodeImage	boolean	No	If true, generates and returns a QR code image.
qrCodeSize	integer	No	Size of the QR image in pixels.
issueDate	string (date-time)	No	Timestamp of the invoice/document.
branchCode	integer	No	Merchant's branch.
invoiceTypeCode	string	Yes	Invoice/document type code.
series	string	Yes	Document series.
identifier	string	Yes	Invoice/document number.
mark	integer	No	MARK from tax authority.
totalNetAmount	number	No	Total net amount.
totalVatAmount	number	No	Total VAT amount.
totalAmount	number	No	Total invoice total.
merchantId	string	Yes	IRIS merchant ID.

Request

Body Params application/json

Example

{
    "issuerTin": "string",
    "payeeInfo": {
        "displayName": "string",
        "companyName": "string",
        "tin": "string"
    },
    "paymentAmount": 0,
    "validityPeriod": 0,
    "orderDescription": "string",
    "remittanceInformation": "string",
    "destination": "string",
    "generateQrCodeImage": true,
    "qrCodeSize": 0,
    "issueDate": "2019-08-24T14:15:22Z",
    "branchCode": 0,
    "invoiceTypeCode": "string",
    "series": "string",
    "identifier": "string",
    "mark": 0,
    "totalNetAmount": 0,
    "totalVatAmount": 0,
    "totalAmount": 0,
    "merchantId": "string",
    "tipAmount": 0
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Created

Body

Example

{
    "endToEndDiasId": "string",
    "authorisationRequestId": "string",
    "qrCode": "string",
    "qrCodeImage": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "expiresAt": "2019-08-24T14:15:22Z",
    "signedDataInput": "string",
    "signature": "string"
}

🟠400Bad Request

🟠401Unauthorized