Wallets API
Overview

Wallets API


Version: 2.0.0

The Wallets API is a collection of methods used to perform financial deposits into a user account. Currently this service only processes credit and debit card payments but will be expanded in future to support many other methods, e.g. PayPal.
Summary
Method Name Description Resource
getPaymentMethods Retrieves a customer's registered methods of payment (for example, credit and debits cards). https://sandbox.whapi.local/v2/wallets/wallet/paymentmethods
makeTransaction This method is used to allow the customer to deposit funds into their account. https://sandbox.whapi.local/v2/wallets/wallet/transaction
Resources Expand All Collapse All
getPaymentMethods()
Retrieves a customer's registered methods of payment (for example, credit and debits cards).
Request Example
get https://sandbox.whapi.local/v2/wallets/wallet/paymentmethods?fields=&include=FieldName&exclude= HTTP/1.1
Host: sandbox.whapi.com
Accept: application/json
apiKey: l7xxa54460c573b5497c9b24b505xxxxxxxx
apiSecret: 355b1e522c544222ab4ff318xxxxxxxx
apiTicket: TGT-1920-Cl7l4e0hzFWK9aoKeiggDexuWcmAMf9brh6IFpVdsQxxxxxxxx-brsux349

Request Parameters
header parameters
Name Description
apiKey*
apiSecret*
apiTicket*
query parameters
Name Description
fields
include
exclude
Responses Expand All Collapse All
makeTransaction()
This method is used to allow the customer to deposit funds into their account.
Request Example
post https://sandbox.whapi.local/v2/wallets/wallet/transaction?fields=&include=FieldName&exclude= HTTP/1.1
Host: sandbox.whapi.com
Accept: application/json
apiKey: l7xxa54460c573b5497c9b24b505xxxxxxxx
apiSecret: 355b1e522c544222ab4ff318xxxxxxxx
apiTicket: TGT-1920-Cl7l4e0hzFWK9aoKeiggDexuWcmAMf9brh6IFpVdsQxxxxxxxx-brsux349

Payload:     
Request Parameters
header parameters
Name Description
apiKey*
apiSecret*
apiTicket*
body parameters
Name Description
makeTransaction *
query parameters
Name Description
fields
include
exclude
Responses Expand All Collapse All
HEAD and OPTIONS
You can call the following idempotent REST methods on all version 2 APIs:

HEAD

Asks for the response identical to the one that would correspond to a GET request, but without the response body. This is useful for retrieving meta-information written in response headers, without having to transport the entire content. The metainformation contained in the HTTP headers in response to a HEAD request is identical to the information sent in response to a GET request. This method is often used for testing hypertext links for validity, accessibility, and recent modification. The response to a HEAD request may be cacheable in the sense that the information contained in the response can be used to update a previously cached entity from that resource. If the new field values indicate that the cached entity differs from the current entity (as would be indicated by a change in Content-Length, Content-MD5, ETag or Last-Modified), then the cache treats the cache entry as stale.

OPTIONS

The OPTIONS method represents a request for information about the communication options available on the request/response chain identified by the Request-URI. This method allows you to determine the options and/or requirements associated with a resource without implying a resource action or initiating a resource retrieval. Responses to this method are not cacheable. The response includes any header fields that indicate optional features. The response body also includes information about the communication options.



Copyright (c) WHG (International) Limited 2016
Generated Date: 2020-08-07T12:56:50.340+01:00
Use of this document is subject to the William Hill Partner Developer Portal Terms and Conditions.