NPP Cuscal Instant Payments Interface, Address Resolution and PayTo API's
Please find below the API details for the NPP Cuscal Instant Payments Interface, Address Resolution and PayTo module.
|
API Name |
Method |
URL |
Description |
|---|---|---|---|
|
Create Account Proxy Identifier |
POST |
http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/holdings/au/accounts/proxyIdentifiers |
Creates a proxy identifier to be linked to an account based on the proxy types like mobile number, email Id. |
|
Update Proxy Identifier Status |
PUT |
http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/holdings/au/accounts/proxyIdentifiers/{proxyIdentifierId}/status |
Updates the status of the proxy identifier linked to an account. |
|
Create Customer Payee |
POST |
http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/party/au/customers/payees |
Creates payee details for a customer based on the account number or proxy identifier in order to initiate the payment transaction. |
|
Update Proxy Identifier Alias Name |
PUT |
http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/holdings/au/accounts/proxyIdentifiers/{proxyIdentifierId}/aliasNames |
Updates the alias name of the proxy identifier linked to an account. |
|
Update Customer Contact Details |
PUT |
http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/party/au/customers/{customerId}/contacts |
Updates the contact details of the customer for whom the proxy identifier status is not Active. |
|
Get Proxy Identifier |
GET |
http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/holdings/au/accounts/proxyIdentifiers |
Retrieves the list of proxy identifiers details like proxy identifier, proxy type, proxy status etc. for all or given customer Id. |
|
Get Beneficiaries |
GET |
http://<hostname>:<jboss_port>/<iris_war>/api/v1.0.0/party/au/beneficiaries |
Retrieves the list of beneficiary details like proxy identifier, proxy type, account details etc. for all or given customer Id. |
|
AUNPPC.API.AU.CUSTOMERID.RETRIEVE.1.0.0 |
GET |
http://localhost:9089/aumb-provider-iris/api/v1.0.0/party/au/customers |
Retrieves the customer Id by using the proxy identifier or account identifier, in order to communicate to the channel to push the PayTo notifications to the customer. |
In this topic