Package app.cybrid.cybrid_api_bank.client.api

Class PaymentInstructionsBankApi

java.lang.Object

app.cybrid.cybrid_api_bank.client.api.PaymentInstructionsBankApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-02-18T16:20:44.637733Z[Etc/UTC]")
public class PaymentInstructionsBankApi
extends Object

Constructor Summary

Constructors

Constructor	Description
PaymentInstructionsBankApi()
PaymentInstructionsBankApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<PaymentInstructionBankModel>	createPaymentInstruction(PostPaymentInstructionBankModel postPaymentInstructionBankModel)	Create Payment Instruction Creates a payment instruction.
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<PaymentInstructionBankModel>>	createPaymentInstructionWithHttpInfo(PostPaymentInstructionBankModel postPaymentInstructionBankModel)
ApiClient	getApiClient()
reactor.core.publisher.Mono<PaymentInstructionBankModel>	getPaymentInstruction(String paymentInstructionGuid)	Get Payment Instruction Retrieves a payment_instruction.
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<PaymentInstructionBankModel>>	getPaymentInstructionWithHttpInfo(String paymentInstructionGuid)
reactor.core.publisher.Mono<PaymentInstructionListBankModel>	listPaymentInstructions(BigInteger page, BigInteger perPage, String guid, String bankGuid, String customerGuid, String invoiceGuid)	List Payment Instructions Retrieves a list of payment instructions.
reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<PaymentInstructionListBankModel>>	listPaymentInstructionsWithHttpInfo(BigInteger page, BigInteger perPage, String guid, String bankGuid, String customerGuid, String invoiceGuid)
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PaymentInstructionsBankApi

public PaymentInstructionsBankApi()

PaymentInstructionsBankApi

@Autowired
public PaymentInstructionsBankApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createPaymentInstruction

public reactor.core.publisher.Mono<PaymentInstructionBankModel> createPaymentInstruction(PostPaymentInstructionBankModel postPaymentInstructionBankModel)
                                                                                  throws org.springframework.web.reactive.function.client.WebClientResponseException

Create Payment Instruction Creates a payment instruction. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the payment instruction details in our private store | | created | The Platform has created the payment instruction | | expired | The PaymentInstruction is no longer valid | Required scope: **invoices:write**

201 - Payment Instruction created

401 - Unauthorized - Authentication failed,

403 - Invalid scope

Parameters:

postPaymentInstructionBankModel - The postPaymentInstructionBankModel parameter

Returns:

PaymentInstructionBankModel

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

createPaymentInstructionWithHttpInfo

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<PaymentInstructionBankModel>> createPaymentInstructionWithHttpInfo(PostPaymentInstructionBankModel postPaymentInstructionBankModel)
                                                                                                                                       throws org.springframework.web.reactive.function.client.WebClientResponseException

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException

getPaymentInstruction

public reactor.core.publisher.Mono<PaymentInstructionBankModel> getPaymentInstruction(String paymentInstructionGuid)
                                                                               throws org.springframework.web.reactive.function.client.WebClientResponseException

Get Payment Instruction Retrieves a payment_instruction. Required scope: **invoices:read**

200 - payment_instruction found

401 - Unauthorized - Authentication failed,

403 - Invalid scope

404 - payment_instruction not found

Parameters:

paymentInstructionGuid - Identifier for the payment instruction.

Returns:

PaymentInstructionBankModel

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

getPaymentInstructionWithHttpInfo

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<PaymentInstructionBankModel>> getPaymentInstructionWithHttpInfo(String paymentInstructionGuid)
                                                                                                                                    throws org.springframework.web.reactive.function.client.WebClientResponseException

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException

listPaymentInstructions

public reactor.core.publisher.Mono<PaymentInstructionListBankModel> listPaymentInstructions(BigInteger page,
                                                                                            BigInteger perPage,
                                                                                            String guid,
                                                                                            String bankGuid,
                                                                                            String customerGuid,
                                                                                            String invoiceGuid)
                                                                                     throws org.springframework.web.reactive.function.client.WebClientResponseException

List Payment Instructions Retrieves a list of payment instructions. Required scope: **invoices:read**

200 - get list of payment instructions

400 - Invalid requests

401 - Unauthorized - Authentication failed,

403 - Invalid scope

Parameters:

page - The page index to retrieve.

perPage - The number of entities per page to return.

guid - Comma separated guids to list payment instructions for.

bankGuid - Comma separated bank_guids to list payment instructions for.

customerGuid - Comma separated customer_guids to list payment instructions for.

invoiceGuid - Comma separated invoice_guids to list payment instructions for.

Returns:

PaymentInstructionListBankModel

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

listPaymentInstructionsWithHttpInfo

public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<PaymentInstructionListBankModel>> listPaymentInstructionsWithHttpInfo(BigInteger page,
                                                                                                                                                 BigInteger perPage,
                                                                                                                                                 String guid,
                                                                                                                                                 String bankGuid,
                                                                                                                                                 String customerGuid,
                                                                                                                                                 String invoiceGuid)
                                                                                                                                          throws org.springframework.web.reactive.function.client.WebClientResponseException

Throws:

org.springframework.web.reactive.function.client.WebClientResponseException