digital-payments-sdk
Version:
The APIs detailed within this SDK will enable Shell's Fleet Solutions Customers to digitalize Shell Card/s and use them to pay to refuel their vehicles at Shell Stations.
47 lines (46 loc) • 2.73 kB
TypeScript
/**
* Shell SmartPay APILib
*
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { ApiResponse, RequestOptions } from '../core';
import { AccessTokenResponse } from '../models/accessTokenResponse';
import { CancelFuelingRequest } from '../models/cancelFuelingRequest';
import { FinaliseFuelingRequest } from '../models/finaliseFuelingRequest';
import { BaseController } from './baseController';
export declare class PartnerNotificationController extends BaseController {
/**
* To access the Partner’s endpoints, for sending callback messages, Shell will need to connect to the
* Partner API end points. It is recemmended that the partner offers OAuth 2.0 as a standard for call
* back APIs and will require the OAuth 2.0 token for authentication. Note this needs to be implemented
* over HTTPS
*
* @param grantType In OAuth 2.0, the term grant typee refers to the way an application gets an access
* token. OAuth 2.0 defines several grant types, including the authorization code flow.
* @param clientId After registering your app, you will receive a client ID and a client secret. The
* client ID is considered public information, and is used to build login URLs, or
* included in Javascript source code on a page.
* @param clientSecret After registering your app, you will receive a client ID and a client secret. The
* client ID is considered public information, and is used to build login URLs, or
* included in Javascript source code on a page. The client secret must be kept
* confidential.
* @return Response from the API call
*/
partnerToken(grantType: string, clientId: string, clientSecret: string, requestOptions?: RequestOptions): Promise<ApiResponse<AccessTokenResponse>>;
/**
* Enables Shell to inform partner of the successful completion of a transaction. Note this needs to be
* implemented over HTTPS
*
* @param body
* @return Response from the API call
*/
finaliseFueling(body?: FinaliseFuelingRequest, requestOptions?: RequestOptions): Promise<ApiResponse<void>>;
/**
* Enables Shell to inform partner that a Mobile Payment transaction has been cancelled by Shell as an
* error/issue occured. Note this needs to be implemented over HTTPS
*
* @param body
* @return Response from the API call
*/
cancelFueling(body?: CancelFuelingRequest, requestOptions?: RequestOptions): Promise<ApiResponse<void>>;
}