{"info":{"_postman_id":"dad82c21-967f-4613-9d18-c30dc70a714f","name":"Third Party API","description":"

DC Bank Call Center APIs v1.0

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10757426","collectionId":"dad82c21-967f-4613-9d18-c30dc70a714f","publishedId":"SzS7P5eP","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-10-07T16:40:12.000Z"},"item":[{"name":"Call Center & IVR","item":[{"name":"Authentication","item":[{"name":"Authentication - Login","id":"c71b9753-abb8-433e-9870-5e2444c76f4e","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"","description":"

(Required)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"UserName\": \"\",\n \"Password\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Authentication/Login?Ocp-Apim-Subscription=","description":"

Description

\n

This is the main screen that will be shown when the user opens the website for the first time and subsequent entries. The access token must be written to each operation to be authorized. This section allows the user’s email and password to convert to bearer access token using the base64 form. If there is no user with the given basic value, then it will fail. Provides protection of email and password.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeMax LengthDescriptionRequired/ Optional
UserNameString-The client/customers username.Required
PasswordString-The client/customers password.Required
\n

Response Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
\n

Related Errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
UserLoginE8Invalid User.
UserLoginE18Wrong User Type.
UserLoginE9User Status Is Not Ok
UserLoginE10User Profile Definition Does Not Exist
UserLoginE11Wrong Password
\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Version SupportedDate ReleasedDeprecation DateEnd of Life Date
v1.0December 2019TBDTBD
\n
","urlObject":{"path":["callcenterintegrationapi","v1.0","Authentication","Login"],"host":["https://ivrprod.dcbankapi.com"],"query":[{"key":"Ocp-Apim-Subscription","value":""}],"variable":[]}},"response":[{"id":"53d65143-ccc2-4d03-8c5a-8f1823da6c51","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"{\n \"UserName\": \"\",\n \"Password\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Authentication/Login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"StackTrace\": \"\",\n \"DCBankApiAccessToken\": \"\",\n \"LastLoginDateTime\": \"\",\n \"ExpireAfterMinutes\": \"\",\n \"IsSucceeded\": \"\",\n \"ErrorList\": [\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n },\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n}"}],"_postman_id":"c71b9753-abb8-433e-9870-5e2444c76f4e"},{"name":"Authentication - Change Password","id":"222c28ac-db79-4347-9057-e747cdd1fd1d","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"","description":"

(Required)

\n"},{"key":"Authorization","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"UserName\": \"\",\n \"OldPassword\": \"\",\n \"NewPassword\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Authentication/ChangePassword?Ocp-Apim-Subscription=","description":"

Description

\n

The user can change the password through ChangePassword if desired.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeMax LengthDescriptionRequired/ Optional
UserNameString-The client/customer username.Required
OldPasswordString-the client/customer old password.Required
NewPasswordString-The client/customer new password.Required
\n

Response Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
\n

Related Errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
ChgPasswordE6User Not Found
ChgPasswordE16Wrong User Type
UserInsertE1Password Policy Violation
UserInsertE2Wrong Password
ChgPasswordE7Your selected password matches your previous passwords! Please try again.
\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Version SupportedDate ReleasedDeprecation DateEnd of Life Date
v1.0December 2019TBDTBD
\n
","urlObject":{"path":["callcenterintegrationapi","v1.0","Authentication","ChangePassword"],"host":["https://ivrprod.dcbankapi.com"],"query":[{"key":"Ocp-Apim-Subscription","value":""}],"variable":[]}},"response":[{"id":"e623becb-0a9b-48b7-8f08-9082bf68a2ae","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"","description":"(Required) "},{"key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"UserName\": \"\",\n \"OldPassword\": \"\",\n \"NewPassword\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Authentication/ChangePassword"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"StackTrace\": \"\",\n \"IsSucceeded\": \"\",\n \"ErrorList\": [\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n },\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n}"}],"_postman_id":"222c28ac-db79-4347-9057-e747cdd1fd1d"},{"name":"Authentication - Logout","id":"86d7c19e-363f-4622-9ee1-ed89962ab91f","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"","description":"

(Required)

\n"},{"key":"Authorization","value":"","description":"

(Required)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"\"\""},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Authentication/Logout?Ocp-Apim-Subscription=","description":"

Description

\n

This section is used to logout. There is no body part.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeMax LengthDescriptionRequired/ Optional
\n

Response Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
\n

Related Errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
LogoutE1Session Not Exists
LogoutE2Session Already Closed
\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Version SupportedDate ReleasedDeprecation DateEnd of Life Date
v1.0December 2019TBDTBD
\n
","urlObject":{"path":["callcenterintegrationapi","v1.0","Authentication","Logout"],"host":["https://ivrprod.dcbankapi.com"],"query":[{"key":"Ocp-Apim-Subscription","value":""}],"variable":[]}},"response":[{"id":"1b364e89-829d-4227-9ab2-9b7354f40048","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"","description":"(Required) "},{"key":"Authorization","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"\"\""},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Authentication/Logout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"StackTrace\": \"\",\n \"IsSucceeded\": \"\",\n \"ErrorList\": [\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n },\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n}"}],"_postman_id":"86d7c19e-363f-4622-9ee1-ed89962ab91f"},{"name":"Authentication - HealthCheck","id":"38b7fcb4-1272-4be9-8f84-eead48204592","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"","description":"

(Required)

\n"},{"key":"Authorization","value":"","description":"

(Required)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Request\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Authentication/HealthCheck","description":"

Description

\n

The purpose of this HealthCheck API is to verify that the APIs are working as expected.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeMax LengthDescriptionRequired/ Optional
\n

Response Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
ResponseStringA response from the API signalling success.
ServerDateTimeDateTimeThe serve date/time the successful test was completed.
\n

Related Errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Version SupportedDate ReleasedDeprecation DateEnd of Life Date
v1.0December 2019TBDTBD
\n
","urlObject":{"path":["callcenterintegrationapi","v1.0","Authentication","HealthCheck"],"host":["https://ivrprod.dcbankapi.com"],"query":[],"variable":[]}},"response":[{"id":"7850c63d-5ca4-4ed0-84d9-879d86b13457","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"","description":"(Required) "},{"key":"Authorization","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"{\n \"Request\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Authentication/HealthCheck"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Response\": \"\",\n \"ServerDateTime\": \"\"\n}"}],"_postman_id":"38b7fcb4-1272-4be9-8f84-eead48204592"},{"name":"Heartbeat","id":"5b59b43c-2ca6-4839-866a-a34928dfb867","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://ivrprod.dcbankapi.com/heartbeat","description":"

This service allows an integrator to test the current status of the DCPayments web service API infrastructure. In addition to basic connectivity testing, this function will perform end-to-end\napplication-layer testing to ensure all systems are available. If you get the \"Hello from the server\" response, it means the API is working successfully.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"dad82c21-967f-4613-9d18-c30dc70a714f","id":"dad82c21-967f-4613-9d18-c30dc70a714f","name":"Third Party API","type":"collection"}},"urlObject":{"path":["heartbeat"],"host":["https://ivrprod.dcbankapi.com"],"query":[],"variable":[]}},"response":[{"id":"0d92fb5c-8b75-445d-841f-81001834526a","name":"response","originalRequest":{"method":"GET","header":[],"url":"https://ivrprod.dcbankapi.com/heartbeat"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5b59b43c-2ca6-4839-866a-a34928dfb867"}],"id":"1de05e35-b659-4899-83dd-b490f03a28ec","_postman_id":"1de05e35-b659-4899-83dd-b490f03a28ec","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"dad82c21-967f-4613-9d18-c30dc70a714f","id":"dad82c21-967f-4613-9d18-c30dc70a714f","name":"Third Party API","type":"collection"}}},{"name":"Call Center","item":[{"name":"Call Center - Get Client Info By User Name","id":"75ddc5cf-fc95-4edf-8d4a-deea28befde3","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"","description":"

(Required)

\n"},{"key":"Authorization","value":"","description":"

(Required)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"UserName\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/CallCenter/GetClientInfoByUserName?Ocp-Apim-Subscription=","description":"

Description

\n

The purpose of this section is to retrieve the client information through using UserName parameter.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeMax LengthDescriptionRequired/ Optional
UserNameString-The client/customer username.Required
\n

Response Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
UniqueClientIdStringThe clients unique identifier.
StoreCodeLongThe store code.
ClientNameStringThe name of the client.
\n

Related Errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
CallCenterAPIGetClientInfoByUserNameE1Request cannot be null.
CallCenterAPIGetClientInfoByUserNameE2User is not defined.
CallCenterAPIGetClientInfoByUserNameE3User does not have a valid Unique Client ID.
CallCenterAPIGetClientInfoByUserNameE4User does not have a valid Client Type.
CallCenterAPIGetClientInfoByUserNameE5User does not have a valid Client.
CallCenterAPIGetClientInfoByUserNameE6User does not have a valid Client.
CallCenterAPIGetClientInfoByUserNameE7User does not have a valid Client Type.
\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Version SupportedDate ReleasedDeprecation DateEnd of Life Date
v1.0December 2019TBDTBD
\n
","urlObject":{"path":["callcenterintegrationapi","v1.0","CallCenter","GetClientInfoByUserName"],"host":["https://ivrprod.dcbankapi.com"],"query":[{"key":"Ocp-Apim-Subscription","value":""}],"variable":[]}},"response":[{"id":"25d4a72a-678d-4df9-a4c3-33837fc37005","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"","description":"(Required) "},{"key":"Authorization","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"{\n \"UserName\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/CallCenter/GetClientInfoByUserName"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"StackTrace\": \"\",\n \"Item\": {\n \"UniqueClientId\": \"\",\n \"StoreCode\": \"\",\n \"ClientName\": \"\"\n },\n \"IsSucceeded\": \"\",\n \"ErrorList\": [\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n },\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n}"}],"_postman_id":"75ddc5cf-fc95-4edf-8d4a-deea28befde3"},{"name":"Call Center - Get Client Customer Info By Email And Card Number","id":"b985e2ad-bdad-408e-bacd-6a65dd17af94","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"","description":"

(Required)

\n"},{"key":"Authorization","value":"","description":"

(Required)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Email\": \"\",\n \"CardNumber\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/CallCenter/GetClientCustomerInfoByEmailAndCardNumber?Ocp-Apim-Subscription=","description":"

Description

\n

The purpose of this section is to retrieve the Cardholder’s information through using Email and the last four digits of the card parameters.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeMax LengthDescriptionRequired/ Optional
EmailString-The email associated with the client customer.Required
CardNumberNumeric-The last 4-digits of the card number.Required
\n

Response Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
DCBankCustomerNoStringThe DC Bank customer number.
ClientCustomerNoStringThe client customer number.
UniqueClientIdLongThe clients unique identifier.
CustomerNameStringThe customers name.
CustomerDOBDateTimeThe customers date of birth.
CustomerPhoneNumberStringThe customers phone number.
\n

Related Errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
CallCenterAPIGetClientCustomerInfoByEmailAndCardNumberE1Request cannot be null.
CallCenterAPIGetClientCustomerInfoByEmailAndCardNumberE2There is no client customer defined to email.
CallCenterAPIGetClientCustomerInfoByEmailAndCardNumberE3Card Number cannot be null.
CallCenterAPIGetClientCustomerInfoByEmailAndCardNumberE4Card Number can exactly have 4 number characters.
CallCenterAPIGetClientCustomerInfoByEmailAndCardNumberE5Cannot find valid card info from last 4 digits.
CallCenterAPIGetClientCustomerInfoByEmailAndCardNumberE6Client Customer does not have a valid Unique Client ID.
CallCenterAPIGetClientCustomerInfoByEmailAndCardNumberE7Client Customer does not have a valid Phone Info.
CallCenterAPIGetClientCustomerInfoByEmailAndCardNumberE8Client Customer does not have a valid Phone Number.
\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Version SupportedDate ReleasedDeprecation DateEnd of Life Date
v1.0December 2019TBDTBD
\n
","urlObject":{"path":["callcenterintegrationapi","v1.0","CallCenter","GetClientCustomerInfoByEmailAndCardNumber"],"host":["https://ivrprod.dcbankapi.com"],"query":[{"key":"Ocp-Apim-Subscription","value":""}],"variable":[]}},"response":[{"id":"061c9110-fb86-413c-a0d6-dde40b90368a","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"","description":"(Required) "},{"key":"Authorization","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"{\n \"Email\": \"\",\n \"CardNumber\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/CallCenter/GetClientCustomerInfoByEmailAndCardNumber"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"StackTrace\": \"\",\n \"Item\": {\n \"DCBankCustomerNo\": \"\",\n \"ClientCustomerNo\": \"\",\n \"UniqueClientId\": \"\",\n \"CustomerName\": \"\",\n \"CustomerDOB\": \"\",\n \"CustomerPhoneNumber\": \"\"\n },\n \"IsSucceeded\": \"\",\n \"ErrorList\": [\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n },\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n}"}],"_postman_id":"b985e2ad-bdad-408e-bacd-6a65dd17af94"}],"id":"a2b94ec1-1b33-4abe-abd9-5c6fc62635f0","_postman_id":"a2b94ec1-1b33-4abe-abd9-5c6fc62635f0","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"dad82c21-967f-4613-9d18-c30dc70a714f","id":"dad82c21-967f-4613-9d18-c30dc70a714f","name":"Third Party API","type":"collection"}}},{"name":"Ivr","item":[{"name":"Ivr - Caller Id Check","id":"71a41ae0-d54a-4936-bf06-11d3184b1a1e","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"","description":"

(Required)

\n"},{"key":"Authorization","value":"","description":"

(Required)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"\",\n \"InboundCallerPhoneNumber\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/CallerIdCheck?Ocp-Apim-Subscription=","description":"

This section determines if the Phone Number (Mobile Phone Number) is identified in the Cardholder database.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeMax LengthDescriptionRequired/ Optional
IvrUniqueClientIdString-Indicates IVR Unique Client ID.Required
InboundCallerPhoneNumberString-Indicates Cardholder Phone Number.Required
\n

Response Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
\n

Related Errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
CallerIdCheckOpE1IVR Unique Client Id is invalid
CallerIdCheckOpE2IVR Unique Client Phone is invalid
CallerIdCheckOpE3IVR Unique Client Phone is invalid
CallerIdCheckOpE4IVR Unique Client Phone does not match with inbound caller phone number
\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Version SupportedDate ReleasedDeprecation DateEnd of Life Date
v1.0December 2019TBDTBD
\n
","urlObject":{"path":["callcenterintegrationapi","v1.0","Ivr","CallerIdCheck"],"host":["https://ivrprod.dcbankapi.com"],"query":[{"key":"Ocp-Apim-Subscription","value":""}],"variable":[]}},"response":[{"id":"f0d7e339-7283-46a4-aa6c-b7d79dad65e8","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"","description":"(Required) "},{"key":"Authorization","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"500002\",\n \"InboundCallerPhoneNumber\": \"3432423432\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/CallerIdCheck"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"0\",\n \"ErrorDescription\": \"Successfull\",\n \"StackTrace\": null,\n \"Item\": {\n \"PhoneNumberCheck\": \"Y\"\n },\n \"IsSucceeded\": true,\n \"ErrorList\": [],\n \"ParameterList\": []\n}"}],"_postman_id":"71a41ae0-d54a-4936-bf06-11d3184b1a1e"},{"name":"Ivr - Activate Card","id":"be64e243-bd25-413a-abaa-577b5b821f5a","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"","description":"

(Required)

\n"},{"key":"Authorization","value":"","description":"

(Required)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"\",\n \"InboundCallerPhoneNumber\": \"\",\n \"LastFourDigits\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/ActivateCard?Ocp-Apim-Subscription=","description":"

Description

\n

The purpose of this section is to command to Active the inactive card.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeMax LengthDescriptionRequired/ Optional
IvrUniqueClientIdString-Indicates IVR Unique Client ID.Required
InboundCallerPhoneNumberString-Indicates Cardholder Phone Number.Required
LastFourDigitsString4Indicates Last Four Digits of the Card.Required
\n

Response Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
\n

Related Errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
ActivateCardOpE1Card is already activated
UpdCardStatusE1Card Not Found
UpdCardStatusE2Card Status Definition Not Found
UpdCardStatusE3The card status is not allow to change!
\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Version SupportedDate ReleasedDeprecation DateEnd of Life Date
v1.0December 2019TBDTBD
\n
","urlObject":{"path":["callcenterintegrationapi","v1.0","Ivr","ActivateCard"],"host":["https://ivrprod.dcbankapi.com"],"query":[{"key":"Ocp-Apim-Subscription","value":""}],"variable":[]}},"response":[{"id":"139cbccc-8fe8-4ed0-9372-58f098680695","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"","description":"(Required) "},{"key":"Authorization","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"500002\",\n \"InboundCallerPhoneNumber\": \"3432423432\",\n \"LastFourDigits\": \"4458\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/ActivateCard"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"ActivateCardOpE1\",\n \"ErrorDescription\": \"Card is already activated\",\n \"StackTrace\": null,\n \"Item\": {\n \"Result\": \"N\"\n },\n \"IsSucceeded\": false,\n \"ErrorList\": [],\n \"ParameterList\": []\n}"}],"_postman_id":"be64e243-bd25-413a-abaa-577b5b821f5a"},{"name":"Ivr - Fetch Balance Info","id":"ed10f7cf-fa06-46b9-aa67-6f59262b4b09","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"","description":"

(Required)

\n"},{"key":"Authorization","value":"","description":"

(Required)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"\",\n \"InboundCallerPhoneNumber\": \"\",\n \"LastFourDigits\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/FetchBalanceInfo?Ocp-Apim-Subscription=","description":"

Description

\n

The purpose of this section is to fetch balance information.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeMax LengthDescriptionRequired/ Optional
IvrUniqueClientIdString-Indicates IVR Unique Client ID.Required
InboundCallerPhoneNumberString-Indicates Cardholder Phone Number.Required
LastFourDigitsString4Indicates Last Four Digits of the Card.Required
\n

Response Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
CurrentBalanceOfMainWalletDecimalThe current balance of the wallet.
AmountLastLoadDecimalThe amount of the most recent load to the card.
DateOfLastLoadDateTimeThe date of the most recent load to the card.
\n

Related Errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
FetchBalanceInfoOpE1Wallet account is not exists
\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Version SupportedDate ReleasedDeprecation DateEnd of Life Date
v1.0December 2019TBDTBD
\n
","urlObject":{"path":["callcenterintegrationapi","v1.0","Ivr","FetchBalanceInfo"],"host":["https://ivrprod.dcbankapi.com"],"query":[{"key":"Ocp-Apim-Subscription","value":""}],"variable":[]}},"response":[{"id":"149cc800-6e16-4f2c-a2cc-dc6228689132","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"","description":"(Required) "},{"key":"Authorization","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"500002\",\n \"InboundCallerPhoneNumber\": \"3432423432\",\n \"LastFourDigits\": \"4458\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/FetchBalanceInfo"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"0\",\n \"ErrorDescription\": \"Successfull\",\n \"StackTrace\": null,\n \"Item\": {\n \"CurrentBalanceOfMainWallet\": 0,\n \"AmountLastLoad\": 0.07,\n \"DateOfLastLoad\": \"2020-02-04T18:32:11.0000000+00:00\"\n },\n \"IsSucceeded\": true,\n \"ErrorList\": [],\n \"ParameterList\": []\n}"}],"_postman_id":"ed10f7cf-fa06-46b9-aa67-6f59262b4b09"},{"name":"Ivr - Fetch Transaction Details","id":"c686a09b-26b4-48ab-ba79-1b9af0e00ac4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"","description":"

(Required)

\n"},{"key":"Authorization","value":"","description":"

(Required)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"\",\n \"InboundCallerPhoneNumber\": \"\",\n \"LastFourDigits\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/FetchTransactionDetails?Ocp-Apim-Subscription=","description":"

The purpose of this section is to fetch last five transaction details.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeMax LengthDescriptionRequired/ Optional
IvrUniqueClientIdString-Indicates IVR Unique Client ID.Required
InboundCallerPhoneNumberString-Indicates Cardholder Phone Number.Required
LastFourDigitsString4Indicates Last Four Digits of the Card.Required
\n

Response Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
TransactionAmountDecimalThe amount of the transaction.
DateOfTransactionDateTimeThe date the transaction occurred.
TransactionLocationStringThe location where the transaction occurred.
\n

Related Errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
FetchTransactionDetailsOpE1Wallet account does not exist.
\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Version SupportedDate ReleasedDeprecation DateEnd of Life Date
v1.0December 2019TBDTBD
\n
","urlObject":{"path":["callcenterintegrationapi","v1.0","Ivr","FetchTransactionDetails"],"host":["https://ivrprod.dcbankapi.com"],"query":[{"key":"Ocp-Apim-Subscription","value":""}],"variable":[]}},"response":[{"id":"6ac839b7-98a0-46e4-aec9-4bcab3970fd2","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"","description":"(Required) "},{"key":"Authorization","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"500002\",\n \"InboundCallerPhoneNumber\": \"3432423432\",\n \"LastFourDigits\": \"4458\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/FetchTransactionDetails"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"0\",\n \"ErrorDescription\": \"Successfull\",\n \"StackTrace\": null,\n \"Item\": [\n {\n \"TransactionAmount\": 0.07,\n \"DateOfTransaction\": \"2020-02-04T18:32:11.0000000+00:00\",\n \"TransactionLocation\": \"SYSTEM\"\n },\n {\n \"TransactionAmount\": 0.52,\n \"DateOfTransaction\": \"2020-02-04T18:32:10.0000000+00:00\",\n \"TransactionLocation\": \"SYSTEM\"\n },\n {\n \"TransactionAmount\": 0.02,\n \"DateOfTransaction\": \"2020-02-04T18:32:08.0000000+00:00\",\n \"TransactionLocation\": \"SYSTEM\"\n },\n {\n \"TransactionAmount\": 0.68,\n \"DateOfTransaction\": \"2020-02-04T18:32:07.0000000+00:00\",\n \"TransactionLocation\": \"SYSTEM\"\n },\n {\n \"TransactionAmount\": 0.27,\n \"DateOfTransaction\": \"2020-02-04T18:32:06.0000000+00:00\",\n \"TransactionLocation\": \"SYSTEM\"\n }\n ],\n \"IsSucceeded\": true,\n \"ErrorList\": [],\n \"ParameterList\": []\n}"}],"_postman_id":"c686a09b-26b4-48ab-ba79-1b9af0e00ac4"},{"name":"Ivr - Issue Temporary Control Number","id":"711a06dc-bab1-4bbf-bdcc-a280a6434caa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"","description":"

(Required)

\n"},{"key":"Authorization","value":"","description":"

(Required)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"\",\n \"InboundCallerPhoneNumber\": \"\",\n \"LastFourDigits\": \"\",\n \"WithSMS\": \"\",\n \"WithEmail\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/IssueTemporaryControlNumber?Ocp-Apim-Subscription=","description":"

Description

\n

The purpose of this section is the issuance of Temporary Control Number to be sent both via SMS to the mobile number registered on the Cardholder’s account/wallet and to Email Address registered on the Cardholder’s account/wallet depending on the Cardholder's request. Temporary Control Number (TCN) will be retrieved in response item and this TCN must be used in SETPIN operation method in 10 minutes. Otherwise, it will be expired and then the user must get the new TCN.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeMax LengthDescriptionRequired/ Optional
IvrUniqueClientIdString-Indicates IVR unique client ID.Required
InboundCallerPhoneNumberString-Indicates the phone number of the inbound caller.Required
LastFourDigitsString4Indicates the last 4 digits of the card number.Required
WithSMSBoolean-A True or False value indicating whether or not SMS is used for sending TCN.Required
WithEmailBoolean-A True or False value indicating whether or not Email is used for sending TCN.Required
\n

Response Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
TCNStringThe Temporary Control Number (TCN), received via SMS or email.
\n

Related Errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
IssueTemporaryControlNumberOpE1SMS or Email needs to be selected
\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Version SupportedDate ReleasedDeprecation DateEnd of Life Date
v1.0December 2019TBDTBD
\n
","urlObject":{"path":["callcenterintegrationapi","v1.0","Ivr","IssueTemporaryControlNumber"],"host":["https://ivrprod.dcbankapi.com"],"query":[{"key":"Ocp-Apim-Subscription","value":""}],"variable":[]}},"response":[{"id":"8d638e66-09b2-4d7d-8f7c-5bbf44a2ef76","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"","description":"(Required) "},{"key":"Authorization","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"\",\n \"InboundCallerPhoneNumber\": \"\",\n \"LastFourDigits\": \"\",\n \"WithSMS\": \"\",\n \"WithEmail\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/IssueTemporaryControlNumber"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"StackTrace\": \"\",\n \"Item\": {\n \"TCN\": \"\"\n },\n \"IsSucceeded\": \"\",\n \"ErrorList\": [\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n },\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n}"}],"_postman_id":"711a06dc-bab1-4bbf-bdcc-a280a6434caa"},{"name":"Ivr - Generate Rsa Key","id":"a77361bd-6bf7-4bfb-9c55-21940ebc2cd9","request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"","description":"

(Required)

\n"},{"key":"Authorization","value":"","description":"

(Required)

\n"}],"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/GenerateRsaKey?Ocp-Apim-Subscription=","description":"

Description

\n

This API generates a new RSA key for the user.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeMax LengthDescriptionRequired/ Optional
\n

Response Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
RsaKeyIdLongThe new RSA Key ID.
\n

Related Errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Version SupportedDate ReleasedDeprecation DateEnd of Life Date
v1.0December 2019TBDTBD
\n
","urlObject":{"path":["callcenterintegrationapi","v1.0","Ivr","GenerateRsaKey"],"host":["https://ivrprod.dcbankapi.com"],"query":[{"key":"Ocp-Apim-Subscription","value":""}],"variable":[]}},"response":[{"id":"b16cfde8-2b23-4d36-a14d-725efe9e81db","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"","description":"(Required) "},{"key":"Authorization","value":"","description":"(Required) "}],"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/GenerateRsaKey"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"StackTrace\": \"\",\n \"Item\": {\n \"RsaKeyId\": \"\",\n \"PublicKeyInPemFormat\": \"\",\n \"ModulusBase64\": \"\",\n \"ExponentBase64\": \"\"\n },\n \"IsSucceeded\": \"\",\n \"ErrorList\": [\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n },\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n}"}],"_postman_id":"a77361bd-6bf7-4bfb-9c55-21940ebc2cd9"},{"name":"Ivr - Get Rsa Public Key","id":"0cbfd952-406d-48a1-b6b7-14d079d8e11c","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"","description":"

(Required)

\n"},{"key":"Authorization","value":"","description":"

(Required)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"RsaKeyId\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/GetRsaPublicKey?Ocp-Apim-Subscription=","description":"

Description

\n

The Get RSA Public Key API allows a client to retrieve a specific RSA public key from the server. This key is typically used to encrypt sensitive data on the client side before it is transmitted over the network.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeMax LengthDescriptionRequired/ Optional
RsaKeyIdLong-The RSA key for the client customer.Required
\n

Response Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
\n

Related Errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
GetRsaPublicKeyOpE1Public Key Not Found
\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Version SupportedDate ReleasedDeprecation DateEnd of Life Date
v1.0December 2019TBDTBD
\n
","urlObject":{"path":["callcenterintegrationapi","v1.0","Ivr","GetRsaPublicKey"],"host":["https://ivrprod.dcbankapi.com"],"query":[{"key":"Ocp-Apim-Subscription","value":""}],"variable":[]}},"response":[{"id":"ab72c018-2b5b-429c-878d-d9b5eb5db85b","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"","description":"(Required) "},{"key":"Authorization","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"{\n \"RsaKeyId\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/GetRsaPublicKey"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"StackTrace\": \"\",\n \"Item\": {\n \"RsaKeyId\": \"\",\n \"PublicKeyInPemFormat\": \"\",\n \"ModulusBase64\": \"\",\n \"ExponentBase64\": \"\"\n },\n \"IsSucceeded\": \"\",\n \"ErrorList\": [\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n },\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n}"}],"_postman_id":"0cbfd952-406d-48a1-b6b7-14d079d8e11c"},{"name":"Ivr - Set PIN ","id":"098f62f1-c1a5-4e88-a66e-2f3f1efbc567","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"","description":"

(Required)

\n"},{"key":"Authorization","value":"","description":"

(Required)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"\",\n \"InboundCallerPhoneNumber\": \"\",\n \"LastFourDigits\": \"\",\n \"TCN\": \"\",\n \"YOB\": \"\",\n \"EncryptedNewFourDigitPIN\": \"\",\n \"RsaKeyId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/SetPIN?Ocp-Apim-Subscription=","description":"

Description

\n

The purpose of this section is to set a new PIN.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeMax LengthDescriptionRequired/ Optional
IvrUniqueClientIdString-The unique client IVR ID.Required
InboundCallerPhoneNumberString-The inbound callers phone number.Required
LastFourDigitsString4The last 4-digits of the card number.Required
TCNString-The temporary control number.Required
YOBString4
(ex: 2025)		The client customers year of birth.Required
EncryptedNewFourDigitPinString4The new 4-digit pin number.Required
RsaKeyIdLong-The RSA key ID.Required
\n

Response Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
\n

Related Errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
SetPINOpE1Temporary Client Number is not valid for client
SetPINOpE2Year of Birth is not valid for client
SetPINOpE3Card Not Found
SetPINOpE4Card DeTokenization Error
SetPINOpE5Hsm PIN Error
\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Version SupportedDate ReleasedDeprecation DateEnd of Life Date
v1.0December 2019TBDTBD
\n
","urlObject":{"path":["callcenterintegrationapi","v1.0","Ivr","SetPIN"],"host":["https://ivrprod.dcbankapi.com"],"query":[{"key":"Ocp-Apim-Subscription","value":""}],"variable":[]}},"response":[{"id":"43115b8e-9c39-4a51-8f5b-2dfb87124fb3","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"","description":"(Required) "},{"key":"Authorization","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"\",\n \"InboundCallerPhoneNumber\": \"\",\n \"LastFourDigits\": \"\",\n \"TCN\": \"\",\n \"YOB\": \"\",\n \"EncryptedNewFourDigitPIN\": \"\",\n \"RsaKeyId\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/SetPIN"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"StackTrace\": \"\",\n \"Item\": {\n \"Result\": \"\"\n },\n \"IsSucceeded\": \"\",\n \"ErrorList\": [\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n },\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n}"}],"_postman_id":"098f62f1-c1a5-4e88-a66e-2f3f1efbc567"},{"name":"Ivr - Temporarily Close Card","id":"6c9a69ad-78af-4d7f-96f3-7ba4593f73cf","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"","description":"

(Required)

\n"},{"key":"Authorization","value":"","description":"

(Required)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"\",\n \"InboundCallerPhoneNumber\": \"\",\n \"LastFourDigits\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/TemporarilyCloseCard?Ocp-Apim-Subscription=","description":"

Description

\n

The purpose of this section is to temporarily close the card.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeMax LengthDescriptionRequired/ Optional
IvrUniqueClientIdString-The unique client IVR ID.Required
InboundCallerPhoneNumberString-The inbound callers phone number.Required
LastFourDigitsString4The last 4 digits of the card number.Required
\n

Response Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
\n

Related Errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
TemporarilyClosedCardOpE1Card is already temporarily closed
UpdCardStatusE1Card Not Found
UpdCardStatusE2Card Status Definition Not Found
UpdCardStatusE3The card status is not allow to change!
\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Version SupportedDate ReleasedDeprecation DateEnd of Life Date
v1.0December 2019TBDTBD
\n
","urlObject":{"path":["callcenterintegrationapi","v1.0","Ivr","TemporarilyCloseCard"],"host":["https://ivrprod.dcbankapi.com"],"query":[{"key":"Ocp-Apim-Subscription","value":""}],"variable":[]}},"response":[{"id":"46b3215c-8b74-4df1-bb42-214d7f12f93a","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"","description":"(Required) "},{"key":"Authorization","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"\",\n \"InboundCallerPhoneNumber\": \"\",\n \"LastFourDigits\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/TemporarilyCloseCard"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"StackTrace\": \"\",\n \"Item\": {\n \"Result\": \"\"\n },\n \"IsSucceeded\": \"\",\n \"ErrorList\": [\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n },\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n}"}],"_postman_id":"6c9a69ad-78af-4d7f-96f3-7ba4593f73cf"},{"name":"Ivr - ReOpen Temporarily Closed Card","id":"931645b9-db7c-45ae-99c7-7d02ee4b0993","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"","description":"

(Required)

\n"},{"key":"Authorization","value":"","description":"

(Required)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"\",\n \"InboundCallerPhoneNumber\": \"\",\n \"LastFourDigits\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/ReOpenTemporarilyClosedCard?Ocp-Apim-Subscription=","description":"

Description

\n

The purpose of this section is to reopen temporarily closed card.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeMax LengthDescriptionRequired/ Optional
IvrUniqueClientIdString-The unique client IVR ID.Required
InboundCallerPhoneNumberString-The phone number of the inbound caller.Required
LastFourDigitsString4The last 4 digits of the card number.Required
\n

Response Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
\n

Related Errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
ReOpenTemporaryCloseCardOpE1Card is not temporarily closed
UpdCardStatusE1Card Not Found
UpdCardStatusE2Card Status Definition Not Found
UpdCardStatusE3The card status is not allow to change!
\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Version SupportedDate ReleasedDeprecation DateEnd of Life Date
v1.0December 2019TBDTBD
\n
","urlObject":{"path":["callcenterintegrationapi","v1.0","Ivr","ReOpenTemporarilyClosedCard"],"host":["https://ivrprod.dcbankapi.com"],"query":[{"key":"Ocp-Apim-Subscription","value":""}],"variable":[]}},"response":[{"id":"71bc7df6-89f8-4b38-86a2-9be5f782f65b","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"","description":"(Required) "},{"key":"Authorization","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"\",\n \"InboundCallerPhoneNumber\": \"\",\n \"LastFourDigits\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/ReOpenTemporarilyClosedCard"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"StackTrace\": \"\",\n \"Item\": {\n \"Result\": \"\"\n },\n \"IsSucceeded\": \"\",\n \"ErrorList\": [\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n },\n {\n \"ErrorCode\": \"\",\n \"ErrorDescription\": \"\",\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"ParameterList\": [\n \"\",\n \"\"\n ]\n}"}],"_postman_id":"931645b9-db7c-45ae-99c7-7d02ee4b0993"},{"name":"Ivr - Valid CardHolder Check","id":"726afa7b-0544-492c-ade2-0b16583be00c","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"","description":"

(Required)

\n"},{"key":"Authorization","value":"","description":"

(Required)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"\",\n \"InboundCallerPhoneNumber\": \"\",\n \"LastFourDigits\": \"\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/ValidCardHolderCheck?Ocp-Apim-Subscription=","description":"

Description

\n

The purpose of this section is to determine if the Cardholder is present in the database.

\n

Request Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeMax LengthDescriptionRequired/ Optional
IvrUniqueClientIdString-Indicates IVR Unique Client ID.Required
InboundCallerPhoneNumberString-Indicates Cardholder Phone Number.Required
LastFourDigitsString4Indicates Last Four Digits of the Card.Required
\n

Response Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
\n

Related Errors

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Error CodeDescription
ValidCardholderCheckOpE1IVR Unique Client Id is invalid
ValidCardholderCheckOpE2IVR Unique Client Phone is invalid
ValidCardholderCheckOpE3IVR Unique Client Phone is invalid
ValidCardholderCheckOpE4IVR Unique Client Phone does not match with inbound caller phone number
ValidCardholderCheckOpE5Last four digits needs to have exactly four number characters
ValidCardholderCheckOpE6IVR Unique Client Card is not matches with last four digits
\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Version SupportedDate ReleasedDeprecation DateEnd of Life Date
v1.0December 2019TBDTBD
\n
","urlObject":{"path":["callcenterintegrationapi","v1.0","Ivr","ValidCardHolderCheck"],"host":["https://ivrprod.dcbankapi.com"],"query":[{"key":"Ocp-Apim-Subscription","value":""}],"variable":[]}},"response":[{"id":"4cf174e1-0f41-4d28-b0ea-00c1f86e33f8","name":"response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"","description":"(Required) "},{"key":"Authorization","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"{\n \"IvrUniqueClientId\": \"500002\",\n \"InboundCallerPhoneNumber\": \"3432423432\",\n \"LastFourDigits\": \"4458\"\n}"},"url":"https://ivrprod.dcbankapi.com/callcenterintegrationapi/v1.0/Ivr/ValidCardHolderCheck"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": \"0\",\n \"ErrorDescription\": \"Successfull\",\n \"StackTrace\": null,\n \"Item\": {\n \"PhoneNumberCheck\": \"Y\",\n \"IsCardPresentedActive\": \"N\"\n },\n \"IsSucceeded\": true,\n \"ErrorList\": [],\n \"ParameterList\": []\n}"}],"_postman_id":"726afa7b-0544-492c-ade2-0b16583be00c"}],"id":"07cd16f9-44e7-4d43-95d9-733563617bd3","_postman_id":"07cd16f9-44e7-4d43-95d9-733563617bd3","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"dad82c21-967f-4613-9d18-c30dc70a714f","id":"dad82c21-967f-4613-9d18-c30dc70a714f","name":"Third Party API","type":"collection"}}}],"id":"e6817f74-e466-477a-9ded-3036bf3d295f","_postman_id":"e6817f74-e466-477a-9ded-3036bf3d295f","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"dad82c21-967f-4613-9d18-c30dc70a714f","id":"dad82c21-967f-4613-9d18-c30dc70a714f","name":"Third Party API","type":"collection"}}},{"name":"Cyrptocurrency","item":[],"id":"c0eeff40-db22-4b70-98ef-3fa837421131","_postman_id":"c0eeff40-db22-4b70-98ef-3fa837421131","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"dad82c21-967f-4613-9d18-c30dc70a714f","id":"dad82c21-967f-4613-9d18-c30dc70a714f","name":"Third Party API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"ca85c542-de5f-43a2-84be-df55727ae468","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d70d3598-6584-4de4-9ae0-207d29a3d509","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://ivrprod.dcbankapi.com"}]}