Skip to content

MvisaApi.md

Latest commit

 

History

History
338 lines (239 loc) · 12.8 KB

MvisaApi.md

File metadata and controls

338 lines (239 loc) · 12.8 KB

MvisaApi

All URIs are relative to https://sandbox.api.visa.com

Method HTTP request Description
cashInPushPayments POST /visadirect/mvisa/v1/cashinpushpayments CashInPushPayments POST
cashInPushPaymentsGet GET /visadirect/mvisa/v1/cashinpushpayments/{statusIdentifier} GET /visadirect/mvisa/v1/CashInPushPayments/{statusIdentifier}
cashOutPaymentsGet GET /visadirect/mvisa/v1/cashoutpushpayments/{statusIdentifier} GET /visadirect/mvisa/v1/CashOutPushPayments/{statusIdentifier}
cashOutPushPaymentsPost POST /visadirect/mvisa/v1/cashoutpushpayments CashOutPushPayments POST
merchantPushPaymentGet GET /visadirect/mvisa/v1/merchantpushpayments/{statusIdentifier} GET /visadirect/mvisa/v1/MerchantPushPayments/{statusIdentifier}
merchantPushPaymentsPost POST /visadirect/mvisa/v1/merchantpushpayments MerchantPushPayments POST

cashInPushPayments

CashInPushPaymentsPOSTResponse cashInPushPayments(cashInPushPaymentsPOSTPayload)

CashInPushPayments POST

Example

// Import classes:
//import com.visa.developer.sample.mvisa.ApiClient;
//import com.visa.developer.sample.mvisa.ApiException;
//import com.visa.developer.sample.mvisa.Configuration;
//import com.visa.developer.sample.mvisa.auth.*;
//import com.visa.developer.sample.mvisa.api.MvisaApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: mutualAuth
HttpBasicAuth mutualAuth = (HttpBasicAuth) defaultClient.getAuthentication("mutualAuth");
mutualAuth.setUsername("YOUR USERNAME");
mutualAuth.setPassword("YOUR PASSWORD");

