production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/cards/debit-cards/cardless-transactions/retrieve
post /v1/cards/debit-cards/cardless-transactions/retrieve
retrieve-debit-card-cardless-transaction
LOB: Credit&Risk; Feature: Debit card cardless transactions; Functionality: Retrieve
This API retrieve the information of debit cardless transactions
OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/oauth/token
Scopes
/api/v1
Client ID
X-IBM-Client-Id
(apiKey located in header)
client_id
Required in header
string
Client ID generated during application registration
Authorization
Required in header
string
The Authorization Token received during login
Accept
Required in header
string
Content-Types that are acceptable for the response
uuid
Required in header
string
128 bit UUID that you generate for every request
Accept-Language
Optional in header
string
List of acceptable human languages for response
Content-Type
Required in header
string
Content-Types that are sent in the request
countryCode
Required in header
string
Country code in 2 character ISO 3166 format
businessCode
Required in header
string
Business code identified during application registration
ChannelId
Required in header
string
Channel where request originated
debitCardlessTransactionRequest
Optional in body
object
200
Successful operation.
400
Type | Code | Details |
error | invalidRequest | Missing or invalid Parameters |
401
Type | Code | Details |
error | unAuthorized | Authorization credentials are missing or invalid |
403
Type | Code | Details | More Info |
error | accessNotConfigured | The request operation is not configured to access this resource | Channel/Country/Business provided in the request is not supported currently |
404
Type | Code | Details | More Info |
error | resourceNotFound | The requested resource was not found | Empty resource/resource not found |
422
Type | Code | Details |
error | businessValidationFailed | Business validation error occured on one or more parameters |
500
Type | Code | Details |
fatal | serverUnavailable | The request failed due to an internal error/server unavailability |
Example Request
Example Response
POST https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext/api/v1/cards/debit-cards/cardless-transactions/retrieve
Definitions
{
"type": "object",
"properties": {
"cardNumber": {
"maxLength": 19,
"type": "string",
"example": "0005188999002786594",
"description": "Number Embossed/Printed on the Card. For Debit Card: A card issued by a bank allowing the holder to transfer money electronically from one account to another account or another bank account, for cash withdrawal, for making a purchase etc."
},
"transactionId": {
"maxLength": 14,
"type": "string",
"example": "9121921",
"description": "Unique Identifier of the transaction"
}
},
"required": [
"cardNumber",
"transactionId"
]
}
{
"properties": {
"sessionId": {
"maxLength": 40,
"type": "string",
"example": "5b5316c1-s384-4965-i74d-18a08s39t001",
"description": "Unique Id for user Session. Users are assigned a unique session Id for each login attempt that Identifies the user's login/login attempt to the application"
},
"currentLoginDate": {
"maxLength": 32,
"type": "string",
"format": "date-time",
"example": "2022-10-22T17:40:58Z",
"description": "This field contains the date and hour when the customer make current login"
},
"cardNumber": {
"maxLength": 19,
"type": "string",
"example": "0005188999002786594",
"description": "Number Embossed/Printed on the Card. For Debit Card: A card issued by a bank allowing the holder to transfer money electronically from one account to another account or another bank account, for cash withdrawal, for making a purchase etc."
},
"transaction": {
"$ref": "#/definitions/Transaction"
}
}
}
{
"type": "object",
"properties": {
"transactionCreatedDate": {
"maxLength": 32,
"type": "string",
"format": "date-time",
"example": "2022-10-22T17:40:58Z",
"description": "This field contains the date, hour, minute, and second that created record in the table of the mobile app"
},
"escCreatedDate": {
"maxLength": 32,
"type": "string",
"format": "date-time",
"example": "2022-10-22T17:40:58Z",
"description": "This field contains the date, hour, minute, and second that creates the folio Debit Cardless in Enhanced Card System(ECS)"
},
"accountNumber": {
"maxLength": 16,
"type": "string",
"example": "9559724287",
"description": "Customer's Account Number with the Bank. An account number is the primary identifier for ownership of an account, whether a checking account or savings account."
},
"customerId": {
"maxLength": 14,
"type": "string",
"example": "3636614",
"description": "Unique identifier of the customer"
},
"transactionId": {
"maxLength": 14,
"type": "string",
"example": "9121921",
"description": "This is the Unique Identifier of the transaction"
},
"totalWithdrawalAmount": {
"type": "number",
"format": "double",
"example": 200,
"description": "Refers to the Total amount withdrawal out of the account"
},
"transactionAuthorization": {
"$ref": "#/definitions/TransactionAuthorization"
}
}
}
{
"type": "object",
"properties": {
"authenticationTypeCode": {
"maxLength": 1,
"type": "string",
"example": "2",
"description": "This field contain the authentication type code handled by the customer. 1: Userid and Password, 2: Softtoken, 3: HardToken. This values is second authentication factor(2FA)"
},
"authenticationDate": {
"maxLength": 32,
"type": "string",
"format": "date-time",
"example": "2022-10-22T17:40:58Z",
"description": "This field contains the date and time when the customer in the request of authenticated with second factor(2FA) when the debit cardless is request"
},
"ipAddress": {
"maxLength": 20,
"type": "string",
"example": "100.200.102.500",
"description": "Ip address of the device."
}
}
}
{
"properties": {
"type": {
"type": "string",
"description": "Invalid - Request did not confirm to the specification and was unprocessed and rejected. Please fix the value and try again",
"enum": [
"error",
"warn",
"invalid",
"fatal"
]
},
"code": {
"description": "Error code which qualifies the error",
"type": "string"
},
"details": {
"description": "Human readable explanation specific to the occurrence of the problem",
"type": "string"
},
"location": {
"description": "The name of the field that resulted in the error",
"type": "string"
},
"moreInfo": {
"description": "URI to human readable documentation of the error",
"type": "string"
},
"uuid": {
"description": "128 bit UUID that you generate for every request",
"type": "string"
},
"timestamp": {
"description": "timestamp of the error",
"type": "string"
}
},
"required": [
"type",
"code"
]
}