Stored Payment Options

When retrieving a customer, the GetWallet endpoint will contain any saved payment options for that customer. Within it, you will find a collection of credit cards. Below is a sample response snippet of the GetWallet endpoint.

HTTP Request

GET /rest/customers/[email protected]/wallet HTTP/1.1
Content-Type: application/json; charset=utf-8
UserName: UserName
Password: Password
CustomerToken: 3fbjh0KafQ4S5id-4aHrNvtCYlPD3bzLWJ2rWq9HiBvvyCCvQV8czUHfuxtrmtalUFKLy+H+HT8lN1Hh7e8LY4IViuGZdiOmlwZ8y5R-uFcmHX2AfUOiPVihQk28vVGFOXDAvlJQ2V++wOhQ22koAjt-mOdZWkX-AC6d4KGwlJ10OhO7nc699NA+SxrG7OHE460wNCNivZvKtSBbbpphfR0pGf3mIx+nXoyrF6sLhVIpJcHMjCqo1-EEvTZzGO6i5gz3JEsBdITjXLz5a4KyCkLNfmOyaRahqzatH43p3jH7eCJtPxNyPWc7V7JxqBCxBNDsniX5u7J+-Dg8ZSOiQ1Zem4LH9TT6H2u7KFdiYuVHGlGNsrrV+mJWocuSvwUvstU3MXL1-GoXlOCuMHCYFb33x34q6VUE27tz9qh1AUc-Oisln8jvb97EPUoKwiiF9h7LVRPr9Lp8eYDRFuJK3pqcHObJo6CNNyIpKxykZ4JqPod3FCL2Bbs6NWze58Wy4niAqYSxaSFupxYcomzXIP0m9+A3b8Nm0OySmJTUknwc9Ad4Z+jN4jyFXNSLSj+36Skura15YspwQGIFk9GvRC-2oEoovfsM4RK5SKFYMei7fpx+X34VCNPzFFtxIbPWKk52e-J2uHhMzGK4iyJBeNa8XMHhc06kAGX6VWqnEK5f33Ev4YNrUCMFZBVz1wTR
Host: sandbox.api.gnsvc.com
Accept-Encoding: gzip, deflate
AdvancedErrorCodes: True

Response

Add Payment Option

In order to associate a payment option with a customer, the AddPaymentOption endpoint will need to be invoked. Below is a sample request snippet of the AddPaymentOption endpoint.

HTTP Request

POST /rest/customers/[email protected]/wallet HTTP/1.1
Content-Type: application/json; charset=utf-8
UserName: UserName
Password: Password
CustomerToken: 3fbjh0KafQ4S5id-4aHrNvtCYlPD3bzLWJ2rWq9HiBvvyCCvQV8czUHfuxtrmtalUFKLy+H+HT8lN1Hh7e8LY4IViuGZdiOmlwZ8y5R-uFcmHX2AfUOiPVihQk28vVGFOXDAvlJQ2V++wOhQ22koAjt-mOdZWkX-AC6d4KGwlJ10OhO7nc699NA+SxrG7OHE460wNCNivZvKtSBbbpphfR0pGf3mIx+nXoyrF6sLhVIpJcHMjCqo1-EEvTZzGO6i5gz3JEsBdITjXLz5a4KyCkLNfmOyaRahqzatH43p3jH7eCJtPxNyPWc7V7JxqBCxBNDsniX5u7J+-Dg8ZSOiQ1Zem4LH9TT6H2u7KFdiYuVHGlGNsrrV+mJWocuSvwUvstU3MXL1-GoXlOCuMHCYFb33x34q6VUE27tz9qh1AUc-Oisln8jvb97EPUoKwiiF9h7LVRPr9Lp8eYDRFuJK3pqcHObJo6CNNyIpKxykZ4JqPod3FCL2Bbs6NWze58Wy4niAqYSxaSFupxYcomzXIP0m9+A3b8Nm0OySmJTUknwc9Ad4Z+jN4jyFXNSLSj+36Skura15YspwQGIFk9GvRC-2oEoovfsM4RK5SKFYMei7fpx+X34VCNPzFFtxIbPWKk52e-J2uHhMzGK4iyJBeNa8XMHhc06kAGX6VWqnEK5f33Ev4YNrUCMFZBVz1wTR
Host: sandbox.api.gnsvc.com
Accept-Encoding: gzip, deflate
AdvancedErrorCodes: True

Body

Accepted Credit Card Types

When adding a credit card payment option you will have to supply a credit card type. Please use an applicable one from the list above.

Add a Gift Card

You may also use this endpoint to add a gift card to your customer account. Note that this workflow is valid only for registered customers - using gift cards with guest accounts is done at the point of making a reservation. The only required field, besides the type, is the issued gift card's number.

HTTP Request

