| Modifier and Type | Method and Description | 
|---|---|
CallContext | 
CallContext.withIdempotenceKey(String idempotenceKey)
Sets the idempotence key to use for the next request for which this call context is used. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected void | 
Communicator.addGenericHeaders(String httpMethod,
                 URI uri,
                 List<RequestHeader> requestHeaders,
                 CallContext context)
Adds the necessary headers to the given list of headers. 
 | 
void | 
Communicator.delete(String relativePath,
      List<RequestHeader> requestHeaders,
      ParamRequest requestParameters,
      BodyHandler bodyHandler,
      CallContext context)
Corresponds to the HTTP DELETE method. 
 | 
<O> O | 
Communicator.delete(String relativePath,
      List<RequestHeader> requestHeaders,
      ParamRequest requestParameters,
      Class<O> responseType,
      CallContext context)
Corresponds to the HTTP DELETE method. 
 | 
void | 
Communicator.get(String relativePath,
   List<RequestHeader> requestHeaders,
   ParamRequest requestParameters,
   BodyHandler bodyHandler,
   CallContext context)
Corresponds to the HTTP GET method. 
 | 
<O> O | 
Communicator.get(String relativePath,
   List<RequestHeader> requestHeaders,
   ParamRequest requestParameters,
   Class<O> responseType,
   CallContext context)
Corresponds to the HTTP GET method. 
 | 
void | 
Communicator.post(String relativePath,
    List<RequestHeader> requestHeaders,
    ParamRequest requestParameters,
    Object requestBody,
    BodyHandler bodyHandler,
    CallContext context)
Corresponds to the HTTP POST method. 
 | 
<O> O | 
Communicator.post(String relativePath,
    List<RequestHeader> requestHeaders,
    ParamRequest requestParameters,
    Object requestBody,
    Class<O> responseType,
    CallContext context)
Corresponds to the HTTP POST method. 
 | 
protected void | 
Communicator.processResponse(int statusCode,
               InputStream bodyStream,
               List<ResponseHeader> headers,
               BodyHandler bodyHandler,
               String requestPath,
               CallContext context)  | 
protected <O> O | 
Communicator.processResponse(int statusCode,
               InputStream bodyStream,
               List<ResponseHeader> headers,
               Class<O> responseType,
               String requestPath,
               CallContext context)  | 
void | 
Communicator.put(String relativePath,
   List<RequestHeader> requestHeaders,
   ParamRequest requestParameters,
   Object requestBody,
   BodyHandler bodyHandler,
   CallContext context)
Corresponds to the HTTP PUT method. 
 | 
<O> O | 
Communicator.put(String relativePath,
   List<RequestHeader> requestHeaders,
   ParamRequest requestParameters,
   Object requestBody,
   Class<O> responseType,
   CallContext context)
Corresponds to the HTTP PUT method. 
 | 
protected static void | 
Communicator.updateContext(List<ResponseHeader> headers,
             CallContext context)
Updates the given call context based on the contents of the given response. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
RuntimeException | 
ExceptionFactory.createException(int statusCode,
               String responseBody,
               Object errorObject,
               CallContext context)  | 
| Modifier and Type | Method and Description | 
|---|---|
CaptureResponse | 
CapturesClient.get(String captureId,
   CallContext context)
Resource /{merchantId}/captures/{captureId}
 - Get capture 
 | 
RefundResponse | 
CapturesClient.refund(String captureId,
      RefundRequest body,
      CallContext context)
Resource /{merchantId}/captures/{captureId}/refund
 - Create Refund 
 | 
| Modifier and Type | Method and Description | 
|---|---|
DisputeResponse | 
DisputesClient.cancel(String disputeId,
      CallContext context)
Resource /{merchantId}/disputes/{disputeId}/cancel
 - Cancel dispute 
 | 
DisputeResponse | 
DisputesClient.get(String disputeId,
   CallContext context)
Resource /{merchantId}/disputes/{disputeId}
 - Get dispute 
 | 
DisputeResponse | 
DisputesClient.submit(String disputeId,
      CallContext context)
Resource /{merchantId}/disputes/{disputeId}/submit
 - Submit dispute 
 | 
UploadDisputeFileResponse | 
DisputesClient.uploadFile(String disputeId,
          UploadFileRequest body,
          CallContext context)
Resource /{merchantId}/disputes/{disputeId}
 - Upload File 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
FilesClient.getFile(String fileId,
       BodyHandler bodyHandler,
       CallContext context)
Resource /{merchantId}/files/{fileId}
 - Retrieve File 
 | 
