The Wallet Engine APIs

Download OpenAPI specification:Download

Authentication

OAuth2

Access to transactions resources is restricted to authenticated users. The authentication process follows the Authorization Code flow.

Security scheme type: OAuth2
authorizationCode OAuth Flow
Authorization URL: /v1/auth
Token URL: /v1/token
Scopes:
  • read -

    Grants read access

  • write -

    Grants write access

Card

Update card access status

Update card access status.

Authorizations:
OAuth2 (read)

Responses

200

Request executed successfully.

400

Returned when the request body is malformatted or does not match the expected request.

401

Returned when the request does not contains the user's credentials.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource is not found.

500

Returned when an unexpected error occured on the server side.

post /v1/card/access_status
https://api.walletengine.io/v1/card/access_status

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Success": true,
  • "ErrorCode": "string",
  • "ErrorMessage": "string"
}

Update card status

Update Card status.

Authorizations:
OAuth2 (read)

Responses

200

Request executed successfully.

400

Returned when the request body is malformatted or does not match the expected request.

401

Returned when the request does not contains the user's credentials.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource is not found.

500

Returned when an unexpected error occured on the server side.

post /v1/card/status
https://api.walletengine.io/v1/card/status

Response samples

Content type
application/json
Copy
Expand all Collapse all
null

Retrieve card information

Retrieves all data from a card, selected by the card_token you supplied.

Authorizations:
OAuth2 (read)
path Parameters
CardToken
required
string

CardToken is the identifier to get the card information.

Responses

200

Request executed successfully.

400

Returned when the request body is malformatted or does not match the expected request.

401

Returned when the request does not contains the user's credentials.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource is not found.

500

Returned when an unexpected error occured on the server side.

get /v1/card/{CardToken}
https://api.walletengine.io/v1/card/{CardToken}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "ID": "string",
  • "Account": "string",
  • "OwnerName": "string",
  • "ContactNumber": "string",
  • "FirstName": "string",
  • "LastName": "string",
  • "Expiry": "2019-09-19T11:07:43Z",
  • "Status": "UnknownCardStatus",
  • "AccessStatus": "UnknownCardAccessStatus"
}

Statement

Retrieve a statement

GetStatement retrieves a specific statement, specified by its ID.

Authorizations:
OAuth2 (read)
path Parameters
ID
required
string

ID is the unique identifier of the statement

Responses

200

Request executed successfully.

400

Returned when the request body is malformatted or does not match the expected request.

401

Returned when the request does not contains the user's credentials.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource is not found.

500

Returned when an unexpected error occured on the server side.

get /v1/statements/{ID}
https://api.walletengine.io/v1/statements/{ID}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "ID": "string",
  • "Status": "UnknownStatus",
  • "Date": "string",
  • "Description": "string",
  • "Amount":
    {
    },
  • "Balance":
    {
    }
}

ATM

Retrieve all available ATMs

Retrieves information regarding all the available ATMs.

Authorizations:
OAuth2 (read)

Responses

200

Request executed successfully.

400

Returned when the request body is malformatted or does not match the expected request.

401

Returned when the request does not contains the user's credentials.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource is not found.

500

Returned when an unexpected error occured on the server side.

get /v1/atms
https://api.walletengine.io/v1/atms

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Result":
    [
    ]
}

Create an ATM

Creates a new ATM and returns its id.

Authorizations:
OAuth2 (write)
Request Body schema: application/json
BankID
string (BankID is the bank identifier that owned the ATM)
Name
string

BankID is the identifier of the bank associated with the ATM.

Address
object (Address hold all details about Address)
Location
object (typesLocation)

Location is An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Values must be within normalized ranges. Refer to https://godoc.org/google.golang.org/genproto/googleapis/type/latlng.

Description
string

Description is the ATM's description.

Metadata
string

Metadata is the ATM's metadata.

Responses

200

A successful response.

201

Transaction created successfully.

400

Returned when the request body is malformatted or does not match the expected request.

401

Returned when the request does not contains the user's credentials.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource is not found.

500

Returned when an unexpected error occured on the server side.

post /v1/atms
https://api.walletengine.io/v1/atms

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "BankID": "string",
  • "Name": "string",
  • "Address":
    {
    },
  • "Location":
    {
    },
  • "Description": "string",
  • "Metadata": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "ATM_ID": "string"
}

Retrieve an ATM

