Struct Payments 

pub struct Payments<'a> { /* private fields */ }

Implementations

impl<'a> Payments<'a>

pub async fn list( self, parameters: Option<Vec<(String, String)>>, ) -> Result<SquareResponse, SquareError>

Retrieves a list of payments taken by the account making the request. Open in API Reference

Arguments

• parameters - A vector of parameters created through the ListPaymentsParametersBuilder

pub async fn create( self, payment: PaymentRequest, ) -> Result<SquareResponse, SquareError>

Create a payment with the given Payment to the Square API and get the response back

Arguments

• payment - A Payment

pub async fn cancel_by_idempotency_key( self, idempotency_key: String, ) -> Result<SquareResponse, SquareError>

Cancels (voids) a payment identified by the idempotency key that is specified in the request. Open in API Reference

Arguments

• idempotency_key - The idempotency key identifying the payment to be canceled.

pub async fn get( self, payment_id: String, ) -> Result<SquareResponse, SquareError>

Retrieves details for a specific payment. Open in API Reference

Arguments

• payment_id - The idempotency key identifying the payment to be canceled.

pub async fn update( self, payment_id: String, body: UpdatePaymentBody, ) -> Result<SquareResponse, SquareError>

Updates a payment with the APPROVED status. You can update the amount_money and tip_money using this endpoint. Open in API Reference

Arguments

• payment_id - The idempotency key identifying the payment to be updated.
• body - The request body with the updated Payment object.

pub async fn cancel( self, payment_id: String, ) -> Result<SquareResponse, SquareError>

Cancels (voids) a payment. Open in API Reference

Arguments

• payment_id - The idempotency key identifying the payment to be canceled.

pub async fn complete( self, payment_id: String, version_token: Option<String>, ) -> Result<SquareResponse, SquareError>

Cancels (voids) a payment. Open in API Reference

Arguments

• payment_id - The idempotency key identifying the payment to be completed.
• version_token - Used for optimistic concurrency. This opaque token identifies the current Payment version that the caller expects. If the server has a different version of the Payment, the update fails and a response with a VERSION_MISMATCH error is returned.