| Modifier and Type | Method and Description | 
|---|---|
CreateHostedCheckoutResponse | 
HostedcheckoutsClient.create(CreateHostedCheckoutRequest body,
      CallContext context)
Resource /{merchantId}/hostedcheckouts
 - Create hosted checkout 
 | 
void | 
HostedcheckoutsClient.delete(String hostedCheckoutId,
      CallContext context)
Resource /{merchantId}/hostedcheckouts/{hostedCheckoutId}
 - Delete hosted checkout 
 | 
GetHostedCheckoutResponse | 
HostedcheckoutsClient.get(String hostedCheckoutId,
   CallContext context)
Resource /{merchantId}/hostedcheckouts/{hostedCheckoutId}
 - Get hosted checkout status 
 | 
| Modifier and Type | Method and Description | 
|---|---|
CreateHostedMandateManagementResponse | 
HostedmandatemanagementsClient.create(CreateHostedMandateManagementRequest body,
      CallContext context)
Resource /{merchantId}/hostedmandatemanagements
 - Create hosted mandate management 
 | 
GetHostedMandateManagementResponse | 
HostedmandatemanagementsClient.get(String hostedMandateManagementId,
   CallContext context)
Resource /{merchantId}/hostedmandatemanagements/{hostedMandateManagementId}
 - Get hosted mandate management status 
 | 
| Modifier and Type | Method and Description | 
|---|---|
InstallmentOptionsResponse | 
InstallmentsClient.getInstallmentsInfo(GetInstallmentRequest body,
                   CallContext context)
Resource /{merchantId}/installments/getInstallmentsInfo
 - Get installment information 
 | 
| Modifier and Type | Method and Description | 
|---|---|
GetMandateResponse | 
MandatesClient.block(String uniqueMandateReference,
     CallContext context)
Resource /{merchantId}/mandates/{uniqueMandateReference}/block
 - Block mandate 
 | 
CreateMandateResponse | 
MandatesClient.create(CreateMandateRequest body,
      CallContext context)
Resource /{merchantId}/mandates
 - Create mandate 
 | 
CreateMandateResponse | 
MandatesClient.createWithMandateReference(String uniqueMandateReference,
                          CreateMandateRequest body,
                          CallContext context)
Resource /{merchantId}/mandates/{uniqueMandateReference}
 - Create mandate with mandatereference 
 | 
GetMandateResponse | 
MandatesClient.get(String uniqueMandateReference,
   CallContext context)
Resource /{merchantId}/mandates/{uniqueMandateReference}
 - Get mandate 
 | 
GetMandateResponse | 
MandatesClient.revoke(String uniqueMandateReference,
      CallContext context)
Resource /{merchantId}/mandates/{uniqueMandateReference}/revoke
 - Revoke mandate 
 | 
GetMandateResponse | 
MandatesClient.unblock(String uniqueMandateReference,
       CallContext context)
Resource /{merchantId}/mandates/{uniqueMandateReference}/unblock
 - Unblock mandate 
 | 
| Modifier and Type | Method and Description | 
|---|---|
PaymentApprovalResponse | 
PaymentsClient.approve(String paymentId,
       ApprovePaymentRequest body,
       CallContext context)
Resource /{merchantId}/payments/{paymentId}/approve
 - Approve payment 
 | 
CancelPaymentResponse | 
PaymentsClient.cancel(String paymentId,
      CallContext context)
Resource /{merchantId}/payments/{paymentId}/cancel
 - Cancel payment 
 | 
CancelApprovalPaymentResponse | 
PaymentsClient.cancelapproval(String paymentId,
              CallContext context)
Resource /{merchantId}/payments/{paymentId}/cancelapproval
 - Undo capture payment 
 | 
CaptureResponse | 
PaymentsClient.capture(String paymentId,
       CapturePaymentRequest body,
       CallContext context)
Resource /{merchantId}/payments/{paymentId}/capture
 - Capture payment 
 | 
CapturesResponse | 
PaymentsClient.captures(String paymentId,
        CallContext context)
Resource /{merchantId}/payments/{paymentId}/captures
 - Get captures of payment 
 | 
CompletePaymentResponse | 
PaymentsClient.complete(String paymentId,
        CompletePaymentRequest body,
        CallContext context)
Resource /{merchantId}/payments/{paymentId}/complete
 - Complete payment 
 | 
CreatePaymentResponse | 
PaymentsClient.create(CreatePaymentRequest body,
      CallContext context)
Resource /{merchantId}/payments
 - Create payment 
 | 
DeviceFingerprintDetails | 
PaymentsClient.devicefingerprint(String paymentId,
                 CallContext context)
Resource /{merchantId}/payments/{paymentId}/devicefingerprint
 - Get Device Fingerprint details 
 | 