MvisaApi apiInstance = new MvisaApi();
CashInPushPaymentsPOSTPayload cashInPushPaymentsPOSTPayload = new CashInPushPaymentsPOSTPayload(); // CashInPushPaymentsPOSTPayload | Resource body for CashInPushPayments POST
try {
    CashInPushPaymentsPOSTResponse result = apiInstance.cashInPushPayments(cashInPushPaymentsPOSTPayload);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MvisaApi#cashInPushPayments");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
cashInPushPaymentsPOSTPayload CashInPushPaymentsPOSTPayload Resource body for CashInPushPayments POST

Return type

CashInPushPaymentsPOSTResponse

Authorization

mutualAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

cashInPushPaymentsGet

CashInPushPaymentsGetGETResponse cashInPushPaymentsGet(statusIdentifier)

GET /visadirect/mvisa/v1/CashInPushPayments/{statusIdentifier}

Example

// Import classes:
//import com.visa.developer.sample.mvisa.ApiClient;
//import com.visa.developer.sample.mvisa.ApiException;
//import com.visa.developer.sample.mvisa.Configuration;
//import com.visa.developer.sample.mvisa.auth.*;
//import com.visa.developer.sample.mvisa.api.MvisaApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: mutualAuth
HttpBasicAuth mutualAuth = (HttpBasicAuth) defaultClient.getAuthentication("mutualAuth");
mutualAuth.setUsername("YOUR USERNAME");
mutualAuth.setPassword("YOUR PASSWORD");

MvisaApi apiInstance = new MvisaApi();
String statusIdentifier = "statusIdentifier_example"; // String | 
try {
    CashInPushPaymentsGetGETResponse result = apiInstance.cashInPushPaymentsGet(statusIdentifier);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MvisaApi#cashInPushPaymentsGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
statusIdentifier String

Return type

CashInPushPaymentsGetGETResponse

Authorization

mutualAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

cashOutPaymentsGet

CashOutPaymentsGetGETResponse cashOutPaymentsGet(statusIdentifier)

GET /visadirect/mvisa/v1/CashOutPushPayments/{statusIdentifier}

Example

// Import classes:
//import com.visa.developer.sample.mvisa.ApiClient;
//import com.visa.developer.sample.mvisa.ApiException;
//import com.visa.developer.sample.mvisa.Configuration;
//import com.visa.developer.sample.mvisa.auth.*;
//import com.visa.developer.sample.mvisa.api.MvisaApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: mutualAuth
HttpBasicAuth mutualAuth = (HttpBasicAuth) defaultClient.getAuthentication("mutualAuth");
mutualAuth.setUsername("YOUR USERNAME");
mutualAuth.setPassword("YOUR PASSWORD");

MvisaApi apiInstance = new MvisaApi();
String statusIdentifier = "statusIdentifier_example"; // String | 
try {
    CashOutPaymentsGetGETResponse result = apiInstance.cashOutPaymentsGet(statusIdentifier);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MvisaApi#cashOutPaymentsGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
statusIdentifier String

Return type

CashOutPaymentsGetGETResponse

Authorization

mutualAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

cashOutPushPaymentsPost

CashOutPushPaymentsPostPOSTResponse cashOutPushPaymentsPost(cashOutPushPaymentsPostPOSTPayload)

CashOutPushPayments POST

Example

// Import classes:
//import com.visa.developer.sample.mvisa.ApiClient;
//import com.visa.developer.sample.mvisa.ApiException;
//import com.visa.developer.sample.mvisa.Configuration;
//import com.visa.developer.sample.mvisa.auth.*;
//import com.visa.developer.sample.mvisa.api.MvisaApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: mutualAuth
HttpBasicAuth mutualAuth = (HttpBasicAuth) defaultClient.getAuthentication("mutualAuth");
mutualAuth.setUsername("YOUR USERNAME");
mutualAuth.setPassword("YOUR PASSWORD");

MvisaApi apiInstance = new MvisaApi();
CashOutPushPaymentsPostPOSTPayload cashOutPushPaymentsPostPOSTPayload = new CashOutPushPaymentsPostPOSTPayload(); // CashOutPushPaymentsPostPOSTPayload | Resource body for CashOutPushPayments POST
try {
    CashOutPushPaymentsPostPOSTResponse result = apiInstance.cashOutPushPaymentsPost(cashOutPushPaymentsPostPOSTPayload);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MvisaApi#cashOutPushPaymentsPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
cashOutPushPaymentsPostPOSTPayload CashOutPushPaymentsPostPOSTPayload Resource body for CashOutPushPayments POST

Return type

CashOutPushPaymentsPostPOSTResponse

Authorization

mutualAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

merchantPushPaymentGet

MerchantPushPaymentGetGETResponse merchantPushPaymentGet(statusIdentifier)

GET /visadirect/mvisa/v1/MerchantPushPayments/{statusIdentifier}

Example

// Import classes:
//import com.visa.developer.sample.mvisa.ApiClient;
//import com.visa.developer.sample.mvisa.ApiException;
//import com.visa.developer.sample.mvisa.Configuration;
//import com.visa.developer.sample.mvisa.auth.*;
//import com.visa.developer.sample.mvisa.api.MvisaApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: mutualAuth
HttpBasicAuth mutualAuth = (HttpBasicAuth) defaultClient.getAuthentication("mutualAuth");
mutualAuth.setUsername("YOUR USERNAME");
mutualAuth.setPassword("YOUR PASSWORD");

MvisaApi apiInstance = new MvisaApi();
String statusIdentifier = "statusIdentifier_example"; // String | 
try {
    MerchantPushPaymentGetGETResponse result = apiInstance.merchantPushPaymentGet(statusIdentifier);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MvisaApi#merchantPushPaymentGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
statusIdentifier String

Return type

MerchantPushPaymentGetGETResponse

Authorization

mutualAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

merchantPushPaymentsPost

MerchantPushPaymentsPostPOSTResponse merchantPushPaymentsPost(merchantPushPaymentsPostPOSTPayload)

MerchantPushPayments POST

MerchantPushPayments is used for payment to a merchant for goods or services purchased, either face-to-face or remote.  This API is invoked in the following sequence:<br><br>1.The consumer connects the account through the mobile device, provides payment instructions and authenticates themselves. The merchant information is captured by the consumer’s mobile from the merchant information display which can be through key entry, QR code, NFC or other means. The payment instructions include mVisa merchant ID (which is used to identify the merchant PAN), the amount to be paid and optionally a payment reference such as an invoice or bill number.<br><br>2. Upon receiving the payment instructions, the consumer’s issuer invokes MerchantPushPayments POST operation to push payment instructions to the merchant’s account.<br><br>3. The merchant acquirer processes the Visa message, creates a record of merchant payment and reverts back with a response message containing the MerchantPushPayments Response Attributes.<br><br>4. On completion, both the consumer and the merchant receive confirmation or denial notification. <br><br>Note: If the POST call times out, the resource will return a statusIdentifier which can be used in the MerchantPushPayments Transactions GET operation as the {statusIdentifier} in the URL.<br><br>HEADER : X-Client-Transaction-ID<br>Optional<br>A unique value for a transaction (unique at the level of the individual service invoker and can be recycled every 24 hours). This identifies the transaction uniquely and can help reference the results of the original transaction.

Example

// Import classes:
//import com.visa.developer.sample.mvisa.ApiClient;
//import com.visa.developer.sample.mvisa.ApiException;
//import com.visa.developer.sample.mvisa.Configuration;
//import com.visa.developer.sample.mvisa.auth.*;
//import com.visa.developer.sample.mvisa.api.MvisaApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: mutualAuth
HttpBasicAuth mutualAuth = (HttpBasicAuth) defaultClient.getAuthentication("mutualAuth");
mutualAuth.setUsername("YOUR USERNAME");
mutualAuth.setPassword("YOUR PASSWORD");

MvisaApi apiInstance = new MvisaApi();
MerchantPushPaymentsPostPOSTPayload merchantPushPaymentsPostPOSTPayload = new MerchantPushPaymentsPostPOSTPayload(); // MerchantPushPaymentsPostPOSTPayload | Resource body for MerchantPushPayments POST
try {
    MerchantPushPaymentsPostPOSTResponse result = apiInstance.merchantPushPaymentsPost(merchantPushPaymentsPostPOSTPayload);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MvisaApi#merchantPushPaymentsPost");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
merchantPushPaymentsPostPOSTPayload MerchantPushPaymentsPostPOSTPayload Resource body for MerchantPushPayments POST

Return type

MerchantPushPaymentsPostPOSTResponse

Authorization

mutualAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined