APIC Gateway Server
Paths
/v1/payments/initiate
Initiate Payment Request
Third party Provide ( TPP ) Application Id
Unique ID for TPP
Subscription Id of TPP
Encrypted access token
Correlation ID passed by the requesting system
Global transaction Id
2-character iso code for preferred language. If empty the default will be English
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
Created
Accepted
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/payments
Create Payment
Third party Provide ( TPP ) Application Id
Unique ID for TPP
Subscription Id of TPP
Encrypted access token
Correlation ID passed by the requesting system
Global transaction Id
2-character iso code for preferred language. If empty the default will be English
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
Created
Accepted
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/payments/{paymentId}/execute
Third party Provide ( TPP ) Application Id
Unique ID for TPP
Encrypted access token
Correlation ID passed by the requesting system
Global transaction Id
2-character iso code for preferred language. If empty the default will be English
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
Payment Id
Subscription Id of TPP
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
OK
Accepted
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/payments/accounts/{accountId}
Get Account Payments
Account Id for which payments need to be retrieved
Third party Provide ( TPP ) Application Id
Unique ID for TPP
End date
Maximum Number of records to be retrieved
Start date
Encrypted access token
Correlation ID passed by the requesting system
Global transaction Id
2-character iso code for preferred language. If empty the default will be English
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
Subscription Id of TPP
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
OK
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/payments/{paymentId}/funds-confirmation
Check availability of funds in a Account
Third party Provide ( TPP ) Application Id
Unique ID for TPP
Encrypted access token
Correlation ID passed by the requesting system
Global transaction Id
2-character iso code for preferred language. If empty the default will be English
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
Subscription Id of TPP
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
Payment Id for which details need to be retrieved
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
OK
Accepted
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/payments/fundAvailability
Check availability of funds in a Account
Third party Provide ( TPP ) Application Id
Unique ID for TPP
Encrypted access token
Correlation ID passed by the requesting system
Global transaction Id
2-character iso code for preferred language. If empty the default will be English
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
Subscription Id of TPP
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
OK
Accepted
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/payments/{paymentId}
Retrieve the details of payment by payment ID
Third party Provide ( TPP ) Application Id
Unique ID for TPP
Encrypted access token
Correlation ID passed by the requesting system
Global transaction Id
2-character iso code for preferred language. If empty the default will be English
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
Payment Id for which details need to be retrieved
subscriptionId of TPP
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
OK
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
Cancel a payment which is authorized
Third party Provide ( TPP ) Application Id
Unique ID for TPP
Encrypted access token
Correlation ID passed by the requesting system
Global transaction Id
2-character iso code for preferred language. If empty the default will be English
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
Payment Id
Subscription Id of TPP
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
OK
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/payments/{paymentId}/authorize
/v1/payments/{paymentId}/status
Get the Status of a Payment by payment ID
Third party Provide ( TPP ) Application Id
Unique ID for TPP
Encrypted access token
Correlation ID passed by the requesting system
Global transaction Id
2-character iso code for preferred language. If empty the default will be English
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
Payment Id to retrieve payment status
subscriptionId of TPP
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
Found
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/payments/utilityBillCompanies
Retrieve Utility Bill Companies
Third party Provide ( TPP ) Application Id
Unique ID for TPP
Encrypted access token
Correlation ID passed by the requesting system
Global transaction Id
2-character iso code for preferred language. If empty the default will be English
ID of the source system invoking
ID of the channel from which the invocation occurred
ID of the department from which the invocation occurred
User ID of the requester (as per LDAP)
Employee ID of the requester (as per employee HR record)
Terminal ID of the requester
subscriptionId of TPP
The time stamp when the request was sent to system
Third party Provide ( TPP ) ID
The PSU's IP address if the PSU is currently logged in with the TPP
The PSU’s Session Identifier with the TPP
The PSU’s Web Browser Agent or Device Type (Whatever is available from Platform, OS Version, Model) if this is a Mobile App
The time of PSU’s last login with the TPP related to the Session Id provided above
Bad Request
Unauthorized
Forbidden
API URL Not Found
Method not Found
Not Acceptable
Too many Requests
Internal Server Error
Service Unavailable
/v1/payment/healthCheck
200 OK
/v1/payments/standingOrder/initiate
Create Standing Order
Created
Accepted
Bad Request
Unauthorized
Forbidden