DisputeResponse | 
PaymentsClient.dispute(String paymentId,
       CreateDisputeRequest body,
       CallContext context)
Resource /{merchantId}/payments/{paymentId}/dispute
 - Create dispute 
 | 
DisputesResponse | 
PaymentsClient.disputes(String paymentId,
        CallContext context)
Resource /{merchantId}/payments/{paymentId}/disputes
 - Get disputes 
 | 
FindPaymentsResponse | 
PaymentsClient.find(FindPaymentsParams query,
    CallContext context)
Resource /{merchantId}/payments
 - Find payments 
 | 
PaymentResponse | 
PaymentsClient.get(String paymentId,
   CallContext context)
Resource /{merchantId}/payments/{paymentId}
 - Get payment 
 | 
PaymentResponse | 
PaymentsClient.processchallenged(String paymentId,
                 CallContext context)
Resource /{merchantId}/payments/{paymentId}/processchallenged
 - Approves challenged payment 
 | 
RefundResponse | 
PaymentsClient.refund(String paymentId,
      RefundRequest body,
      CallContext context)
Resource /{merchantId}/payments/{paymentId}/refund
 - Create refund 
 | 
RefundsResponse | 
PaymentsClient.refunds(String paymentId,
       CallContext context)
Resource /{merchantId}/payments/{paymentId}/refunds
 - Get refunds of payment 
 | 
ThirdPartyStatusResponse | 
PaymentsClient.thirdPartyStatus(String paymentId,
                CallContext context)
Resource /{merchantId}/payments/{paymentId}/thirdpartystatus
 - Third party status poll 
 | 
CreateTokenResponse | 
PaymentsClient.tokenize(String paymentId,
        TokenizePaymentRequest body,
        CallContext context)
Resource /{merchantId}/payments/{paymentId}/tokenize
 - Create a token from payment 
 | 
| Modifier and Type | Method and Description | 
|---|---|
PayoutResponse | 
PayoutsClient.approve(String payoutId,
       ApprovePayoutRequest body,
       CallContext context)
Resource /{merchantId}/payouts/{payoutId}/approve
 - Approve payout 
 | 
void | 
PayoutsClient.cancel(String payoutId,
      CallContext context)
Resource /{merchantId}/payouts/{payoutId}/cancel
 - Cancel payout 
 | 
void | 
PayoutsClient.cancelapproval(String payoutId,
              CallContext context)
Resource /{merchantId}/payouts/{payoutId}/cancelapproval
 - Undo approve payout 
 | 
PayoutResponse | 
PayoutsClient.create(CreatePayoutRequest body,
      CallContext context)
Resource /{merchantId}/payouts
 - Create payout 
 | 
FindPayoutsResponse | 
PayoutsClient.find(FindPayoutsParams query,
    CallContext context)
Resource /{merchantId}/payouts
 - Find payouts 
 | 
PayoutResponse | 
PayoutsClient.get(String payoutId,
   CallContext context)
Resource /{merchantId}/payouts/{payoutId}
 - Get payout 
 | 
| Modifier and Type | Method and Description | 
|---|---|
DeviceFingerprintResponse | 
ProductgroupsClient.deviceFingerprint(String paymentProductGroupId,
                 DeviceFingerprintRequest body,
                 CallContext context)
Resource /{merchantId}/productgroups/{paymentProductGroupId}/deviceFingerprint
 - Get device fingerprint 
 | 
PaymentProductGroups | 
ProductgroupsClient.find(FindProductgroupsParams query,
    CallContext context)
Resource /{merchantId}/productgroups
 - Get payment product groups 
 | 
PaymentProductGroupResponse | 
ProductgroupsClient.get(String paymentProductGroupId,
   GetProductgroupParams query,
   CallContext context)
Resource /{merchantId}/productgroups/{paymentProductGroupId}
 - Get payment product group 
 | 
| Modifier and Type | Method and Description | 
|---|---|
GetCustomerDetailsResponse | 
ProductsClient.customerDetails(Integer paymentProductId,
               GetCustomerDetailsRequest body,
               CallContext context)
Resource /{merchantId}/products/{paymentProductId}/customerDetails
 - Get customer details 
 | 
DeviceFingerprintResponse | 
ProductsClient.deviceFingerprint(Integer paymentProductId,
                 DeviceFingerprintRequest body,
                 CallContext context)
Resource /{merchantId}/products/{paymentProductId}/deviceFingerprint
 - Get device fingerprint 
 | 
Directory | 
ProductsClient.directory(Integer paymentProductId,
         DirectoryParams query,
         CallContext context)
