| Attribute | Description |
|---|---|
| cardInstanceId | Unique identifier of the membership card instance. e.g. 796fc94f-a9db-437a-90d9-7357002632d7 |
| customerId | Owner of the membership card. e.g. Burger King Alpharetta. |
| merchantId | Unique identifier of the merchant who issued the membership card. e.g. 418D20AC-A872-415B-ADB1-38EA90171898 |
| cardName | Name of the card. |
| cardNumber | Number of the card. e.g. 208738491092 |
| description | Description of the membership card. |
| cardType | Type of the card. Possible values are LOYALTY and GIFT. |
| balance | Remaining balance in the card if available. e.g. 10.00 |
| pin | PIN number of the card if available. |
| frontImageBase64 | Byte code of the front image of the card. |
| backImageBase64 | Byte code of the back image of the card. |
| status | Status of membership card. Possible values are ADDED and REMOVED. |
| createTime | Date and time when the membership card created. Format is yyyy-MM-dd’T’HH:mm:ss.SZ e.g. “2019-02-08T14:23:35.443-0500” yyyy: Year, e.g. 1996 <br>MM: Month in year, e.g. 07 dd: day in month, e.g. 10 HH:hour in day(0-23), e.g.0 mm:Minute in hour, e.g. 30 ss: Second in minute, e.g. 50 S: Millisecond in the minute, e.g. 443 Z: Timezone offset in hours(RFC 822 pattern), e.g. -0800 |
| barcodeType | Redeemable barcode type. Possible values are - UPC_A: 1D Product, UPC-A - UPC_E: 1D Product, UPC-3 - EAN_8: 1D Product, EAN_8 - EAN_13: 1D Product, EAN-13 - UPC_EAN_EXTENSION: 1D Product, UPC EAN Extension - CODE_39: 1D Industrial, Code-39 - CODE_93: 1D Industrial, Code-93 - CODE_128: 1D Industrial, Code-128 - CODABAR: 1D Industrial, Code-128 - ITF: 1D Industrial, ITF - RSS_14: 1D Industrial, RSS-14 - RSS_EXPANDED: 1D Industrial, RSS-Expanded - QR_CODE: 2D, QR Code - DATA_MATRIX: 2D, Data Matrix - AZTEC: 2D, Aztec - PDF_417: 2D, PDF-417 - MAXICODE: 2D, MaxiCode - QRCODE: Deprecated. QR Code for backward compatibility - None: No barcode selected. - UNKNOWN: Unknown |
| backgroundColor | HTML color code. e.g. #FFFFFF |
| updateTime | Date and time when the membership card updated. Format is yyyy-MM-dd’T’HH:mm:ss.SZ e.g. “2019-02-08T14:23:35.443-0500” yyyy: Year, e.g. 1996 <br>MM: Month in year, e.g. 07 dd: day in month, e.g. 10 HH:hour in day(0-23), e.g.0 mm:Minute in hour, e.g. 30 ss: Second in minute, e.g. 50 S: Millisecond in the minute, e.g. 443 Z: Timezone offset in hours(RFC 822 pattern), e.g. -0800 |
| Attribute | Description |
|---|---|
| merchantId | Unique identifier of merchant. e.g. 3D4F43E3-5B0A-462E-8A1D-305ED8EE045D |
| walletId | Your tenant ID who manages the membership merchant. e.g. JANUS |
| merchantName | Name of merchant |
| updateDtim | Last time the merchant is updated. Format is yyyy-MM-dd’T’HH:mm:ss.SZ e.g. “2019-02-08T14:23:35.443-0500” yyyy: Year, e.g. 1996 <br>MM: Month in year, e.g. 07 dd: day in month, e.g. 10 HH:hour in day(0-23), e.g.0 mm:Minute in hour, e.g. 30 ss: Second in minute, e.g. 50 S: Millisecond in the minute, e.g. 443 Z: Timezone offset in hours(RFC 822 pattern), e.g. -0800 |
| merchantBackgroundImageUrl | URL to retrieve merchant background image |
| merchantImageUrl | URL to retrieve merchant logo |
| barcodeType | Redeemable barcode type supported by the merchant. Possible values are - UPC_A: 1D Product, UPC-A - UPC_E: 1D Product, UPC-3 - EAN_8: 1D Product, EAN_8 - EAN_13: 1D Product, EAN-13 - UPC_EAN_EXTENSION: 1D Product, UPC EAN Extension - CODE_39: 1D Industrial, Code-39 - CODE_93: 1D Industrial, Code-93 - CODE_128: 1D Industrial, Code-128 - CODABAR: 1D Industrial, Code-128 - ITF: 1D Industrial, ITF - RSS_14: 1D Industrial, RSS-14 - RSS_EXPANDED: 1D Industrial, RSS-Expanded - QR_CODE: 2D, QR Code - DATA_MATRIX: 2D, Data Matrix - AZTEC: 2D, Aztec - PDF_417: 2D, PDF-417 - MAXICODE: 2D, MaxiCode - QRCODE: Deprecated. QR Code for backward compatibility - None: No barcode selected. - UNKNOWN: Unknown |
| customerCareInfo | Long description of the merchant. e.g. “Best price. Price match guarantee. Find a lower rate” |
| phoneNumber | Contact number of the merchant e.g. 000-000-0001 |
| serviceHours | Hours of contact service e.g. 24 hours or 9AM ~ 8PM |
| websiteUrl | URL of merchant website e.g. https://www3.hilton.com |
End user can enter detail information of membership card in the wallet and manage it. With this feature, end user no need to carry the actual card but can use his/her digital card instead.
Client logged in the service. Refer the section for registration/authentication.
HTTP Method / URL
POST / http://api-dev.fintiv.co:8080/membership/{version}/addCard
Body parameters
| Parameters | Type | Required | Note |
|---|---|---|---|
| merchantId | String | Optional | Unique identifier of the merchant who issued the membership card. e.g. 418D20AC-A872-415B-ADB1-38EA90171898 |
| cardName | String | Required | Name of the card |
| cardNumber | String | Required | Number of the card e.g. 208738491092 |
| Description | String | Optional | Description of the membership card |
| cardType | String | Required | Type of the card. Possible values are LOYALTY and GIFT. |
| balance | String | Optional | Remaining balance in the card if available. e.g. 10.00 |
| pin | String | Optional | PIN number of the card if available. |
| frontImageBase64 | String | Optional | Byte array of the front image of the card |
| backImageBase64 | String | Optional | Byte array of the back image of the card |
| barcodeType | String | Optional | Redeemable barcode type. Possible values are - UPC_A: 1D Product, UPC-A - UPC_E: 1D Product, UPC-3 - EAN_8: 1D Product, EAN_8 - EAN_13: 1D Product, EAN-13 - UPC_EAN_EXTENSION: 1D Product, UPC EAN Extension - CODE_39: 1D Industrial, Code-39 - CODE_93: 1D Industrial, Code-93 - CODE_128: 1D Industrial, Code-128 - CODABAR: 1D Industrial, Code-128 - ITF: 1D Industrial, ITF - RSS_14: 1D Industrial, RSS-14 - RSS_EXPANDED: 1D Industrial, RSS-Expanded - QR_CODE: 2D, QR Code - DATA_MATRIX: 2D, Data Matrix - AZTEC: 2D, Aztec - PDF_417: 2D, PDF-417 - MAXICODE: 2D, MaxiCode - QRCODE: Deprecated. QR Code for backward compatibility - None: No barcode selected. - UNKNOWN: Unknown |
| backgroundColor | String | Optional | HTML color code to be used in the background of the membership card. e.g. #FFFFFF |
Example request
curl -X POST "http://api-dev.fintiv.co:8080/membership/v2/addCard"
-H "accept: application/json;charset=UTF-8"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d
‘{
"card":
{
"merchantId": "418D20AC-A872-415B-ADB1-38EA90171898",
"cardName": "Delta Skymiles",
"cardNumber": "1234123412345678",
"cardType": "GIFT",
"balance": "10.00",
"description": "Gift card from delta",
"backgroundColor":"FF00FF",
"pin":"1234",
"barcodeType":"UPC_A",
"frontImageBase64": "iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAADx0lEQVR42q2UbUxTVxjHz+3bbUsrFHzJBtuoVUvMwowvi1vc5uKWGRUSl6gZupm6TOc0waA1zkUNZtOYuemCJvvgpsYNsNSXkdItUxGKZSIgiE5eKopA6gdQIkp01Nu/z3NbMkGz+GEn+ec+93n5neeee84RYuRIzFwsRs92i/9lSFr9uA+9rc6NTQ8dyda3c18TWwqzhD/g0jWx2GafM0m8+nzA5Jk5+TUD8HYoWL/CpQyeWgSldS+i3R5VbLPv9rejI9+9JX5ONoqx/9Wd/GLO0Wv+MFDVA8z6vgXhzgtA/3mgLxAT2wONQK8PEf97qPlUE7KPEhlc/RTO/NKcTVkn78HXDZR2Aa7yQXzxdRHQdWC4un8CbpH/tg+PKuah7jPNDZssxo2EajM+OtS3oRYoug4cDAGfVwPOzdRNKP/Zur4T6NyDiNeBPe9KvzBjCKaZmCSmzlxThB2XgV/bgf3NQC59rXMrAa+sGq7LK/9VSx5QuwB3d5sUZjCLgfq8adLubbnZeL+wB9uJ8WU9MKfkPj5Zt1UtQO38uMiuyyJlx3RxIWkuIsVjwAxmMdBUslh/7k7JC9i2ZSnecRdi1kYv1rpXoevEJKBiPFBuj4ntKvJVTwaCU+g5gzQFUX8qmMEsBo4Krja2RU/b0Vdmx82Tr6CjJA1dxWmIniVI3YQYiKXadgyUvQwE0oG/HPTuANcyg1nq7guuNrQpf6TSrOmo3DUWK980wTVdjxUzjDjqTgEupKlim30c4xzOxbl0KL+nghnMYqDNs0RbHSlNpNlsOFVgxiVPAnorLWj3m+HbZ6C1M6ryFRhUXw/FOOfMPjNQaUPkt0QQI8gsBlryXpd+HPRQsCqBPksGGnRAowZoloAOUquI6YYU83GsjnJqKbciAYPFZjCDWepfnmgT2f37ZQVBK1DD3egJqqVigtyS6HBIeNBEoDDpKvkuUqyGcoKUG7Civ0BWmDH0l3mHp+6dqylVyiw0O+lvmjlEBWEtDn+lQ84kA5ZlGOD9Rqf60EyxK/wlFig+C7iWGU+eFgMd9NkNG3Td0Srqsp2gPUYEjhiwwyXjUqmMhmMy8j+WUX+c1jRMnYUsiFJ3XMO1zBh2lnlBxyeJRfVuXadyhoCtVjxso+cdE10Mxph6TfinhXwtVih/WsC5XBP/GU9fEKQxKSbxwQ/zNL67B+RHUVpw1FPHV+NqtCJangCOcQ7ncs2zYE9CeXNOdqaI5XlvSAc9y7Xnq926ayy22ccxzonnSs9z1Wrim9RByiRNjysz7kseughGjsda3MlcNDdCsQAAAABJRU5ErkJggg==",
"backImageBase64":"iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAADx0lEQVR42q2UbUxTVxjHz+3bbUsrFHzJBtuoVUvMwowvi1vc5uKWGRUSl6gZupm6TOc0waA1zkUNZtOYuemCJvvgpsYNsNSXkdItUxGKZSIgiE5eKopA6gdQIkp01Nu/z3NbMkGz+GEn+ec+93n5neeee84RYuRIzFwsRs92i/9lSFr9uA+9rc6NTQ8dyda3c18TWwqzhD/g0jWx2GafM0m8+nzA5Jk5+TUD8HYoWL/CpQyeWgSldS+i3R5VbLPv9rejI9+9JX5ONoqx/9Wd/GLO0Wv+MFDVA8z6vgXhzgtA/3mgLxAT2wONQK8PEf97qPlUE7KPEhlc/RTO/NKcTVkn78HXDZR2Aa7yQXzxdRHQdWC4un8CbpH/tg+PKuah7jPNDZssxo2EajM+OtS3oRYoug4cDAGfVwPOzdRNKP/Zur4T6NyDiNeBPe9KvzBjCKaZmCSmzlxThB2XgV/bgf3NQC59rXMrAa+sGq7LK/9VSx5QuwB3d5sUZjCLgfq8adLubbnZeL+wB9uJ8WU9MKfkPj5Zt1UtQO38uMiuyyJlx3RxIWkuIsVjwAxmMdBUslh/7k7JC9i2ZSnecRdi1kYv1rpXoevEJKBiPFBuj4ntKvJVTwaCU+g5gzQFUX8qmMEsBo4Krja2RU/b0Vdmx82Tr6CjJA1dxWmIniVI3YQYiKXadgyUvQwE0oG/HPTuANcyg1nq7guuNrQpf6TSrOmo3DUWK980wTVdjxUzjDjqTgEupKlim30c4xzOxbl0KL+nghnMYqDNs0RbHSlNpNlsOFVgxiVPAnorLWj3m+HbZ6C1M6ryFRhUXw/FOOfMPjNQaUPkt0QQI8gsBlryXpd+HPRQsCqBPksGGnRAowZoloAOUquI6YYU83GsjnJqKbciAYPFZjCDWepfnmgT2f37ZQVBK1DD3egJqqVigtyS6HBIeNBEoDDpKvkuUqyGcoKUG7Civ0BWmDH0l3mHp+6dqylVyiw0O+lvmjlEBWEtDn+lQ84kA5ZlGOD9Rqf60EyxK/wlFig+C7iWGU+eFgMd9NkNG3Td0Srqsp2gPUYEjhiwwyXjUqmMhmMy8j+WUX+c1jRMnYUsiFJ3XMO1zBh2lnlBxyeJRfVuXadyhoCtVjxso+cdE10Mxph6TfinhXwtVih/WsC5XBP/GU9fEKQxKSbxwQ/zNL67B+RHUVpw1FPHV+NqtCJangCOcQ7ncs2zYE9CeXNOdqaI5XlvSAc9y7Xnq926ayy22ccxzonnSs9z1Wrim9RByiRNjysz7kseughGjsda3MlcNDdCsQAAAABJRU5ErkJggg=="
}
}’
Returns result of the request.
Example response
{
"result": {
"code": 0
}
}
Retrieves all end user’s registered membership cards.
Client logged in the service. Refer the section for registration/authentication.
HTTP Method / URL
POST / http://api-dev.fintiv.co:8080/membership/{version}/getCards
Body parameters
| Parameters | Type | Required | Note |
|---|---|---|---|
| imagesByUrl | boolean | Optional | Define type of returned image. FALSE returns image as byte array. True returns image as URL. Default value is FALSE |
Example request
curl -X POST "http://api-dev.fintiv.co:8080/membership/v2/getCards"
-H "accept: application/json;charset=UTF-8"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{"imagesByUrl": true}’
Returns list of end user’s membership cards
Example response
{
"result": {
"code": 0
},
"cardInstances": [
{
"cardInstanceId": "852c8e1d-cd6c-4ecf-8c2b-deb64be16561",
"cardName": "Delta Skymiles",
"cardNumber": "1234",
"cardType": "GIFT",
"status": "ADDED",
"createTime": "2019-03-07T16:38:10.000+0000",
"updateTime": "2019-03-07T16:38:10.000+0000"
},
{
"cardInstanceId": "0615edec-c19f-4466-8856-cbe8738e6bf2",
"merchantId": "418D20AC-A872-415B-ADB1-38EA90171898",
"cardName": "Delta Skymiles",
"cardNumber": "1234123412345678",
"description": "Gift card from delta",
"cardType": "GIFT",
"balance": "10.00",
"pin": "1234",
"status": "ADDED",
"createTime": "2019-03-07T16:21:50.000+0000",
"barcodeType": "UPC_A",
"backgroundColor": "FF00FF",
"updateTime": "2019-03-07T16:21:50.000+0000",
"frontImageBase64": "iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAADx0lEQVR42q2UbUxTVxjHz+3bbUsrFHzJBtuoVUvMwowvi1vc5uKWGRUSl6gZupm6TOc0waA1zkUNZtOYuemCJvvgpsYNsNSXkdItUxGKZSIgiE5eKopA6gdQIkp01Nu/z3NbMkGz+GEn+ec+93n5neeee84RYuRIzFwsRs92i/9lSFr9uA+9rc6NTQ8dyda3c18TWwqzhD/g0jWx2GafM0m8+nzA5Jk5+TUD8HYoWL/CpQyeWgSldS+i3R5VbLPv9rejI9+9JX5ONoqx/9Wd/GLO0Wv+MFDVA8z6vgXhzgtA/3mgLxAT2wONQK8PEf97qPlUE7KPEhlc/RTO/NKcTVkn78HXDZR2Aa7yQXzxdRHQdWC4un8CbpH/tg+PKuah7jPNDZssxo2EajM+OtS3oRYoug4cDAGfVwPOzdRNKP/Zur4T6NyDiNeBPe9KvzBjCKaZmCSmzlxThB2XgV/bgf3NQC59rXMrAa+sGq7LK/9VSx5QuwB3d5sUZjCLgfq8adLubbnZeL+wB9uJ8WU9MKfkPj5Zt1UtQO38uMiuyyJlx3RxIWkuIsVjwAxmMdBUslh/7k7JC9i2ZSnecRdi1kYv1rpXoevEJKBiPFBuj4ntKvJVTwaCU+g5gzQFUX8qmMEsBo4Krja2RU/b0Vdmx82Tr6CjJA1dxWmIniVI3YQYiKXadgyUvQwE0oG/HPTuANcyg1nq7guuNrQpf6TSrOmo3DUWK980wTVdjxUzjDjqTgEupKlim30c4xzOxbl0KL+nghnMYqDNs0RbHSlNpNlsOFVgxiVPAnorLWj3m+HbZ6C1M6ryFRhUXw/FOOfMPjNQaUPkt0QQI8gsBlryXpd+HPRQsCqBPksGGnRAowZoloAOUquI6YYU83GsjnJqKbciAYPFZjCDWepfnmgT2f37ZQVBK1DD3egJqqVigtyS6HBIeNBEoDDpKvkuUqyGcoKUG7Civ0BWmDH0l3mHp+6dqylVyiw0O+lvmjlEBWEtDn+lQ84kA5ZlGOD9Rqf60EyxK/wlFig+C7iWGU+eFgMd9NkNG3Td0Srqsp2gPUYEjhiwwyXjUqmMhmMy8j+WUX+c1jRMnYUsiFJ3XMO1zBh2lnlBxyeJRfVuXadyhoCtVjxso+cdE10Mxph6TfinhXwtVih/WsC5XBP/GU9fEKQxKSbxwQ/zNL67B+RHUVpw1FPHV+NqtCJangCOcQ7ncs2zYE9CeXNOdqaI5XlvSAc9y7Xnq926ayy22ccxzonnSs9z1Wrim9RByiRNjysz7kseughGjsda3MlcNDdCsQAAAABJRU5ErkJggg==",
"backImageBase64": "iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAADx0lEQVR42q2UbUxTVxjHz+3bbUsrFHzJBtuoVUvMwowvi1vc5uKWGRUSl6gZupm6TOc0waA1zkUNZtOYuemCJvvgpsYNsNSXkdItUxGKZSIgiE5eKopA6gdQIkp01Nu/z3NbMkGz+GEn+ec+93n5neeee84RYuRIzFwsRs92i/9lSFr9uA+9rc6NTQ8dyda3c18TWwqzhD/g0jWx2GafM0m8+nzA5Jk5+TUD8HYoWL/CpQyeWgSldS+i3R5VbLPv9rejI9+9JX5ONoqx/9Wd/GLO0Wv+MFDVA8z6vgXhzgtA/3mgLxAT2wONQK8PEf97qPlUE7KPEhlc/RTO/NKcTVkn78HXDZR2Aa7yQXzxdRHQdWC4un8CbpH/tg+PKuah7jPNDZssxo2EajM+OtS3oRYoug4cDAGfVwPOzdRNKP/Zur4T6NyDiNeBPe9KvzBjCKaZmCSmzlxThB2XgV/bgf3NQC59rXMrAa+sGq7LK/9VSx5QuwB3d5sUZjCLgfq8adLubbnZeL+wB9uJ8WU9MKfkPj5Zt1UtQO38uMiuyyJlx3RxIWkuIsVjwAxmMdBUslh/7k7JC9i2ZSnecRdi1kYv1rpXoevEJKBiPFBuj4ntKvJVTwaCU+g5gzQFUX8qmMEsBo4Krja2RU/b0Vdmx82Tr6CjJA1dxWmIniVI3YQYiKXadgyUvQwE0oG/HPTuANcyg1nq7guuNrQpf6TSrOmo3DUWK980wTVdjxUzjDjqTgEupKlim30c4xzOxbl0KL+nghnMYqDNs0RbHSlNpNlsOFVgxiVPAnorLWj3m+HbZ6C1M6ryFRhUXw/FOOfMPjNQaUPkt0QQI8gsBlryXpd+HPRQsCqBPksGGnRAowZoloAOUquI6YYU83GsjnJqKbciAYPFZjCDWepfnmgT2f37ZQVBK1DD3egJqqVigtyS6HBIeNBEoDDpKvkuUqyGcoKUG7Civ0BWmDH0l3mHp+6dqylVyiw0O+lvmjlEBWEtDn+lQ84kA5ZlGOD9Rqf60EyxK/wlFig+C7iWGU+eFgMd9NkNG3Td0Srqsp2gPUYEjhiwwyXjUqmMhmMy8j+WUX+c1jRMnYUsiFJ3XMO1zBh2lnlBxyeJRfVuXadyhoCtVjxso+cdE10Mxph6TfinhXwtVih/WsC5XBP/GU9fEKQxKSbxwQ/zNL67B+RHUVpw1FPHV+NqtCJangCOcQ7ncs2zYE9CeXNOdqaI5XlvSAc9y7Xnq926ayy22ccxzonnSs9z1Wrim9RByiRNjysz7kseughGjsda3MlcNDdCsQAAAABJRU5ErkJggg=="
},
{
"cardInstanceId": "796fc94f-a9db-437a-90d9-7357002632d7",
"merchantId": "418D20AC-A872-415B-ADB1-38EA90171898",
"cardName": "CNAME CNMAE ",
"cardNumber": "11111",
"description": "test gift card",
"cardType": "GIFT",
"balance": "10.00",
"status": "ADDED",
"createTime": "2019-03-07T15:42:54.000+0000",
"backgroundColor": "FF00FF",
"updateTime": "2019-03-07T15:42:54.000+0000",
"frontImageBase64": "iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAADx0lEQVR42q2UbUxTVxjHz+3bbUsrFHzJBtuoVUvMwowvi1vc5uKWGRUSl6gZupm6TOc0waA1zkUNZtOYuemCJvvgpsYNsNSXkdItUxGKZSIgiE5eKopA6gdQIkp01Nu/z3NbMkGz+GEn+ec+93n5neeee84RYuRIzFwsRs92i/9lSFr9uA+9rc6NTQ8dyda3c18TWwqzhD/g0jWx2GafM0m8+nzA5Jk5+TUD8HYoWL/CpQyeWgSldS+i3R5VbLPv9rejI9+9JX5ONoqx/9Wd/GLO0Wv+MFDVA8z6vgXhzgtA/3mgLxAT2wONQK8PEf97qPlUE7KPEhlc/RTO/NKcTVkn78HXDZR2Aa7yQXzxdRHQdWC4un8CbpH/tg+PKuah7jPNDZssxo2EajM+OtS3oRYoug4cDAGfVwPOzdRNKP/Zur4T6NyDiNeBPe9KvzBjCKaZmCSmzlxThB2XgV/bgf3NQC59rXMrAa+sGq7LK/9VSx5QuwB3d5sUZjCLgfq8adLubbnZeL+wB9uJ8WU9MKfkPj5Zt1UtQO38uMiuyyJlx3RxIWkuIsVjwAxmMdBUslh/7k7JC9i2ZSnecRdi1kYv1rpXoevEJKBiPFBuj4ntKvJVTwaCU+g5gzQFUX8qmMEsBo4Krja2RU/b0Vdmx82Tr6CjJA1dxWmIniVI3YQYiKXadgyUvQwE0oG/HPTuANcyg1nq7guuNrQpf6TSrOmo3DUWK980wTVdjxUzjDjqTgEupKlim30c4xzOxbl0KL+nghnMYqDNs0RbHSlNpNlsOFVgxiVPAnorLWj3m+HbZ6C1M6ryFRhUXw/FOOfMPjNQaUPkt0QQI8gsBlryXpd+HPRQsCqBPksGGnRAowZoloAOUquI6YYU83GsjnJqKbciAYPFZjCDWepfnmgT2f37ZQVBK1DD3egJqqVigtyS6HBIeNBEoDDpKvkuUqyGcoKUG7Civ0BWmDH0l3mHp+6dqylVyiw0O+lvmjlEBWEtDn+lQ84kA5ZlGOD9Rqf60EyxK/wlFig+C7iWGU+eFgMd9NkNG3Td0Srqsp2gPUYEjhiwwyXjUqmMhmMy8j+WUX+c1jRMnYUsiFJ3XMO1zBh2lnlBxyeJRfVuXadyhoCtVjxso+cdE10Mxph6TfinhXwtVih/WsC5XBP/GU9fEKQxKSbxwQ/zNL67B+RHUVpw1FPHV+NqtCJangCOcQ7ncs2zYE9CeXNOdqaI5XlvSAc9y7Xnq926ayy22ccxzonnSs9z1Wrim9RByiRNjysz7kseughGjsda3MlcNDdCsQAAAABJRU5ErkJggg==",
"backImageBase64": "iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAADx0lEQVR42q2UbUxTVxjHz+3bbUsrFHzJBtuoVUvMwowvi1vc5uKWGRUSl6gZupm6TOc0waA1zkUNZtOYuemCJvvgpsYNsNSXkdItUxGKZSIgiE5eKopA6gdQIkp01Nu/z3NbMkGz+GEn+ec+93n5neeee84RYuRIzFwsRs92i/9lSFr9uA+9rc6NTQ8dyda3c18TWwqzhD/g0jWx2GafM0m8+nzA5Jk5+TUD8HYoWL/CpQyeWgSldS+i3R5VbLPv9rejI9+9JX5ONoqx/9Wd/GLO0Wv+MFDVA8z6vgXhzgtA/3mgLxAT2wONQK8PEf97qPlUE7KPEhlc/RTO/NKcTVkn78HXDZR2Aa7yQXzxdRHQdWC4un8CbpH/tg+PKuah7jPNDZssxo2EajM+OtS3oRYoug4cDAGfVwPOzdRNKP/Zur4T6NyDiNeBPe9KvzBjCKaZmCSmzlxThB2XgV/bgf3NQC59rXMrAa+sGq7LK/9VSx5QuwB3d5sUZjCLgfq8adLubbnZeL+wB9uJ8WU9MKfkPj5Zt1UtQO38uMiuyyJlx3RxIWkuIsVjwAxmMdBUslh/7k7JC9i2ZSnecRdi1kYv1rpXoevEJKBiPFBuj4ntKvJVTwaCU+g5gzQFUX8qmMEsBo4Krja2RU/b0Vdmx82Tr6CjJA1dxWmIniVI3YQYiKXadgyUvQwE0oG/HPTuANcyg1nq7guuNrQpf6TSrOmo3DUWK980wTVdjxUzjDjqTgEupKlim30c4xzOxbl0KL+nghnMYqDNs0RbHSlNpNlsOFVgxiVPAnorLWj3m+HbZ6C1M6ryFRhUXw/FOOfMPjNQaUPkt0QQI8gsBlryXpd+HPRQsCqBPksGGnRAowZoloAOUquI6YYU83GsjnJqKbciAYPFZjCDWepfnmgT2f37ZQVBK1DD3egJqqVigtyS6HBIeNBEoDDpKvkuUqyGcoKUG7Civ0BWmDH0l3mHp+6dqylVyiw0O+lvmjlEBWEtDn+lQ84kA5ZlGOD9Rqf60EyxK/wlFig+C7iWGU+eFgMd9NkNG3Td0Srqsp2gPUYEjhiwwyXjUqmMhmMy8j+WUX+c1jRMnYUsiFJ3XMO1zBh2lnlBxyeJRfVuXadyhoCtVjxso+cdE10Mxph6TfinhXwtVih/WsC5XBP/GU9fEKQxKSbxwQ/zNL67B+RHUVpw1FPHV+NqtCJangCOcQ7ncs2zYE9CeXNOdqaI5XlvSAc9y7Xnq926ayy22ccxzonnSs9z1Wrim9RByiRNjysz7kseughGjsda3MlcNDdCsQAAAABJRU5ErkJggg=="
}
]
}
{
"result": {
"code": 0
},
"cardInstances": [
{
"cardInstanceId": "852c8e1d-cd6c-4ecf-8c2b-deb64be16561",
"cardName": "Delta Skymiles",
"cardNumber": "1234",
"cardType": "GIFT",
"status": "ADDED",
"createTime": "2019-03-07T16:38:10.000+0000",
"updateTime": "2019-03-07T16:38:10.000+0000"
},
{
"cardInstanceId": "0615edec-c19f-4466-8856-cbe8738e6bf2",
"merchantId": "418D20AC-A872-415B-ADB1-38EA90171898",
"cardName": "Delta Skymiles",
"cardNumber": "1234123412345678",
"description": "Gift card from delta",
"cardType": "GIFT",
"balance": "10.00",
"pin": "1234",
"status": "ADDED",
"createTime": "2019-03-07T16:21:50.000+0000",
"barcodeType": "UPC_A",
"backgroundColor": "FF00FF",
"updateTime": "2019-03-07T16:21:50.000+0000",
"frontImageUrl": "http://api-dev.fintiv.co:8080/image/membership/0615edec-c19f-4466-8856-cbe8738e6bf2_front.png",
"backImageUrl": "http://api-dev.fintiv.co:8080/image/membership/0615edec-c19f-4466-8856-cbe8738e6bf2_back.png"
},
{
"cardInstanceId": "796fc94f-a9db-437a-90d9-7357002632d7",
"merchantId": "418D20AC-A872-415B-ADB1-38EA90171898",
"cardName": "CNAME CNMAE ",
"cardNumber": "11111",
"description": "test gift card",
"cardType": "GIFT",
"balance": "10.00",
"status": "ADDED",
"createTime": "2019-03-07T15:42:54.000+0000",
"backgroundColor": "FF00FF",
"updateTime": "2019-03-07T15:42:54.000+0000",
"frontImageUrl": "http://api-dev.fintiv.co:8080/image/membership/796fc94f-a9db-437a-90d9-7357002632d7_front.png",
"backImageUrl": "http://api-dev.fintiv.co:8080/image/membership/796fc94f-a9db-437a-90d9-7357002632d7_back.png"
}
]
}
Supply the membership card instance ID with information to be updated and then update the membership card. Only provided information is updated.
Client logged in the service. Refer the section for registration/authentication.
HTTP Method / URL
POST / http://api-dev.fintiv.co:8080/membership/{version}/updateCard
Body parameters
| Parameters | Type | Required | Note |
|---|---|---|---|
| cardInstanceId | String | Required | Unique identifier of the membership card instance. e.g. 418D20AC-A872-415B-ADB1-38EA90171898 |
| merchantId | String | Optional | Unique identifier of the merchant who issued the membership card. e.g. 418D20AC-A872-415B-ADB1-38EA90171898 |
| cardName | String | Optional | Name of the card |
| cardNumber | String | Optional | Number of the card e.g. 208738491092 |
| description | String | Optional | Description of the membership card |
| cardType | String | Optional | Type of the card. Possible values are LOYALTY and GIFT. |
| balance | String | Optional | Remaining balance in the card if available. e.g. 10.00 |
| frontImageBase64 | byte[] | Optional | Base 64 code of the front image of the card |
| backImageBase64 | byte[] | Optional | Base 64 code of the back image of the card |
| barcodeType | String | Optional | Redeemable barcode type. Possible values are - UPC_A: 1D Product, UPC-A - UPC_E: 1D Product, UPC-3 - EAN_8: 1D Product, EAN_8 - EAN_13: 1D Product, EAN-13 - UPC_EAN_EXTENSION: 1D Product, UPC EAN Extension - CODE_39: 1D Industrial, Code-39 - CODE_93: 1D Industrial, Code-93 - CODE_128: 1D Industrial, Code-128 - CODABAR: 1D Industrial, Code-128 - ITF: 1D Industrial, ITF - RSS_14: 1D Industrial, RSS-14 - RSS_EXPANDED: 1D Industrial, RSS-Expanded - QR_CODE: 2D, QR Code - DATA_MATRIX: 2D, Data Matrix - AZTEC: 2D, Aztec - PDF_417: 2D, PDF-417 - MAXICODE: 2D, MaxiCode - QRCODE: Deprecated. QR Code for backward compatibility - None: No barcode selected. - UNKNOWN: Unknown |
| backgroundColor | String | Optional | HTML color code. e.g. #FFFFFF |
Example request
curl -X POST "http://api-dev.fintiv.co:8080/membership/v2/updateCard"
-H "accept: application/json;charset=UTF-8"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d
‘{"card":
{"cardInstanceId": "852c8e1d-cd6c-4ecf-8c2b-deb64be16561",
"cardName": "Custom Card",
"cardNumber":"11111",
"cardType":"LOYALTY",
"balance":"20.00",
"description":"Popular card",
"frontImageBase64": "iVBORw0KGgoAAAANSUhEUgAAALQAAAArCAYAAADR/aKkAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAABowSURBVHja7F0HeBXVtp7T0gtNQ4siLUBCkI4QadKkiSYIN7RLE1B4iqCiIAgIgiIgIBIf5YJiEJQPlHIRBKWGGojB0DsEFKmBQJJz5v173t7nrrOz5yRR0athvm9/J8zsWbPLv9b619p7BovmeVi0/B26dv/4qxyWwjSXFsWvxWQgdFLug/qvB2aLFyDrf0dAs2IlhYLbRYrOf++D2jtoLPkAj/4Hza1srFSG6W8xl3YFmO282Ph5AeAcFCf/tdwHcy6g0HG0KADtkn71P2AcVW2UrfTfai7tpMMCzD682Pk5nYM4CyVbQT0KK5hlQ2AjxSqBx8WNAS3C4/0RoJYVzaWYR0sB5er55Ol6AXh9fuuaejkKaDYRDhRfFD8OahvvfDYfEE2iHnohBrPs0Ry8UO8mBtwpGQUL/7f+B4DZKrXXQgzVrzFOMl1RURrNS7zlzVvoJnU1SfFVdXUzC80AHZCYmNgkIiIi0mq16j4+Pjm6rl+OjIycyycix5CgFy48W3CQsRIGwEcqDsm7CTBn83soBXH9/zDq96KtMqiN+b158+ZYXNODgoJGK6xcfiytrjBoKqpFQecy8RaaCS3TFVROU4xdrlhO5tCCcviVL18++tFHHx0kKmIgtuNnIbcy1sIGaCi2PE5C+f25R/Pj/3aQcaV07S4X5SQUxMoBrd9DC+0BOLvdXpMZKcmYaV6srGYCUJd0XU4m6BJIVR7DovAULgnQ3uibRkBttNEuNUi4Tp+srCw7HWen02kllsd4GJ9kWsd0Ymw2W745mjc5BZH1W9ujuJ8CmgE4gBSDps2YMaNeixYtmoSFhVUqUqRIJXHj1atXd964ceOHs2fPbmzSpMk6QuHulWFQZa5s/v7+nfl1B7lOMWDJJ5idkjWV4wedeChdAVKrwpq7JGuuUhIX8XiCurlUlIO6Unt2drbN5foP+HNyciyEJ+YoGqtzkOh5BFHe+JbOweb+G+0wfh0Oh1mu3FQWlZOP9uRyrdL9YnwEzWCWOZCXgG7dupWbNGnSSyVLlqzpNiVk/EJDQ+uzEh4e3g//LEGfK+pJffQaNIlxKQCPFhTJpjivArQMapdUnARIbtwo4occYk3pM2xSWliTAG2VAm4LeW6WYr4N7FlNUk82ZpHZQIsCQFtJwEhdrK+UFbEqsgA2Yv2Fm5YLlePWdDbJfKJlWT5Se/xJm3ykAM2qaI8Apny/H7nfJg2s6IOozyxz4CuvvBKdkJDw4YMPPliTjplZkbmfoo+U1tA0qhsErH4ez9BUFvrMmTOjWCH9d1y+fHnxvHnzan777bcdQS033b179xj73bhxYwf2bFyrcfHixdk4fxrl7M8///xx3759S9BgeOrUqRV++eWXRFw/iXLi9u3b+9PT0z8aN25cJQkrjq5du5Y4d+7cpMzMzP2sPu77bMGCBbVOnjw5av/+/f8k9Y35SElJeR7ejbXrONq15dixY/8jzY9FznJosgZhUCzUFeLfVj6JOrFUOVKOOlvSXIvJ5MiWwUWCJycJPJ0KC6maaDkDI7eHWggbUQq7wk26FG1wyTGGoBoAc/XRo0e/A24aRMfrzp075wEURjPOwNK7ypQpUz8gICAKNC1UGiMV+GwKS+eSeGN+qHcuw4I2RJO5N84hQGz49NNPj0cfQlJTU+eBFp2LiYnp3LBhw+kAuaVu3bovQwk+37Vr1+elS5cOr1at2vDJkycnAOjxAg8lSpQoBgDvOHTo0Hxm/OCJyiIGGzps2LAVe/bsafnVV19dE22fM2fOJz4+PuEHDx6ccuHChbOI16JiY2NnsHO3bt2awsfYGIu0tLShDz30UBzkLjh69GhqZGRklUqVKo04deqUs1y5cu/LHtpuNhKMYlCXCRdn5ZMoQJEtAUdE8VlkwiyKbIBDsuYU0EJOFvnbKXF8OaNgM5EjgtcsknGwSik26hE0ErSJQE60Q/SFegXDs7z44osvAbBBdKxgZT4EGObyQDCbjFX2kSNH2hIlUymrTRojTbGgZRT6TC9g9nDf8LzyOWOeoWgh8fHxnVetWnWDX99+7dq1dY899ti0Tz75JHbAgAGpor07d+60VK9efdzChQsf7dWrFztv7dmz5yH8HiXt3gure6lLly6z33rrra4ANBsP7cCBA30A3KjFixc/079//1T+rB2zZs3a1adPn6WI3dzUZcqUKZEPP/xwn2XLlg3Cc3byMdgG5SoDBRqMv6fK9NNqNhhM+xWUg01iEEowSohUgjjgaaRvV1CNAM47VTKoHOr6HQRM/tL9obyE8HOB0v0+0v1+5H7ahlDydzBvR6BEhzxozpIlSzoi8KtAxwlu+j2AeT5RCFqyK1eu/IUUe6jSpnScAkgbPNwsrK0lD8qhyXSLz6uFymH1YfGWAszXqcLAy5yFh9lOwczqA1Dn2D2w7MVM0pZG6d27dzKrR0FaqlSpNqAY/waYD1JFGzx4cBrBmYGZZs2atcHzDwHM+4hXte7bt28tm69NmzbVMFspVEX4FhRqsQ1Aw42E4OHRcANhLJ8JrnRj5cqVSfPnzz9O3OQdEjjSBRsDDGPGjImuWLFieFhYWFkhn8lJTk4+OHbs2BReX0yEWJ1058j5RBuAhcuv1qJFi1qsLcy1w206T5w4kfLll18mY4IuEQtnkRTLnWZ7//3360ZFRUUwGazAvf04ZMiQrbiWyZ+bRTID7hiicePGcXSM4BLXtG/f/msvAZ3LS8rLToJNAWCxsJUlrdo6yTwVKPPB6nOqoksyXBI1M86z8ZDOGwrArgGobkA+8cQTRWfOnMmC4haYhxDg5Sa49m5WjyuYYUl9fX0jwZ/XKoJy5j1E8sE4X7x48Qh/f/8q169f36nApxYSEhIqL7aYAdoiazoD+PLly2PBrTohIAmilTGx2htvvLEHgcG42bNnH+anBfVwLwmDM41F4NQKoAtWPbRJkyYarEH65s2bZyJwWEkoiwC08BCB4HANu3fv/hKsVElZTnR0tNapUycNQUQqOOBr3bp1O8DlUOvnt3bt2u61a9fuIvenTp06Gp5/E+1d1LRp0wT+bKpUvlC8uhjsMDpGEydO/JIosFNaSdOl/LOLXLNJysYU1vf48eOzihUrVlfI/+mnn96OiIh4j7Y1D9qRK+XG69PFDkMGgCtWhOnijKiTQ5WPgZzf41aKRYsWzQFYy+7du3cGrP0Fdg7eqBqMVnOaXya40uVsDjnvbiuCwLT169dP58bKxRb5AgMDs4ODg7O2bt26TzYOphZaUA5xwFVEsWI2iEWLFq0Dy7sYlnvAiBEjditWezRob2xek4BBKdWyZcuJ4KF14Q1Gksl3CDAiqGjduXPnkXnJAlCj0PGiUqotoFatWmFz584dBn4WYyYDnDIYPPEFeI0yNWvWHEeU06Af9evXr0nvg1dIgsJf5s+hgXO2tNgiW2uLAtD+GMPqoDN16TNgMD6lkwfX7Y1HK3PHJJLMUQA6R8KArgC0jdWlioF2Rfr5+VWDIRqO4HIDsbpJaONgKhux2A1QlXAV12cy+TMNY4C615mxAXXZRoJ9sUglaJxHataMQ2vCrajK1atXj1y6dGkfOFYGPY+GByM4SGjVqtUDJOByTyKtm5GRgaA4Pfn8+fMHwJMuyc9ANP00LGi8lBo0OGyHDh1eNGubXGClrQQsBl354IMPBpYtWzaG1mNtgCtMyczMvEXPlylTptO6dev6E5pitAPKUIPWA904zZ6DAKjeihUren399dd9V69e/RwCm+aNGjUqQ/i9HxkbWnxo+rBjx46dqHxY5yUJCQlX6QR667dCcYzAUucHCVaz+dy5SGbHKMAAUxhdOp/NrCS7B1bTCG7hdYPYvxFEXicBbw4Mkz+X7c4agYashaK2efLJJ4to0oYuTocEoLMvX778AwxctU8//bSetKnLbPeiKaCNTsuBBlzg1+CsceC/PapVqzYYk91x27ZtC2gdZtlee+21f5AAxp1+Onny5HyA4w0MwOMARA/w1pGgB2898sgjL7777ruTAL5bVFalSpXi5Mn/8MMPm4msAivsHnR4CmQ+idIEpR4i6ud++OGH0VCWBAzgDbrpCl6kAeS2lgK5xWjD4Bo1akwA0PshEt9Ir0dGRnaXlMoOj/QIrVOlSpXIixcvfjFw4MDxDRo06F23bt2+oDP9QYumgs+vT0pKGgf6UpoEzj50ZZYEnL7PPPNMufLly7el8tHHBNmqoa/uYhIU6tJScTYBuBvQrD4HZzYtCvAboATIGNg1BmxmJdHHzeC+19G/l4YPH84oYBYUujm8YAKRzaxpzvfff5/IAjpGTxGLPcTwMWHChKjDhw/PkahP1qRJkz5jee/mzZtPg/WPe/bZZxk1dD3//PMh8JxPqRbNrHlRDlFgIfY99thjby9cuPAILt9icRwL/uBiEtPS0tZJQPynlKIzIly46Zk9evTYpNjIYoElS4Nl+4LKAT+uIifPoUQlaZ0tW7asfPnll7fTFbZ+/folIUhZCqowBZ1Poxbwqaee6kzvT0lJ2Qi+vIJqOSzLfFjsn6iSguY8IfrRtm3bUjKAQKeivC10gIp1ROCcCJ5d2ySD414U6t+/fztp7Ndj0s8qlpithM5ZJEDL1lkG6V1RvAFaBj8DGmKHbJ7lyOIJgNt79uwZCHpQFnOx/sKFC4cZTYNB+YQBHdzXnQbFfCSDZw/B3FZD3LUGdfeDUnyG3x18rJ28XXegFBcB5P5gAikwohOmT59+APXOjRo16giUeLoqn2/3ZqFpBM0MNo/6b3MhIt/oA237AsFgaxJMBMOSxrzwwgvfc62muWiHYvXOKEOGDNmCYK4XbQgi5/o846BzDuii7UJHq8Nb/PvHH3+8q+Xel0z5qaN9+/bhDzzwQDS9H5Zvo2TNDM6empq6E1a2g6gHC14ZP1uYTHDrsAJmFwSnLw0D8BYm8mmSebESi+0Lj1UE1r4NlQ8v+AUxQKI/dKOTS1C6PHawaeXKlWsnVwK9C1RZO3jRtqqEAYL39Ty96d48BIrEzlX45ptvmrJKoJ3fcZlzibEx8NauXbtV+FkHr1wD9KPI0qVLD27YsOHa2bNnX+KAdq9lIKBn8VgnKEoRGKNotrEK3PoKrPZuRbbIPCgUHFoCdBZ5mFMEPdCk89OmTctgq2VkMFgAuYOAy73Pet68eR0ArNJsAw/kspy3FZ05jXJFnhSyVGxcAK86TetAU6svW7bsvWPHjm3dt2/fnrFjx+4gAamLpOscMTExlWX5GJgoWOSqIqJn7WH3YJIfpnXR3koUHLIcUJtkuM1vwfuTFi9efJ49Dwod3aVLl3/AOjcS9VgaCp4oHoq7UAK0kUIcOXJkO7QlSMhHvLJ70KBBO/kY+pCsiIVs0tFNAK1pni8R6PnYHlqQ1cdcBUBeLwWlmrQJShgZ16uvvpoizg8bNqw04fLZkrKygPhnlA2K3X56frMcHhE0/5u+cWGleVVM6HEAtIaUt6ab3n0BemCnZV9Vqg33RrF0mRy180DbHRDAHa8CP+4eGBhYhYAkDFYzlpVevXpp4LLfwVWtGDFixA6SP2ZJ/ZKy/MaNG3f1ptSSQgtvkyu7AGs+lFMxkfpywksdRJm0ffv2CaAEYsmZ0Q/mzRLJ5LoBDb7+JJUNOreR1KGZExt3ze5JhfVl2RadZ1108HBV1uNebE0127RPqa0uYcZjGR/WtxXrN+jIcsLXXYr0nmpbqibvtstzYYUvmdolV+7mcrJFJ4A2aAk4cgu4/DcKuhhAo17RSbiocbGxsaMpqOkBa9oU15uCjiTExcV9Ktopt7EgB29HFk9bORVy6JK5sEiGEsJzbG/durUb0MHBwfXI2Lhz2x999FEHBFwlhezMzMz0+Pj41YSS0NSVXbGf2AkQW44eParzhR4d8Yz8pse92G+t5QPMBng///zzqPDw8OanT58+yLwh5jCUURv8toc3mgFvdEyxJ0hTbGtVKmi+89Ac0CJb4CKBlkPsEVBYdPfOOARpfWWrdu7cua0IHI4D/DY/P79QWNDycPWRJvlUt7aOHz9+P0o38Ot2mLAGGKDGlO6IAxZ7ACjIkTFjxiSrvA642K0rV64cBy9zsSJWCuXC6l67du1HbhFtiL53IZDxeNa4cePqjh49+jtFoK2fPHnykiJfLIyBOyBs0KBBHK2XlJS0VIzxm2++Wad79+6TqYCIiIiKKheMMdFAf4x2i997dOhSeyzimeJvGXgZGRm/QKFjatWqNZJs5FoJHPRu2rTpF8Qw5PWan/K8181JqqVvIsxOonVbiRIlPIItdCpNaNY777zTFJbHI5B67733Xl6wYMERaUnaF8HdvxRuX35jwZhEBIuMU7EMxxxMdtU2bdqwgepA769fvz4LUvaKQZK8DqMcY3mwe0facOWU/q2RgNaBibkIquOmThUqVKjK22Ihde1ePIOVbniCgjajY4Txznjuuec28DG23L59218hI0Cxy9HlhU/f0wNz586Ps78RrMsLSZa+ffsyC9xRy/1mi1ORa9a5nHy3wWqyquTOcogCa2bRPN/SEAsNjp49e1aUE/toyBkBIvDHMHotPT09BWA+rniuU5aj2NtrU+y7ZtmKEwB14urVq+fS+8HXS/EJv7tt27bd9BqscmCPHj3Ke9l3IW8nFbv47qIPe6WFoDqKDUWGsletWrWCtIhzSM5aNGzYsBWts2PHjpV0qyqsmK9i8SRAsR/dkteiyx9VFBRB3pqbLeW4PcCMWKnAimlVTKRbS2heE9aoVFRUVHFpU76xbxWR/DO0LtzzzsTExBNih5lYKhUF9CBQ1dGuXbuGKxYIdGny5RU2DysAsNxUbKY38prz5s07AEuXTq8jiOyueEPCKo2NLm1LvbNz585vqZxixYrVnDBhQkuyV4T9OuB62RJ6S1oXAXQSpVDDhw9/lHk4ulgED7aJLghlZWX5KsbGV7ULj+7F+TOLCW10SmDOkbyim2Yo5OR52E20J5vlA6kwFqwgYn938uTJb69ZsyadDRosT+jbb7/dG9apEa2LSPVjslONpdrO0OshISEVpk2b1nro0KFrBI2YOnVq88cff7yn3AGyQcYA9Mcff9wuNDS03MGDB08sX778VGpqKgOrpXLlygFw0Q2bNGnSncrAs7fx3Dm7P+fIkSMroZgDxfXixYvXWL9+/cQlS5bMBeDTpGjdBV4XCIWtzFbH+vTps5Xw+M3NmjXbW7Ro0dpCVqtWrYawdCT6su7QoUMZsP4V+/Xr9zziA49NTCtWrFii/eedOCess8f4AfAnMTZPsKCJvVgBK2VDO8PksYGX6wEPlMlKhw4dplAlLCgQ7sWRnJys16xZk9IKOYhUfl+D3fdr+2AhCW+6NTN40aJFA8FdBqluunnz5lFYjAwAq5IcjMFCrm3evPkgriDMavjXq1evJAK4lTabLTi/csSxZcuWPpjczYK3L126dBAi+Zfy20H0o+mMGTNO8X4am382b96cyFch5bghA206LIJBBC8RbOM73+k2sW3btjMJ7w1Au2rDq8yW++XtuHjx4v+2b99+MgkIg/bs2ZP0W8FTp06dB7niGlYPMv98RP9OB0vn/loLLVxqpsPhyKIacuzYsc8qVqzINgtpgYGBlVByWQKAM3XWrFnD+cCKvdCuXbt2pYMPzYiOjh5JHy7LuXXr1mGA6gYA7t4yCetGP85i1fJ+U8N9nDlz5nWA+TBZlTPc2+uvv94X9GAuQF1V2mEXhGfXVuWiWRaE5JgNugAvsxtgHhAbG5uQH1BfvXp1CcA8nq5IiqDxdzhcsrsujIdVwRGNtXkfH5+75G2VG/Hx8e8iUHmVvSsncyV2/fz585NjYmJaggakC87KC6MeGXC9/9q9e/cwVlfFt44ePfrBqFGj+ly5cmULPQ9Xn033HSA4/SUv7oY2psJtxcfFxc0jGYw7XNFuITg8DyrRie3PVvVH0b/TmZmZJyiH5rIypkyZsgs0KI5tQje7n22wOXXq1OutW7ceyu/LJNsIMn4nvuqRt/1v4ND3gIsXaBmTvjwqf9bK46ukc+bMaYsgqCzPK55atWrVJr4XmL6DJ7/D596pxngwePRDbF0ek3194cKFazZs2HBVWkWi+Ui6F8DIy4KnNgZ3j+avExkWFHThdFpaWjKuHZeW6V2a52cIPN4phCJFs6XuIkWKhPOPsBhvv4BmHGB58okTJx4lAYyumbwr2b9//3LgwzEIoBlN0ZkscPbNkL9X7DYjgY/VZKxthAKyDAejYkEwCPV69+79Op28Ro0a1WcpcpTrXDnuiv5Caf82XwFCPwsMaBrl2xTpMdXnCeT8ofymNp14+oa1Xcv9ySh5bV71qpKsdHQDkk6AmyMV+Us8qre+zT6Q4pRkORWyHFrub1JYvIyN/N0JldGgm/2Ndx8HDBjA3tAZQycPQfSjHNAZhD8b/UXs8bcBNPpZIA5NP6lKJz9H2lDi7aMu9Es6Mgjp125sJkoh58LNPtznlPLRZl/ecWrmX9ik2Ry6jG/WL5U8WRZVCKsil+2x0YYslVvJOFsJ0O1k05GhcKBedxTu9y7xirkoR2E87Irkt9kavdevDNHJ/u6774xf8FQV6L3J0PLYc5DXF4+U/8uAl/bkaPn7GqZZGymozWRomvlXPs3G26F5fpHIhiD9ruI7HHR100X7W9g+pKla+jYF1MaNG9k2yzy/BYd6HtZB/JvJK8j9Zkd+ZKhk/dr25KNtQo7+a+/30kcLt8AGv/bz81NZaA8wy+Nf2AFtng/CACFo0/NTz+z4rffnV8a9kOVNXn7lFBBk1KMZLy4g0FQBOosCujADuUCALqzu6088aBrVwufg4p07d7aK63wXIM3i3J8nreD/DcH9449bH6AZD9U3/HIU2ZNCj2j7fez811poF+HJLi13WtF1H8j3LfRfbV4sBcjC3Af1fUD/peamUPzHmb/1+D8BBgDOFJzndzJ3qQAAAABJRU5ErkJggg==" }}’
Returns result of the request.
Example response
{
"result": {
"code": 0
}
}
Supply the membership card instance ID and then end user removes the registered card from his/her wallet.
Client logged in the service. Refer the section for registration/authentication.
HTTP Method / URL
POST / http://api-dev.fintiv.co:8080/membership/{version}/removeCard
Body parameters
| Parameters | Type | Required | Note |
|---|---|---|---|
| cardInstanceId | String | Required | Unique identifier of the membership card instance |
Example request
curl -X POST "http://api-dev.fintiv.co:8080/membership/v2/removeCard"
-H "accept: application/json;charset=UTF-8"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{"cardInstanceId":"852c8e1d-cd6c-4ecf-8c2b-deb64be16561"}’
Returns result of the request.
Example response
{
"result": {
"code": 0
}
}
Client reports membership card events to log their history in the server.
Client logged in the service. Refer the section for registration/authentication.
HTTP Method / URL
POST / http://api-dev.fintiv.co:8080/membership/{version}/reportCardEvent
Body parameters
| Parameters | Type | Required | Note |
|---|---|---|---|
| cardInstanceId | String | Required | Unique identifier of the membership card instance |
| eventTime | Date | Optional | Date and time the event occurred. If not provided, current system date and time is updated. Format is yyyy-MM-dd’T’HH:mm:ss.SZ e.g. “2019-02-08T14:23:35.443-0500” yyyy: Year, e.g. 1996 <br>MM: Month in year, e.g. 07 dd: day in month, e.g. 10 HH:hour in day(0-23), e.g.0 mm:Minute in hour, e.g. 30 ss: Second in minute, e.g. 50 S: Millisecond in the minute, e.g. 443 Z: Timezone offset in hours(RFC 822 pattern), e.g. -0800 |
Example request
curl -X POST "http://api-dev.fintiv.co:8080/membership/v2/reportCardEvent"
-H "accept: application/json;charset=UTF-8"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{"cardInstanceId":"0615edec-c19f-4466-8856-cbe8738e6bf2",
"eventTime":"2019-02-08T14:23:35.443-0500"}’
Returns result of the request.
Example response
{
"result": {
"code": 0
}
}
Retrieve list of merchants which provides membership service. Returns detail of merchant and sorted by the name of merchants.
Client logged in the service. Refer the section for registration/authentication.
HTTP Method / URL
POST / http://api-dev.fintiv.co:8080/membership/{version}/getMerchants
Body parameters
None
Example request
curl -X POST "http://10.128.6.27:24025/corpay/ci/membership/v2/getMerchants"
-H "accept: application/json;charset=UTF-8"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{}’
Returns list of merchant detail.
Example response
{
"result": {
"code": 0
},
"merchants": [
{
"merchantId": "3D4F43E3-5B0A-462E-8A1D-305ED8EE045D",
"walletId": "JANUS",
"serviceId": 10518,
"merchantName": "Hilton Honors",
"customerCareInfo": "Best price. Price match guarantee.\nFin a lower rate",
"updateDtim": "2019-03-13T14:03:16.000+0000",
"phoneNumber": "000-000-0001",
"serviceHours": "24 hours",
"websiteUrl": "https://www3.hilton.com/en/index.html?msclkid=b8af23ae9a551a6d231e7f27970c3f07",
"barcodeType": "QR_CODE",
"nfcService": "N",
"showInCatalog": "N",
"merchantBackgroundImageUrl": "http://api-dev.fintiv.co:8080/image/membership/3D4F43E3-5B0A-462E-8A1D-305ED8EE045D_bg_xhdpi.png",
"merchantImageUrl": "http://api-dev.fintiv.co:8080/image/membership/3D4F43E3-5B0A-462E-8A1D-305ED8EE045D_icon_xhdpi.png"
},
{
"merchantId": "1CD1179F-D64B-43E3-B066-19CF773BBABF",
"walletId": "JANUS",
"serviceId": 10518,
"merchantName": "Marriott membership",
"updateDtim": "2018-11-30T21:31:53.000+0000",
"barcodeType": "QR_CODE",
"nfcService": "N",
"showInCatalog": "N",
"merchantBackgroundImageUrl": "http://api-dev.fintiv.co:8080/image/membership/1CD1179F-D64B-43E3-B066-19CF773BBABF_bg_xhdpi.png",
"merchantImageUrl": "http://api-dev.fintiv.co:8080/image/membership/1CD1179F-D64B-43E3-B066-19CF773BBABF_icon_xhdpi.png"
}
]
}