com.cardpay.sdk.api

Interface RefundsApi

public interface RefundsApi

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<RefundResponse>	createRefund(RefundRequest refundRequest) Create refund
retrofit2.Call<RefundResponse>	getRefund(String refundId) Get refund information
retrofit2.Call<RefundsList>	getRefunds(String requestId, String currency, OffsetDateTime endTime, Integer maxCount, String merchantOrderId, String paymentMethod, String sortOrder, OffsetDateTime startTime) Get list of refunds
retrofit2.Call<RefundUpdateResponse>	updateRefund(String refundId, RefundUpdateRequest refundUpdateRequest) Update refund

Method Detail

createRefund

@Headers(value="Content-Type:application/json")
 @POST(value="api/refunds")
retrofit2.Call<RefundResponse> createRefund(@Body
                                                                                                                        RefundRequest refundRequest)

Create refund

Parameters:

refundRequest - refundRequest (required)

Returns:

Call<RefundResponse>

getRefund

@GET(value="api/refunds/{refundId}")
retrofit2.Call<RefundResponse> getRefund(@Path(value="refundId")
                                                                              String refundId)

Get refund information

Parameters:

refundId - Refund ID (required)

Returns:

Call<RefundResponse>

getRefunds

@GET(value="api/refunds")
retrofit2.Call<RefundsList> getRefunds(@Query(value="request_id")
                                                                 String requestId,
                                                                 @Query(value="currency")
                                                                 String currency,
                                                                 @Query(value="end_time")
                                                                 OffsetDateTime endTime,
                                                                 @Query(value="max_count")
                                                                 Integer maxCount,
                                                                 @Query(value="merchant_order_id")
                                                                 String merchantOrderId,
                                                                 @Query(value="payment_method")
                                                                 String paymentMethod,
                                                                 @Query(value="sort_order")
                                                                 String sortOrder,
                                                                 @Query(value="start_time")
                                                                 OffsetDateTime startTime)

Get list of refunds

Parameters:

requestId - Request ID (required)

currency - [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of transactions currency (optional)

endTime - Date and time up to milliseconds (in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when requested period ends (not inclusive), UTC time, must be less than 7 days after 'start_time', default is current time (format: yyyy-MM-dd'T'HH:mm:ss'Z') (optional)

maxCount - Limit number of returned transactions (must be less than 10000, default is 1000) (optional)

merchantOrderId - Merchant order number from the merchant system (optional)

paymentMethod - Used payment method type name from payment methods list (optional)

sortOrder - Sort based on order of results. `asc` for ascending order or `desc` for descending order (default value) (optional)

startTime - Date and time up to milliseconds (in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when requested period starts (inclusive), UTC time, default is 24 hours before 'end_time' (format: yyyy-MM-dd'T'HH:mm:ss'Z') (optional)

Returns:

Call<RefundsList>

updateRefund

@Headers(value="Content-Type:application/json")
 @PATCH(value="api/refunds/{refundId}")
retrofit2.Call<RefundUpdateResponse> updateRefund(@Path(value="refundId")
                                                                                                                                          String refundId,
                                                                                                                                          @Body
                                                                                                                                          RefundUpdateRequest refundUpdateRequest)

Update refund

Parameters:

refundId - Refund ID (required)

refundUpdateRequest - refundUpdateRequest (required)

Returns:

Call<RefundUpdateResponse>