Package vn.payos

Class PayOS

java.lang.Object
vn.payos.core.Client
vn.payos.PayOS
public class PayOS extends Client
payOS client

  • Constructor Details

    • PayOS

      public PayOS(@NonNull @NonNull String clientId, @NonNull @NonNull String apiKey, @NonNull @NonNull String checksumKey)
      payOS client
      Parameters:
      clientId - client id
      apiKey - api key
      checksumKey - checksum key

    • PayOS

      public PayOS(@NonNull @NonNull String clientId, @NonNull @NonNull String apiKey, @NonNull @NonNull String checksumKey, String partnerCode)
      payOS client
      Parameters:
      clientId - client id
      apiKey - api key
      checksumKey - checksum key
      partnerCode - partner code

    • PayOS

      public PayOS(@NonNull @NonNull ClientOptions options)
      payOS client
      Parameters:
      options - options

  • Method Details

    • fromEnv

      public static PayOS fromEnv()
      payOS client
      Returns:
      payOS client

    • async

      public PayOSAsync async()
      payOS async client
      Returns:
      payOS async client

    • request

      public <TResp, TReq> TResp request(FinalRequestOptions<TReq> options, Class<TResp> dataClass)
      Make request
      Type Parameters:
      TResp - response body type
      TReq - request body type
      Parameters:
      options - options
      dataClass - response data class
      Returns:
      response

    • get

      public <TResp> TResp get(String path, Class<TResp> dataClass, RequestOptions<Void> options)
      Make GET request
      Type Parameters:
      TResp - response body type
      Parameters:
      path - path
      dataClass - response data class
      options - options
      Returns:
      response

    • get

      public <TResp> TResp get(String path, Class<TResp> dataClass)
      Make GET request
      Type Parameters:
      TResp - response body type
      Parameters:
      path - path
      dataClass - response data class
      Returns:
      response

    • post

      public <TResp, TReq> TResp post(String path, Class<TResp> dataClass, RequestOptions<TReq> options)
      Make POST request
      Type Parameters:
      TResp - response body type
      TReq - request body type
      Parameters:
      path - path
      dataClass - response data class
      options - options
      Returns:
      response

    • post

      public <TResp, TReq> TResp post(String path, Class<TResp> dataClass)
      Make POST request
      Type Parameters:
      TResp - response body type
      TReq - request body type
      Parameters:
      path - path
      dataClass - response data class
      Returns:
      response

    • put

      public <TResp, TReq> TResp put(String path, Class<TResp> dataClass, RequestOptions<TReq> options)
      Make PUT request
      Type Parameters:
      TResp - response body type
      TReq - request body type
      Parameters:
      path - path
      dataClass - response data class
      options - options
      Returns:
      response

    • put

      public <TResp, TReq> TResp put(String path, Class<TResp> dataClass)
      Make PUT request
      Type Parameters:
      TResp - response body type
      TReq - request body type
      Parameters:
      path - path
      dataClass - response data class
      Returns:
      response

    • patch

      public <TResp, TReq> TResp patch(String path, Class<TResp> dataClass, RequestOptions<TReq> options)
      Make PATCH request
      Type Parameters:
      TResp - response body type
      TReq - request body type
      Parameters:
      path - path
      dataClass - response data class
      options - options
      Returns:
      response

    • patch

      public <TResp, TReq> TResp patch(String path, Class<TResp> dataClass)
      Make PATCH request
      Type Parameters:
      TResp - response body type
      TReq - request body type
      Parameters:
      path - path
      dataClass - response data class
      Returns:
      response

    • delete

      public <TResp, TReq> TResp delete(String path, Class<TResp> dataClass, RequestOptions<TReq> options)
      Make DELETE request
      Type Parameters:
      TResp - response body type
      TReq - request body type
      Parameters:
      path - path
      dataClass - response data class
      options - options
      Returns:
      response

    • delete

      public <TResp, TReq> TResp delete(String path, Class<TResp> dataClass)
      Make DELETE request
      Type Parameters:
      TResp - response body type
      TReq - request body type
      Parameters:
      path - path
      dataClass - response data class
      Returns:
      response

    • downloadFile

      public <TReq> FileDownloadResponse downloadFile(FinalRequestOptions<TReq> reqOpts)
      Download file
      Type Parameters:
      TReq - request body type
      Parameters:
      reqOpts - options
      Returns:
      File information

    • close

      public void close()
      Close

    • paymentRequests

      public PaymentRequestsService paymentRequests()
      PaymentRequestsService
      Returns:
      PaymentRequestsService

    • webhooks

      public WebhooksService webhooks()
      WebhooksService
      Returns:
      WebhooksService

    • payouts

      public PayoutsService payouts()
      PayoutsService
      Returns:
      PayoutsService

    • payoutsAccount

      public PayoutsAccountService payoutsAccount()
      PayoutsAccountService
      Returns:
      PayoutsAccountService