POST /rest/customers/[email protected]/wallet HTTP/1.1
Content-Type: application/json; charset=utf-8
UserName: UserName
Password: Password
CustomerToken: 3fbjh0KafQ4S5id-4aHrNvtCYlPD3bzLWJ2rWq9HiBvvyCCvQV8czUHfuxtrmtalUFKLy+H+HT8lN1Hh7e8LY4IViuGZdiOmlwZ8y5R-uFcmHX2AfUOiPVihQk28vVGFOXDAvlJQ2V++wOhQ22koAjt-mOdZWkX-AC6d4KGwlJ10OhO7nc699NA+SxrG7OHE460wNCNivZvKtSBbbpphfR0pGf3mIx+nXoyrF6sLhVIpJcHMjCqo1-EEvTZzGO6i5gz3JEsBdITjXLz5a4KyCkLNfmOyaRahqzatH43p3jH7eCJtPxNyPWc7V7JxqBCxBNDsniX5u7J+-Dg8ZSOiQ1Zem4LH9TT6H2u7KFdiYuVHGlGNsrrV+mJWocuSvwUvstU3MXL1-GoXlOCuMHCYFb33x34q6VUE27tz9qh1AUc-Oisln8jvb97EPUoKwiiF9h7LVRPr9Lp8eYDRFuJK3pqcHObJo6CNNyIpKxykZ4JqPod3FCL2Bbs6NWze58Wy4niAqYSxaSFupxYcomzXIP0m9+A3b8Nm0OySmJTUknwc9Ad4Z+jN4jyFXNSLSj+36Skura15YspwQGIFk9GvRC-2oEoovfsM4RK5SKFYMei7fpx+X34VCNPzFFtxIbPWKk52e-J2uHhMzGK4iyJBeNa8XMHhc06kAGX6VWqnEK5f33Ev4YNrUCMFZBVz1wTR
Host: sandbox.api.gnsvc.com
Accept-Encoding: gzip, deflate
AdvancedErrorCodes: True

Body

Set Credit Card As Primary

Any credit card marked as default, is to be used as the primary credit card when purchasing. The first credit card added to the wallet is marked as 'default'. Any subsequent credit cards added will need to invoke the SetCreditCardAsPrimary endpoint. Below is a sample request snippet of the SetCreditCardAsPrimary endpoint.

HTTP Request

POST /rest/customers/[email protected]/wallet/creditcard/setprimary HTTP/1.1
Content-Type: application/json; charset=utf-8
UserName: UserName
Password: Password
CustomerToken: 3fbjh0KafQ4S5id-4aHrNvtCYlPD3bzLWJ2rWq9HiBvvyCCvQV8czUHfuxtrmtalUFKLy+H+HT8lN1Hh7e8LY4IViuGZdiOmlwZ8y5R-uFcmHX2AfUOiPVihQk28vVGFOXDAvlJQ2V++wOhQ22koAjt-mOdZWkX-AC6d4KGwlJ10OhO7nc699NA+SxrG7OHE460wNCNivZvKtSBbbpphfR0pGf3mIx+nXoyrF6sLhVIpJcHMjCqo1-EEvTZzGO6i5gz3JEsBdITjXLz5a4KyCkLNfmOyaRahqzatH43p3jH7eCJtPxNyPWc7V7JxqBCxBNDsniX5u7J+-Dg8ZSOiQ1Zem4LH9TT6H2u7KFdiYuVHGlGNsrrV+mJWocuSvwUvstU3MXL1-GoXlOCuMHCYFb33x34q6VUE27tz9qh1AUc-Oisln8jvb97EPUoKwiiF9h7LVRPr9Lp8eYDRFuJK3pqcHObJo6CNNyIpKxykZ4JqPod3FCL2Bbs6NWze58Wy4niAqYSxaSFupxYcomzXIP0m9+A3b8Nm0OySmJTUknwc9Ad4Z+jN4jyFXNSLSj+36Skura15YspwQGIFk9GvRC-2oEoovfsM4RK5SKFYMei7fpx+X34VCNPzFFtxIbPWKk52e-J2uHhMzGK4iyJBeNa8XMHhc06kAGX6VWqnEK5f33Ev4YNrUCMFZBVz1wTR
Host: sandbox.api.gnsvc.com
Accept-Encoding: gzip, deflate
AdvancedErrorCodes: True

Body

Remove Payment Option

A customer may request that a payment option be removed from their wallet. In order to do so, invoke the RemovePaymentOption endpoint. Below is a sample request snippet of the RemovePaymentOption endpoint.

HTTP Request

DELETE /rest/customers/[email protected]/wallet HTTP/1.1
Content-Type: application/json; charset=utf-8
UserName: UserName
Password: Password
CustomerToken: 3fbjh0KafQ4S5id-4aHrNvtCYlPD3bzLWJ2rWq9HiBvvyCCvQV8czUHfuxtrmtalUFKLy+H+HT8lN1Hh7e8LY4IViuGZdiOmlwZ8y5R-uFcmHX2AfUOiPVihQk28vVGFOXDAvlJQ2V++wOhQ22koAjt-mOdZWkX-AC6d4KGwlJ10OhO7nc699NA+SxrG7OHE460wNCNivZvKtSBbbpphfR0pGf3mIx+nXoyrF6sLhVIpJcHMjCqo1-EEvTZzGO6i5gz3JEsBdITjXLz5a4KyCkLNfmOyaRahqzatH43p3jH7eCJtPxNyPWc7V7JxqBCxBNDsniX5u7J+-Dg8ZSOiQ1Zem4LH9TT6H2u7KFdiYuVHGlGNsrrV+mJWocuSvwUvstU3MXL1-GoXlOCuMHCYFb33x34q6VUE27tz9qh1AUc-Oisln8jvb97EPUoKwiiF9h7LVRPr9Lp8eYDRFuJK3pqcHObJo6CNNyIpKxykZ4JqPod3FCL2Bbs6NWze58Wy4niAqYSxaSFupxYcomzXIP0m9+A3b8Nm0OySmJTUknwc9Ad4Z+jN4jyFXNSLSj+36Skura15YspwQGIFk9GvRC-2oEoovfsM4RK5SKFYMei7fpx+X34VCNPzFFtxIbPWKk52e-J2uHhMzGK4iyJBeNa8XMHhc06kAGX6VWqnEK5f33Ev4YNrUCMFZBVz1wTR
Host: sandbox.api.gnsvc.com
Accept-Encoding: gzip, deflate
AdvancedErrorCodes: True

Body