QR Payments APIs
| Name | Description | Introduced In |
|---|---|---|
| createQRPayment | This API creates the Transfer of QR payments. | 2023.01 |
| activateQRPayment | This API activates QR payment transfer. | 2023.01 |
| updateQRPaymentPreferredAccount | This API updates the preferred accounts for QR payment. | 2023.01 |
| Object Data Model | This Object Data Model describes the parameter name and other attribute details for Trade Finance. |
createQRPayment
| Description: | This API creates the Transfer of QR payments. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/QRPayments/operations/QRPay/CreateQRPayment |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters amount (Mandatory) Specifies the amount for current transaction. fromAccountNumber (Mandatory) Specifies the account number debiting the amount. toAccountNumber (Mandatory) Specifies the recipient account number. notes (optional) Specifies the notes. fromAccountName (Mandatory) Specifies the account name of debiting account. toAccountName (Mandatory) Specifies the account name of recipient account. fromAccountCurrency (Mandatory) Specifies the currency of the from account number. transactionCurrency (Mandatory) Specifies the currency type for current transaction. {
"amount": "1",
"fromAccountNumber": "12562"
"toAccountNumber": "123456",
"notes": "today",
"fromAccountName": "Infinity",
"toAccountName": "Test",
"fromAccountCurrency": "USD",
"transactionCurrency": "USD"
}
|
| Response: |
Parameters fromAccountNumber (Mandatory) Specifies the account number debiting the amount. toAccountNumber (Mandatory) Specifies the recipient account number. amount (Mandatory) Specifies the amount for current transaction. date (Mandatory) Specifies the date of the transaction. notes (Optional) Specifies the notes. referenceId (Mandatory) Specifies the unique reference ID for the transaction. fromAccountName (Mandatory) Specifies the account name of debiting account. toAccountName (Mandatory) Specifies the account name of recipient account. fromAccountCurrency (Mandatory) Specifies the currency of the from account number. transactionCurrency (Mandatory) Specifies the currency type for current transaction. {
"fromAccountNumber": "12562"
"toAccountNumber": "123456",
"amount": "1",
"date": "2023-01-11",
"notes": "today",
"referenceId": "QRT23011ZUSOO",
"fromAccountName": "Infinity",
"toAccountName": "Test",
"fromAccountCurrency": "USD",
"transactionCurrency": "USD",
"httpStatusCode": 0,
"opstatus": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | Service Request Microservice |
| Enterprise API: | {base_url}/api/v2.0.0/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest |
Field Mapping
| UI field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| NA | amount | NA | NA |
| NA | fromAccountNumber | NA | NA |
| NA | toAccountNumber | NA | NA |
| NA | notes | NA | NA |
| NA | fromAccountName | NA | NA |
| NA | toAccountName | NA | NA |
| NA | fromAccountCurrency | NA | NA |
| NA | transactionCurrency | NA | NA |
activateQRPayment
| Description: | This API activates QR payment transfer. |
| Method: | POST |
| URL: | {base_url} /services/data/v1/Holdings/operations/ArrangementPreferences_1/activateQRPayment |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters userName (Mandatory) Specifies the username of the user. {
"userName": "2023012917"
}
|
| Response: |
Parameters result (Mandatory) Specifies the result of record creation. Success or Failure. updatedRecords (Mandatory) Specifies the total number of records updated. {
"result": "Successful",
"opstatus": 0,
"httpStatusCode": 0,
"updatedRecords": 1
}
|
| Error Code(s): |
|
| Enterprise Provider: | Infinity DB |
| Enterprise API: | NA |
Field Mapping
| UI field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| NA | userName | NA | NA |
updateQRPaymentPreferredAccount
| Description: | This API updates the preferred accounts for QR payment. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/Holdings/operations/ArrangementPreferences_1/updateQRPaymentPreferredAccount |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters userName (Mandatory) Specifies the username of the user. default_from_account_qr (Mandatory) Specifies the default account number for QR transactions. {
"userName": "2023012917",
"default_from_account_qr": "133035"
}
|
| Response: |
Parameters updatedRecords (Mandatory) Specifies the total number of records updated. {
"opstatus": 0,
"httpStatusCode": 0,
"updatedRecords": 1
}
|
| Error Code(s): |
|
| Enterprise Provider: | Infinity DB |
| Enterprise API: | NA |
Field Mapping
| UI field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| NA | userName | NA | NA |
| NA | default_from_account_qr | NA | NA |
Object Data Model
Data Model: CreateQRPayment
| Parameter Name | Data Type | Description |
|---|---|---|
| amount | string | It is amount value |
| fromAccountNumber | string | Debit account number |
| toAccountNumber | string | Credit account number |
| notes | string | Notes for QR Payment |
| fromAccountName | string | Debit account name |
| toAccountName | string | Credit account name |
| fromAccountCurrency | string | Debit account currency |
| transactionCurrency | string | It is Transaction currency |
Data Model: activateQRPayment
| Parameter Name | Data Type | Description |
|---|---|---|
| userName | string | It is user id |
Data Model: CreateQRPayment
| Parameter Name | Data Type | Description |
|---|---|---|
| userName | string | It is user id |
| default_from_account_qr | string | Default Account number for QR |
In this topic