Paths
/sibs/v1-0-0/loyalty-program-association
Creates a Loyalty Program Association resource at the SIBS API Management.
Creates a Loyalty Program Association resource at the SIBS API Management.
Hash of the message body. Should be present when Request body exists
ID of the transaction as determined by the initiating party.
ID of the request, unique to the call, as determined by the initiating party.
The forwarded Agent header field of the http request between PSU and TPP.
{
"default": ""
}The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request. Do not fill in Direct Debit context. Reserved for future use.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "^GEO:[-?+?(\\d){1,3}.(\\d){6}]{8,11};[-?+?(\\d){1,3}.(\\d){6}]{8,11}$",
"default": "GEO:1.111111;-1.111111"
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
{
"default": ""
}Fingerprint of the device used in the request between PSU and TPP, if available.
{
"default": ""
}Loyalty Program Association Request
Bad Request.
Unauthorized.
Forbidden.
Not Found.
Method Not Allowed.
Not Acceptable.
Request Timeout.
Unsupported Media Type.
Too Many Requests.
Internal Server Error.
Service Unavailable.
Gatewaty Timeout.
/sibs/v1-0-0/loyalty-program-association/{association-id}/status
Request the status of an association loyalty program resource.
Request the status of an association loyalty program resource.
Identification of the association resource as it is used in the API structure. Shall be contained, if a na authentication resource was generated.
ID of the transaction as determined by the initiating party.
ID of the request, unique to the call, as determined by the initiating party.
The forwarded Agent header field of the http request between PSU and TPP.
{
"default": ""
}The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request. Do not fill in Direct Debit context. Reserved for future use.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
{
"pattern": "^GEO:[-?+?(\\d){1,3}.(\\d){6}]{8,11};[-?+?(\\d){1,3}.(\\d){6}]{8,11}$",
"default": "GEO:1.111111;-1.111111"
}UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.
{
"default": ""
}Fingerprint of the device used in the request between PSU and TPP, if available.
{
"default": ""
}Bad Request.
Unauthorized.
Forbidden.
Not Found.
Method Not Allowed.
Not Acceptable.
Request Timeout.
Unsupported Media Type.
Too Many Requests.
Internal Server Error.
Service Unavailable.
Gatewaty Timeout.
Definitions
Error and status Information.
{
"type": "object",
"properties": {
"transactionStatus": {
"$ref": "#/definitions/TransactionStatusType",
"description": "The transaction status is filled with codes of the ISO 20022 corresponding element."
},
"tppMessages": {
"$ref": "#/definitions/TppMessageArray",
"description": "Messages to the TPP on operational issues."
}
},
"additionalProperties": false
}
Transports additional error information.
{
"required": [
"category",
"code"
],
"properties": {
"category": {
"type": "string",
"default": "",
"description": "Category of the error. Only \"ERROR\" or \"WARNING\" permitted."
},
"code": {
"$ref": "#/definitions/MessageCode",
"description": "Message error code."
},
"path": {
"type": "string",
"default": "",
"description": "Path of the element of the request message which provoked this error message."
},
"text": {
"type": "string",
"maxLength": 512,
"default": "",
"description": "Additional explaining text."
}
},
"additionalProperties": false
}
Messages to the TPP on operational issues.
{
"type": "array",
"items": {
"$ref": "#/definitions/TppMessage",
"description": "Transports additional error information."
},
"additionalProperties": false
}
Message error codes.
{
"type": "string",
"enum": [
"CERTIFICATE_INVALID",
"CERTIFICATE_EXPIRED",
"CERTIFICATE_BLOCKED",
"CERTIFICATE_REVOKED",
"CERTIFICATE_MISSING",
"SIGNATURE_INVALID",
"SIGNATURE_MISSING",
"FORMAT_ERROR",
"PSU_CREDENTIALS_INVALID",
"SERVICE_INVALID",
"SERVICE_BLOCKED",
"CORPORATE_ID_INVALID",
"CONSENT_UNKNOWN",
"CONSENT_INVALID",
"CONSENT_EXPIRED",
"TOKEN_UNKNOWN",
"TOKEN_INVALID",
"TOKEN_EXPIRED",
"RESOURCE_UNKNOWN",
"RESOURCE_EXPIRED",
"TIMESTAMP_INVALID",
"PERIOD_INVALID",
"SCA_METHOD_UNKNOWN",
"TRANSACTION_ID_INVALID",
"PRODUCT_INVALID",
"PRODUCT_UNKNOWN",
"PAYMENT_FAILED",
"REQUIRED_KID_MISSING",
"SESSIONS_NOT_SUPPORTED",
"ACCESS_EXCEEDED",
"REQUESTED_FORMATS_INVALID",
"CARD_INVALID",
"NO_PIIS_ACTIVATION"
],
"default": "CONSENT_INVALID",
"additionalProperties": false
}
ISO20022: The transaction status.
{
"type": "string",
"enum": [
"ACCP",
"ACTC",
"RCVD",
"RJCT"
],
"default": "ACCP",
"additionalProperties": false
}
Loyalty Programme Enrollment Status Code. \n Possible values are: \n "ACTV" - "Active"; \n "CANC" - "Cancelled"; \n "SUSP" - "Suspended"; \n "APEX" - "Activation Processing Expired"; \n "APRC" - "Activation Processing Rejected by Client"; \n "APRP" - "Activation Processing Rejected by Processor".
{
"type": "string",
"enum": [
"ACTV",
"CANC",
"SUSP",
"APEX",
"APRC",
"APRP"
],
"default": "CANC",
"additionalProperties": false
}
Payload.
{
"type": "object",
"properties": {
"payloadDescription": {
"description": "Description of payload purpose (TPP free text used to transportation of relevant data to be given to PSU).",
"type": "string"
},
"authenticationPayload": {
"description": "Is asking for detailed payload information. The following structure cannot be less than one (1) and greater than three (3).",
"$ref": "#/definitions/PayloadReferenceArray"
}
},
"additionalProperties": false,
"required": [
"authenticationPayload"
]
}
Array of Payload Reference
{
"type": "array",
"items": {
"$ref": "#/definitions/PayloadReference",
"description": "Payload Reference.",
"additionalProperties": false
},
"additionalProperties": false
}
{
"type": "object",
"properties": {
"identification": {
"description": "It identifies the token (as token identification).",
"type": "string"
},
"value": {
"description": "It identifies the value related to token identification. This value will be shown to PSU.",
"type": "string"
},
"priority": {
"description": "It identifies the token identification (and corresponding value) presentation priority to PSU. It must be fulfilled with na integer between 1 and 3.",
"type": "integer"
}
},
"additionalProperties": false
}
{
"properties": {
"msisdn": {
"type": "string",
"maxLength": 35,
"description": "An alias to guarantee PSU authentication and authorisation processes via a registered mobile phone number in MBWAY service."
},
"loyaltyProgram": {
"type": "integer",
"description": "Loyalty Program Code"
},
"endToEndIdentification": {
"type": "string",
"maxLength": 35,
"description": "Unique identification as assigned by the sending party to unambiguously identify this payment."
},
"payload": {
"$ref": "#/definitions/Payload"
}
},
"additionalProperties": false,
"required": [
"msisdn",
"loyaltyProgram",
"payload"
]
}
{
"properties": {
"transactionStatus": {
"description": "",
"$ref": "#/definitions/TransactionStatusType"
},
"associationId": {
"type": "string",
"description": "Identification of the association resource as it is used in the API structure. Shall be contained, if a na authentication resource was generated."
},
"tppMessages": {
"description": "Messages to the TPP on operational issues.",
"$ref": "#/definitions/TppMessageArray"
}
},
"additionalProperties": false,
"required": [
"transactionStatus"
]
}
Loyalty Program Association Status Response Resource
{
"properties": {
"transactionStatus": {
"$ref": "#/definitions/TransactionStatusType"
},
"associationStatus": {
"$ref": "#/definitions/AssociationStatusType"
},
"loyaltyProgramPriority": {
"type": "integer",
"description": "Loyalty Programme Priority in Card Associations."
},
"loyaltyProgramName": {
"type": "string",
"maxLength": 16,
"description": "Loyalty Programme Name."
},
"promoterReference": {
"type": "string",
"maxLength": 40,
"description": "Loyalty Programme Promoter Channel Reference."
},
"promoterName": {
"type": "string",
"maxLength": 40,
"description": "Loyalty Programme Promoter Name."
},
"maskedPan": {
"type": "string",
"description": "Card Masked Primary Account Number"
},
"panExpiryDate": {
"type": "string",
"format": "date",
"description": "Expiry Date of informed Card Masked Primary Account Number (PAN). It must be fulfilled in YYYY-MM format."
},
"tppMessages": {
"description": "Messages to the TPP on operational issues.",
"$ref": "#/definitions/TppMessageArray"
}
},
"additionalProperties": false,
"required": [
"transactionStatus"
]
}