Retrieves information regarding a specific ATM, selected by the supplied ID.

Authorizations:
OAuth2 (read)
path Parameters
ATM_ID
required
string

ATM_ID is a unique identifier of the ATM.

Responses

200

Request executed successfully.

400

Returned when the request body is malformatted or does not match the expected request.

401

Returned when the request does not contains the user's credentials.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource is not found.

500

Returned when an unexpected error occured on the server side.

get /v1/atms/{ATM_ID}
https://api.walletengine.io/v1/atms/{ATM_ID}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "ID": "string",
  • "BankID": "string",
  • "Name": "string",
  • "Address":
    {
    },
  • "Location":
    {
    },
  • "Description": "string",
  • "Metadata": "string"
}

Profile

Query profiles

Returns the profile and associated accounts

Authorizations:
OAuth2 (read)
query Parameters
ProfileID
string

Responses

200

Request executed successfully.

400

Returned when the request body is malformatted or does not match the expected request.

401

Returned when the request does not contains the user's credentials.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource is not found.

500

Returned when an unexpected error occured on the server side.

get /v1/profiles
https://api.walletengine.io/v1/profiles

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Profile":
    {
    },
  • "Accounts":
    [
    ]
}

Query cards

Returns an array of ProfileCard associated with the account for the profile based on profile identifier

Authorizations:
OAuth2 (read)
query Parameters
ProfileID
string

Responses

200

Request executed successfully.

400

Returned when the request body is malformatted or does not match the expected request.

401

Returned when the request does not contains the user's credentials.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource is not found.

500

Returned when an unexpected error occured on the server side.

get /v1/profiles/card
https://api.walletengine.io/v1/profiles/card

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Cards":
    [
    ]
}

Authorization

Retrieve an authorization code

First you need to retrieve an authorization code.

query Parameters
ClientID
string

ClientID is the identifier provided during the registration process.

RedirectURI
string

RedirectURI must match one of the URLs provided during the registration process.

Responses

200

Request executed successfully.

400

Returned when the request body is malformatted or does not match the expected request.

401

Returned when the request does not contains the user's credentials.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource is not found.

500

Returned when an unexpected error occured on the server side.

get /v1/auth
https://api.walletengine.io/v1/auth

Response samples

Content type
application/json
Copy
Expand all Collapse all
{ }

Create an access token

Then you can exchange the authorization code with an access token. This endpoint is also used to refresh your tokens.

Request Body schema: application/json
GrantType
string (authGrantType)
Default: "UnknownGrantType"
Enum: "UnknownGrantType" "AuthorizationCode" "RefreshToken"

GrantType defines the grant type when requesting a token.

  • AuthorizationCode: GrantType_AuthorizationCode is the grant type used to exchange an authorization code with an access token.
  • RefreshToken: GrantType_RefreshToken is the grant type used to refresh an access token.
Code
string

Code is the authorization code previously received from the authorization server.

RedirectURI
string

RedirectURI must match RedirectURI provided for the autorization code request. Required only when GrantType is equal to "authorization_code".

RefreshToken
string (RefreshToken is the refresh token previously issued to the client. Required only when GrantType is equal to "refresh_token")

Responses

200

A successful response.

201

Request executed successfully.

400

Returned when the request body is malformatted or does not match the expected request.

401

Returned when the request does not contains the user's credentials.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource is not found.

500

Returned when an unexpected error occured on the server side.

post /v1/token
https://api.walletengine.io/v1/token

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "GrantType": "UnknownGrantType",
  • "Code": "string",
  • "RedirectURI": "string",
  • "RefreshToken": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "AccessToken": "string",
  • "TokenType": "string",
  • "ExpiresIn": 0,
  • "RefreshToken": "string"
}

Account

List all accounts

Returns a list containing up to 20 accounts. next_starting_index can be used for pagination.

Authorizations:
OAuth2 (read)
query Parameters
NextStartingIndex
string

NextStartingIndex is a cursor for pagination. It's an AccountID that defines the current place in the total list of Accounts.

Responses

200

Request executed successfully.

400

Returned when the request body is malformatted or does not match the expected request.

401

Returned when the request does not contains the user's credentials.

403

Returned when the user does not have permission to access the resource.

500

Returned when an unexpected error occured on the server side.

get /v1/accounts
https://api.walletengine.io/v1/accounts

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Result":
    [
    ]