Skip to content

PaymentsApi.md

Latest commit

 

History

History
187 lines (138 loc) · 5.67 KB

PaymentsApi.md

File metadata and controls

187 lines (138 loc) · 5.67 KB

PaymentsApi

All URIs are relative to https://api.brevo.com/v3

Method HTTP request Description
createPaymentRequest POST /payments/requests Create a payment request
deletePaymentRequest DELETE /payments/requests/{id} Delete a payment request.
getPaymentRequest GET /payments/requests/{id} Get payment request details

createPaymentRequest

CreateModel createPaymentRequest(createPaymentRquest)

Create a payment request

Example

// Import classes:
//import brevo.ApiClient;
//import brevo.ApiException;
//import brevo.Configuration;
//import brevo.auth.*;
//import brevoApi.PaymentsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

PaymentsApi apiInstance = new PaymentsApi();
CreatePaymentRequest createPaymentRquest = new CreatePaymentRequest(); // CreatePaymentRequest | Create a payment request 
try {
    CreateModel result = apiInstance.createPaymentRequest(createPaymentRquest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PaymentsApi#createPaymentRequest");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
createPaymentRquest CreatePaymentRequest Create a payment request

Return type

CreateModel

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deletePaymentRequest

deletePaymentRequest(id)

Delete a payment request.

Example

// Import classes:
//import brevo.ApiClient;
//import brevo.ApiException;
//import brevo.Configuration;
//import brevo.auth.*;
//import brevoApi.PaymentsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

PaymentsApi apiInstance = new PaymentsApi();
String id = "id_example"; // String | ID of the payment request.
try {
    apiInstance.deletePaymentRequest(id);
} catch (ApiException e) {
    System.err.println("Exception when calling PaymentsApi#deletePaymentRequest");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String ID of the payment request.

Return type

null (empty response body)

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getPaymentRequest

GetPaymentRequest getPaymentRequest(id)

Get payment request details

Example

// Import classes:
//import brevo.ApiClient;
//import brevo.ApiException;
//import brevo.Configuration;
//import brevo.auth.*;
//import brevoApi.PaymentsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

// Configure API key authorization: partner-key
ApiKeyAuth partnerKey = (ApiKeyAuth) defaultClient.getAuthentication("partner-key");
partnerKey.setApiKey("YOUR PARTNER KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//partnerKey.setApiKeyPrefix("Token");

PaymentsApi apiInstance = new PaymentsApi();
String id = "id_example"; // String | Id of the payment Request
try {
    GetPaymentRequest result = apiInstance.getPaymentRequest(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PaymentsApi#getPaymentRequest");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String Id of the payment Request

Return type

GetPaymentRequest

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json