com.cardpay.sdk.api

Interface PayoutsApi

public interface PayoutsApi

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<PayoutResponse>	createPayout(PayoutRequest payoutRequest) Create payout
retrofit2.Call<PayoutResponse>	getPayout(String payoutId) Read payout information
retrofit2.Call<PayoutsList>	getPayouts(String requestId, String currency, OffsetDateTime endTime, Integer maxCount, String merchantOrderId, String paymentMethod, String sortOrder, OffsetDateTime startTime) Get payouts information
retrofit2.Call<PayoutUpdateResponse>	updatePayout(String payoutId, PayoutUpdateRequest payoutUpdateRequest) Update payout

Method Detail

createPayout

@Headers(value="Content-Type:application/json")
 @POST(value="api/payouts")
retrofit2.Call<PayoutResponse> createPayout(@Body
                                                                                                                        PayoutRequest payoutRequest)

Create payout

Parameters:

payoutRequest - payoutRequest (required)

Returns:

Call<PayoutResponse>

getPayout

@GET(value="api/payouts/{payoutId}")
retrofit2.Call<PayoutResponse> getPayout(@Path(value="payoutId")
                                                                              String payoutId)

Read payout information

Parameters:

payoutId - Payout ID (required)

Returns:

Call<PayoutResponse>

getPayouts

@GET(value="api/payouts")
retrofit2.Call<PayoutsList> getPayouts(@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 payouts information

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, minimal value is 1) (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<PayoutsList>

updatePayout

@Headers(value="Content-Type:application/json")
 @PATCH(value="api/payouts/{payoutId}")
retrofit2.Call<PayoutUpdateResponse> updatePayout(@Path(value="payoutId")
                                                                                                                                          String payoutId,
                                                                                                                                          @Body
                                                                                                                                          PayoutUpdateRequest payoutUpdateRequest)

Update payout

Parameters:

payoutId - Payout ID (required)

payoutUpdateRequest - payoutUpdateRequest (required)

Returns:

Call<PayoutUpdateResponse>