public interface PaymentsApi
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<PaymentGatewayCreationResponse> |
createPayment(PaymentRequest paymentRequest)
Create payment
Endpoint for creation payments.
|
retrofit2.Call<AuthenticationDataResponse> |
getAuthenticationData1(String paymentId)
Get payment 3DS result information
|
retrofit2.Call<DisputeList> |
getDispute(String paymentId)
Get a list of disputes by payment id
|
retrofit2.Call<DisputeList> |
getDisputes(String requestId,
String type,
Integer maxCount,
Integer offset,
OffsetDateTime regEndTime,
OffsetDateTime regStartTime,
String sortOrder)
Get a list of disputes
|
retrofit2.Call<PaymentResponse> |
getPayment(String paymentId)
Get payment information
|
retrofit2.Call<TransactionMethodsList> |
getPaymentMethods(String requestId,
Boolean payoutMethodsOnly)
Get payment and payout methods
Endpoint to get payment and payout methods by current terminal code
|
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
|
@Headers(value="Content-Type:application/json") @POST(value="api/payments") retrofit2.Call<PaymentGatewayCreationResponse> createPayment(@Body PaymentRequest paymentRequest)
paymentRequest - paymentRequest (required)@GET(value="api/payments/{paymentId}/threedsecure")
retrofit2.Call<AuthenticationDataResponse> getAuthenticationData1(@Path(value="paymentId")
String paymentId)
paymentId - Payment ID (required)@GET(value="api/disputes/{paymentId}")
retrofit2.Call<DisputeList> getDispute(@Path(value="paymentId")
String paymentId)
paymentId - Payment ID (or refund ID, or recurring ID) (required)@GET(value="api/disputes") retrofit2.Call<DisputeList> getDisputes(@Query(value="request_id") String requestId, @Query(value="type") String type, @Query(value="max_count") Integer maxCount, @Query(value="offset") Integer offset, @Query(value="reg_end_time") OffsetDateTime regEndTime, @Query(value="reg_start_time") OffsetDateTime regStartTime, @Query(value="sort_order") String sortOrder)
requestId - Request ID (required)type - Defines dispute entity type: `CB` - for chargebacks `RR` - for retrieval requests `FR` - for fraud reports (required)maxCount - Limit number of returned dispute entities Must be less or equal to 1000, default is 100, minimal value is 1 (optional)offset - Starting position (offset) in the list of dispute entities. Must be less or equal to 10000, default is 0, minimal value is 0 (optional)regEndTime - Dispute registration date & time up to milliseconds (in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when requested period ends (inclusive); the default is current time UTC (format - yyyy-MM-dd'T'HH:mm:ss.SSS'Z') Must be less than 10 days after reg_start_time (optional)regStartTime - Dispute registration date & time up to milliseconds (in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when requested period starts (inclusive); the default is 24 hours before reg_end_time UTC (format - yyyy-MM-dd'T'HH:mm:ss.SSS'Z') (in UTC format) (optional)sortOrder - Sort based on order of results. `asc` for ascending order or `desc` for descending order (default value) by dispute registration date (optional)@GET(value="api/payments/{paymentId}")
retrofit2.Call<PaymentResponse> getPayment(@Path(value="paymentId")
String paymentId)
paymentId - Payment ID (required)@GET(value="api/payment_methods") retrofit2.Call<TransactionMethodsList> getPaymentMethods(@Query(value="request_id") String requestId, @Query(value="payout_methods_only") Boolean payoutMethodsOnly)
requestId - Request ID, not unique ID of request (required)payoutMethodsOnly - If `true` was received - **only** available payout methods section will be returned in response (without 'payment_methods' section). If `false` or absent - available payment and payout methods (both the sections) will be returned in response. (optional)@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)
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)@Headers(value="Content-Type:application/json")
@PATCH(value="api/payments/{paymentId}")
retrofit2.Call<PaymentUpdateResponse> updatePayment(@Path(value="paymentId")
String paymentId,
@Body
PaymentPatchRequest paymentPatchRequest)
paymentId - Payment ID (required)paymentPatchRequest - paymentPatchRequest (required)Copyright © 2021. All rights reserved.