Regionalized Solutions
R24 AMR | Min(s) read
APIs
Please find below the API details for the NPP Cuscal Instant Payments Interface, Address Resolution and PayTo module.
The API will only be useable if the module has been licensed by the client.
In the URL, vx.x.x denotes the swagger version that client has licensed.
| Endpoint | Method | URL | Description |
|---|---|---|---|
| getProxydetails | GET | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/holdings/au/accounts/proxyIdentifiers | Retrieve all the proxy identifiers or the fetch a particularproxy identifier by providing proxy value and proxy identifier. |
| createAccountProxyIdentifier | POST | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/holdings/au/accounts/proxyIdentifiers | Create a proxy identifier to be linked to an account based on the proxy types like mobile number. |
| updateProxyIdentifierAliasName | PUT | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/holdings/au/accounts/proxyIdentifiers/{proxyIdentifierId}/aliasNames | Update the proxy identifier details like status and alias name for the given proxy identifier. |
| updateProxyIdentifierStatus | PUT | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/holdings/au/accounts/proxyIdentifiers/{proxyIdentifierId}/status | Update the status of the proxy identifier linked to an account. |
| getProxyDeregisterHistory | GET | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/holdings/au/accounts/proxyIdentifiers/cuscalNppPayments/history | Retrieve the list of all payid deregistration transactions which occurred in the past 90 days on any proxy Identifier. |
| getAliasDetails | GET | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/holdings/au/accounts/proxyIdentifiers/{proxyIdentifierId}/cuscalNppPayments | Retrieves the account details and status such as Active. |
| getAliasAccountDetails | GET | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x//holdings/au/accounts/{accountId}/proxyIdentifiers/cuscalNppPayments | Retrieves all pay identifiers attached to an account owned by the account servicer from Cuscal. |
| getPayeeAccountDetails | POST | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/holdings/au/accounts/payees | Retrieves the payee identifiers attached to an account owned by the account servicer. |
| getAccountDetails | GET | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/holdings/au/accounts/{accountId}/accountDetails/cuscalNppPayments | Retrieves the customer account details like scheme. |
| createCustomerPayee | POST | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/party/au/customers/payees | Create payee details for a customer based on the account number or proxy identifier in order to initiate payment transaction. |
| updateCustomerContactDetails | PUT | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/party/au/customers/{customerId}/contacts | Update the contact details of the customer for whom the proxy identifier status is not Active. |
| getCustomerId | GET | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/party/au/customers | Retrieve 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. |
| getBeneficiaries | GET | http://<hostname>:<jboss_port>/aumb-provider-iris/api/vx.x.x/party/au/beneficiaries | Retreive the list of beneficiary details like proxy identifier. |
In this topic