production
development
https://perf.api.externalapib2b.wlb.lac.nsroot.net:7100/mx-gcgapi/perfext
Paths
/v1/cards/accounts/transactions/offers/retrieve
post /v1/cards/accounts/transactions/offers/retrieve
retrieve-offers
The API retrieves the availale offers for a customer based upon his card account and its transactions
The API retrieves the availale offers for a customer based upon his card account and its 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
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
retrieveOffersRequest
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/accounts/transactions/offers/retrieve
/v1/cards/accounts/transactions/offers/accept-offer
post /v1/cards/accounts/transactions/offers/accept-offer
accept-offer
The API helps the customer to accept and offer on his card
The API helps the customer to accept and offer on his card
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
ChannelId
Required in header
string
Channel where request originated
sid
Required in header
string
SessionId sent by Consumer
acceptOfferRequest
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/accounts/transactions/offers/accept-offer
Definitions
{
"type": "object",
"properties": {
"customerId": {
"description": "unique identifier of the customer",
"type": "string",
"example": "123456789012"
},
"campaignId": {
"description": "campaign id of the offer",
"type": "string",
"example": "12345678"
},
"waveId": {
"description": "wave id of the offer",
"type": "string",
"example": "12345678"
},
"cardIdentifier": {
"description": "reference of the card in the mobile database",
"type": "string",
"example": "12345"
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"customer": {
"$ref": "#/definitions/Customer"
}
}
}
{
"type": "object",
"properties": {
"customerId": {
"description": "unique identifier of the customer",
"type": "string",
"example": "123456789012"
},
"offers": {
"type": "array",
"items": {
"$ref": "#/definitions/Offer"
}
}
},
"required": [
"customerId"
]
}
{
"type": "object",
"properties": {
"cardIdentifier": {
"description": "reference ID of the card in the mobile database",
"type": "string",
"example": "12345"
},
"campaignId": {
"description": "campaign id of the offer",
"type": "string",
"example": "12345678"
},
"waveId": {
"description": "wave id of the offer",
"type": "string",
"example": "12345678"
},
"transactionDescription": {
"description": "transaction detail/transaction amount",
"type": "string",
"example": "50.00"
},
"transactionDate": {
"description": "date of the transaction",
"type": "string",
"format": "date",
"example": "2019/12/26"
},
"transactionAuthorizationCode": {
"description": "authorization code of the transaction",
"type": "string",
"example": "123456"
},
"internalCounter": {
"description": "transaction internal counter",
"type": "integer",
"example": 23
},
"isOfferIndicator": {
"description": "field used to identify the offer",
"type": "string",
"example": "AFEWS"
},
"interestRate": {
"description": "interest rate of to the offer",
"type": "integer",
"format": "double",
"example": 20
},
"merchantName": {
"description": "person by whom a contract of carriage of goods has been concluded with",
"type": "string",
"example": "Walmart"
},
"validityDate": {
"description": "last date of wich the offer is valid",
"type": "string",
"format": "date",
"example": "2019/12/28"
},
"minimumLoanAmount": {
"description": "minumum amount applicable to the offer",
"type": "number",
"format": "double",
"example": 100.5
},
"maximumLoanAmount": {
"description": "maximum amount applicable to the offer",
"type": "number",
"format": "double",
"example": 25500
},
"displayCardNumber": {
"description": "last four digits of the card number",
"type": "string",
"example": 1234
},
"totalAnnualCost": {
"description": "CAT or total annual cost percentage on the card",
"type": "number",
"format": "double",
"example": 12.6
},
"loanArray": {
"description": "List of the transactions with detail.",
"type": "array",
"items": {
"$ref": "#/definitions/LoanArray"
}
}
},
"required": [
"customerId",
"campaignId",
"transactionDescription",
"interestRate",
"merchantName",
"validityDate",
"displayCardNumber"
]
}
{
"type": "object",
"properties": {
"loanTenure": {
"description": "Number of periods to defer the amount",
"type": "integer",
"example": 3
},
"loanAmount": {
"description": "Amount of the loan",
"type": "number",
"format": "double",
"example": 1234.56
}
}
}
{
"type": "object",
"properties": {
"offer": {
"$ref": "#/definitions/OfferDetail"
}
}
}
{
"type": "object",
"properties": {
"campaignId": {
"description": "campaign id of the offer",
"type": "string",
"example": "13764237"
},
"waveId": {
"description": "wave id of the offer",
"type": "string",
"example": "7625123768"
},
"customerId": {
"description": "unique identifier of customer",
"type": "string",
"example": "123456789012"
},
"cardIdentifier": {
"description": "reference ID of the card in the mobile database",
"type": "string",
"example": "12345"
},
"loanTenure": {
"description": "period of loan",
"type": "integer",
"format": "int32",
"example": 3
},
"offerStatus": {
"description": "status of offer",
"type": "string",
"example": "L"
},
"transactionAmount": {
"description": "amount of transaction for the offer",
"type": "number",
"format": "double",
"example": 1234.46
}
},
"required": [
"campaignId",
"customerId",
"loanTenure",
"offerStatus",
"transactionAmount",
"cardIdentifier"
]
}
{
"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": "More Info can be used to pass any additional details",
"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"
]
}