Resource /{merchantId}/products/{paymentProductId}/directory
 - Get payment product directory 
 | 
PaymentProducts | 
ProductsClient.find(FindProductsParams query,
    CallContext context)
Resource /{merchantId}/products
 - Get payment products 
 | 
PaymentProductResponse | 
ProductsClient.get(Integer paymentProductId,
   GetProductParams query,
   CallContext context)
Resource /{merchantId}/products/{paymentProductId}
 - Get payment product 
 | 
PaymentProductNetworksResponse | 
ProductsClient.networks(Integer paymentProductId,
        NetworksParams query,
        CallContext context)
Resource /{merchantId}/products/{paymentProductId}/networks
 - Get payment product networks 
 | 
CreatePaymentProductSessionResponse | 
ProductsClient.sessions(Integer paymentProductId,
        CreatePaymentProductSessionRequest body,
        CallContext context)
Resource /{merchantId}/products/{paymentProductId}/sessions
 - Create session for payment product 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
RefundsClient.approve(String refundId,
       ApproveRefundRequest body,
       CallContext context)
Resource /{merchantId}/refunds/{refundId}/approve
 - Approve refund 
 | 
void | 
RefundsClient.cancel(String refundId,
      CallContext context)
Resource /{merchantId}/refunds/{refundId}/cancel
 - Cancel refund 
 | 
void | 
RefundsClient.cancelapproval(String refundId,
              CallContext context)
Resource /{merchantId}/refunds/{refundId}/cancelapproval
 - Undo approve refund 
 | 
FindRefundsResponse | 
RefundsClient.find(FindRefundsParams query,
    CallContext context)
Resource /{merchantId}/refunds
 - Find refunds 
 | 
RefundResponse | 
RefundsClient.get(String refundId,
   CallContext context)
Resource /{merchantId}/refunds/{refundId}
 - Get refund 
 | 
| Modifier and Type | Method and Description | 
|---|---|
RiskAssessmentResponse | 
RiskassessmentsClient.bankaccounts(RiskAssessmentBankAccount body,
            CallContext context)
Resource /{merchantId}/riskassessments/bankaccounts
 - Risk-assess bankaccount 
 | 
RiskAssessmentResponse | 
RiskassessmentsClient.cards(RiskAssessmentCard body,
     CallContext context)
Resource /{merchantId}/riskassessments/cards
 - Risk-assess card 
 | 
| Modifier and Type | Method and Description | 
|---|---|
BankDetailsResponse | 
ServicesClient.bankaccount(BankDetailsRequest body,
           CallContext context)
Resource /{merchantId}/services/convert/bankaccount
 - Convert bankaccount 
 | 
ConvertAmount | 
ServicesClient.convertAmount(ConvertAmountParams query,
             CallContext context)
Resource /{merchantId}/services/convert/amount
 - Convert amount 
 | 
GetIINDetailsResponse | 
ServicesClient.getIINdetails(GetIINDetailsRequest body,
             CallContext context)
Resource /{merchantId}/services/getIINdetails
 - Get IIN details 
 | 
GetPrivacyPolicyResponse | 
ServicesClient.privacypolicy(PrivacypolicyParams query,
             CallContext context)
Resource /{merchantId}/services/privacypolicy
 - Get privacy policy 
 | 
TestConnection | 
ServicesClient.testconnection(CallContext context)
Resource /{merchantId}/services/testconnection
 - Test connection 
 | 
| Modifier and Type | Method and Description | 
|---|---|
SessionResponse | 
SessionsClient.create(SessionRequest body,
      CallContext context)
Resource /{merchantId}/sessions
 - Create session 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
TokensClient.approvesepadirectdebit(String tokenId,
                      ApproveTokenRequest body,
                      CallContext context)
Resource /{merchantId}/tokens/{tokenId}/approvesepadirectdebit
 - Approve SEPA DD mandate 
 | 
CreateTokenResponse | 
TokensClient.create(CreateTokenRequest body,
      CallContext context)
Resource /{merchantId}/tokens
 - Create token 
 | 
void | 
TokensClient.delete(String tokenId,
      DeleteTokenParams query,
      CallContext context)
Resource /{merchantId}/tokens/{tokenId}
 - Delete token 
 | 
TokenResponse | 
TokensClient.get(String tokenId,
   CallContext context)
Resource /{merchantId}/tokens/{tokenId}
 - Get token 
 | 
void | 
TokensClient.update(String tokenId,
      UpdateTokenRequest body,
      CallContext context)
Resource /{merchantId}/tokens/{tokenId}
 - Update token 
 | 
Copyright © 2025 Worldline Global Collect. All rights reserved.