Refund

Note

Viewing documentation for the current version v1.

The required Protobuf definitions can be downloaded here:

• moia/trip/refund/v1/refund.proto

• moia/type/v1/money.proto

RefundService

The refund service provides functionality for refunds.

GetRefund

rpc GetRefund(GetRefundRequest) returns (GetRefundResponse)

Gets a refund by ID.

Fails with NOT_FOUND with the reason REFUND_NOT_FOUND if there is no refund for the requested ID.

ListRefunds

rpc ListRefunds(ListRefundsRequest) returns (ListRefundsResponse)

Lists refunds.

Fails with INVALID_ARGUMENT with the following reasons:

• INVALID_PAGE_SIZE if the page_size is less than zero.

• INVALID_PAGE_TOKEN if the page_token does not match previous requests.

Messages

GetRefundRequest

The request to get a refund.

Field	Type	Description
refund_id	string	The ID of the refund.

GetRefundResponse

The response containing the requested refund.

Field	Type	Description
refund	Refund	The refund with the given ID.

ListRefundsRequest

Request to list refunds.

Field	Type	Description
customer_id	optional string	The ID of the customer for whom to list all refunds. Optional: If not specified, all refunds of all customers are listed. Only leave this out if you really need all refunds of all customers because the list might easily become very long.
page_size	optional int32	The maximum number of refunds to return. The service may return fewer than this value. If unspecified or set to zero, at most 25 refunds will be returned. The maximum value is 100; values above 100 will be coerced to 100. Negative values won’t be accepted.
page_token	optional string	A page token, received from a previous ListRefundsRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRefundsRequest must match the call that provided the page token.

ListRefundsResponse

Response to list refunds.

Field	Type	Description
refunds	repeated Refund	The list of refunds, ordered by date from newest to oldest.
next_page_token	optional string	A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Refund

A refund.

Field	Type	Description
id	string	The ID of the refund.
customer_id	string	The ID of the customer who requested the refund.
trip_id	string	The ID of the trip for which the refund was requested.
refund	moia.type.v1.Money	The gross amount to be refunded to the customer. This is equal to the original price of the trip. Must be greater than zero.