com.cardpay.sdk.api

Interface PaymentsApi

public interface PaymentsApi

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<PaymentCreationResponse>	createPayment(PaymentRequest paymentRequest) Create payment Endpoint for creation payments.
retrofit2.Call<PaymentResponse>	getPayment(String paymentId) Get payment information
retrofit2.Call<PaymentsList>	getPayments(String requestId, String currency, OffsetDateTime endTime, Integer maxCount, String merchantOrderId, String paymentMethod, String sortOrder, OffsetDateTime startTime) Get payments information
retrofit2.Call<PaymentUpdateResponse>	updatePayment(String paymentId, PaymentPatchRequest paymentPatchRequest) Update payment

Method Detail

createPayment

@Headers(value="Content-Type:application/json")
 @POST(value="api/payments")
retrofit2.Call<PaymentCreationResponse> createPayment(@Body
                                                                                                                                   PaymentRequest paymentRequest)

Create payment Endpoint for creation payments. Request example presented for Gateway mode.

Parameters:

paymentRequest - paymentRequest (required)

Returns:

Call<PaymentCreationResponse>

getPayment

@GET(value="api/payments/{paymentId}")
retrofit2.Call<PaymentResponse> getPayment(@Path(value="paymentId")
                                                                                  String paymentId)

Get payment information

Parameters:

paymentId - Payment ID (required)

Returns:

Call<PaymentResponse>

getPayments

@GET(value="api/payments")
retrofit2.Call<PaymentsList> getPayments(@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 payments 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) (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<PaymentsList>

updatePayment

@Headers(value="Content-Type:application/json")
 @PATCH(value="api/payments/{paymentId}")
retrofit2.Call<PaymentUpdateResponse> updatePayment(@Path(value="paymentId")
                                                                                                                                              String paymentId,
                                                                                                                                              @Body
                                                                                                                                              PaymentPatchRequest paymentPatchRequest)

Update payment

Parameters:

paymentId - Payment ID (required)

paymentPatchRequest - paymentPatchRequest (required)

Returns:

Call<PaymentUpdateResponse>