Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
/*
* payments_inquireBatchPayment
* Query the latest payment and transaction results of all sub-orders in a batch.
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/

package com.alipay.global.api.model.ams;

import java.util.List;
import lombok.*;

/** AmsInquiryPaymentResult */
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class AmsInquiryPaymentResult {

/** Merchant-assigned sub-order payment request ID (maximum 64 characters). */
private String paymentRequestId;

/** Antom-assigned sub-order payment ID (maximum 64 characters). */
private String paymentId;

private Amount paymentAmount;

/**
* Payment status (maximum 16 characters), returned on successful inquiry. SUCCESS: succeeded;
* FAIL: failed; PROCESSING: processing; CANCELLED: canceled; PENDING: payment complete, final
* result pending. SUCCESS, FAIL and CANCELLED are final; PROCESSING and PENDING are intermediate.
* Every sub-order in a batch shares the same payment status.
*/
private String paymentStatus;

/**
* Sub-order result code (maximum 64 characters), returned on successful inquiry. Applicable
* codes: SUCCESS (Payment succeeded); ACCESS_DENIED (Access denied); CURRENCY_NOT_SUPPORT
* (Currency not supported); FRAUD_REJECT (Risk control prevents further processing); INVALID_API
* (API invalid or inactive); INVALID_CARD (Invalid card); ORDER_NOT_EXIST (Order does not exist);
* INVALID_EXPIRY_DATE_FORMAT (Invalid card expiry year or month format);
* ISSUER_REJECTS_TRANSACTION (Issuer rejected transaction); INVALID_ACCESS_TOKEN (Access token
* expired, revoked, or absent); INVALID_MERCHANT_STATUS (Restricted merchant status);
* KEY_NOT_FOUND (Antom or merchant key not found); MERCHANT_KYB_NOT_QUALIFIED (Merchant KYB
* status disqualifies payment); NO_INTERFACE_DEF (Interface undefined); NO_PAY_OPTIONS (No
* payment options available); ORDER_IS_CLOSED (Payment request ID matches a closed transaction);
* PARAM_ILLEGAL (Missing or invalid parameter); PAYMENT_AMOUNT_EXCEED_LIMIT (Amount exceeds
* contract or payment method limit); PAYMENT_COUNT_EXCEED_LIMIT (Payment count exceeds payment
* method limit); PAYMENT_NOT_QUALIFIED (Merchant not eligible for payment); PROCESS_FAIL (General
* business failure); RISK_REJECT (Risk control prevents further processing); SUSPECTED_CARD (Card
* suspected of fraud); SUSPECTED_RISK (Suspected security risk prevents further processing);
* SYSTEM_ERROR (System error); USER_AMOUNT_EXCEED_LIMIT (Amount exceeds user payment limit);
* USER_BALANCE_NOT_ENOUGH (Insufficient user balance); USER_KYC_NOT_QUALIFIED (User KYC status
* disqualifies payment); USER_PAYMENT_VERIFICATION_FAILED (User restricted from payment at
* provider); USER_STATUS_ABNORMAL (User status abnormal at provider); PAYMENT_IN_PROCESS (Payment
* processing); UNKNOWN_EXCEPTION (API call failed for an unknown reason); CARD_NOT_SUPPORTED
* (Card not supported for transaction); INVALID_EXPIRATION_DATE (Invalid card expiration date);
* INVALID_CARD_NUMBER (Invalid card number); DO_NOT_HONOR (Issuer declined payment).
*/
private String paymentResultCode;

/**
* Message explaining the sub-order result code (maximum 256 characters); returned on successful
* inquiry.
*/
private String paymentResultMessage;

private PaymentResultInfo paymentResultInfo;

/** Transaction details returned when a refund or capture exists. */
private List<BatchPaymentTransaction> transactions;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/*
* payments_inquireBatchPayment
* Query the latest payment and transaction results of all sub-orders in a batch.
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/

package com.alipay.global.api.model.ams;

import com.alipay.global.api.model.Result;
import lombok.*;

/** BatchPaymentTransaction */
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class BatchPaymentTransaction {

private Result transactionResult;

/**
* Antom-assigned transaction ID (maximum 64 characters); equals refundId for REFUND and captureId
* for CAPTURE.
*/
private String transactionId;

/**
* Transaction type (maximum 16 characters). REFUND: refund; CAPTURE: capture; INCREMENTAL:
* incremental amount adjustment.
*/
private String transactionType;

/**
* Transaction status (maximum 16 characters). SUCCESS: succeeded; FAIL: failed; PROCESSING:
* processing; CANCELLED: canceled.
*/
private String transactionStatus;

private Amount transactionAmount;

/**
* Merchant-assigned transaction request ID (maximum 64 characters); equals refundRequestId for
* REFUND and captureRequestId for CAPTURE.
*/
private String transactionRequestId;
}
11 changes: 5 additions & 6 deletions src/main/java/com/alipay/global/api/model/ams/Buyer.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@
public class Buyer {

/**
* Comma-separated invoice and offline receipt PDF locales for createPaymentSession, such as
* ja-JP,en-US. First supported locale wins, with English fallback. Does not select email
* language. Omit in APIs that do not document support.
* Ordered PDF-language preferences for createPaymentSession. Omitted, null, empty or unsupported
* preferences use English. Does not read or update customer preferences or select Checkout UI or
* email language. Omit in APIs that do not document support.
*/
private String preferredLocales;
private List<String> preferredLocales;

/**
* Business name for createPaymentSession. Required when buyerType is B. Not persisted by
Expand Down Expand Up @@ -61,8 +61,7 @@ public class Buyer {
* The email of the buyer. Specify this parameter: When you require risk control. When the value
* of paymentMethodType is CARD. Providing this information helps to increase the accuracy of
* anti-money laundering and fraud detection, and increase payment success rates. More
* information: Maximum length: 64 characters For the DingTalk createPaymentSession integration, a
* valid buyer email is required and the maximum length is 128 characters.
* information: Maximum length: 64 characters
*/
private String buyerEmail;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ public class BuyerTaxId {
private String country;

/**
* Optional ISO 3166-2 issuing state or province subdivision code. Maximum length: 10 characters.
* Optional tax ID subdivision information. The accepted format and length depend on the API. The
* supplied value is transmitted unchanged.
*/
private String region;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,34 +28,37 @@ public class InvoiceCustomerDetails {
*/
private String email;

/** B (business) or C (consumer). If omitted, uses the matched customer type, otherwise C. */
/**
* B (business) or C (consumer). Omitted or null values default to C on the server, regardless of
* an existing customer profile.
*/
private String customerType;

/**
* Effective business name required for type B. Omitted values may come from the matched customer;
* its profile is not overwritten.
* Business name supplied for this invoice. For type B, provide a nonblank value in the request;
* an existing customer profile does not supply it.
*/
private String businessName;

/**
* Effective first name required for type C; may use the matched customer value when omitted.
* Optional contact name for type B.
* First name supplied for this invoice. For type C, provide a nonblank value in the request; an
* existing customer profile does not supply it. Optional contact name for type B.
*/
private String firstName;

/**
* Effective last name required for type C; may use the matched customer value when omitted.
* Optional contact name for type B.
* Last name supplied for this invoice. For type C, provide a nonblank value in the request; an
* existing customer profile does not supply it. Optional contact name for type B.
*/
private String lastName;

private CustomerBusinessAddress businessAddress;

/**
* Comma-separated invoice and offline receipt PDF locales, such as ja-JP,en-US. First supported
* locale wins, with English fallback. Does not select email language.
* Ordered invoice and offline receipt PDF-language preferences. Omit or use null to retain stored
* customer preferences; an empty array uses English. Does not select email language.
*/
private String preferredLocales;
private List<String> preferredLocales;

/**
* Tax IDs saved for invoice and offline receipt PDF display. Omit to use stored customer IDs; an
Expand Down
5 changes: 3 additions & 2 deletions src/main/java/com/alipay/global/api/model/ams/Order.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@
public class Order {

/**
* For createPaymentSession, request a receipt email after successful payment. Defaults to false
* on the server. Omit in APIs that do not document support.
* For createPaymentSession, false suppresses automatic receipt email only. True, null or omission
* retain the existing eligible post-payment email rules. Does not suppress receipt PDF creation
* or guarantee email delivery. Omit in APIs that do not document support.
*/
private Boolean sendReceipt;

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
/*
* payments_inquireBatchPayment
* Query the latest payment and transaction results of all sub-orders in a batch.
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/

package com.alipay.global.api.request.ams.pay;

import com.alipay.global.api.model.ams.*;
import com.alipay.global.api.request.AlipayRequest;
import com.alipay.global.api.response.ams.pay.AlipayInquireBatchPaymentResponse;
import lombok.*;

/** AlipayInquireBatchPaymentRequest */
@EqualsAndHashCode(callSuper = true)
@Data
public class AlipayInquireBatchPaymentRequest
extends AlipayRequest<AlipayInquireBatchPaymentResponse> {

/**
* Merchant-assigned batch request ID (maximum 64 characters), the only accepted query key.
* paymentId and paymentRequestId are not query keys. Repeating a query has no additional effects
* but returns the latest visible state, not a fixed response.
*/
private String batchPaymentRequestId;

public AlipayInquireBatchPaymentRequest() {
this.setPath("/ams/api/v1/payments/inquireBatchPayment");
}

@Override
public Class<AlipayInquireBatchPaymentResponse> getResponseClass() {
return AlipayInquireBatchPaymentResponse.class;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
/*
* payments_inquireBatchPayment
* Query the latest payment and transaction results of all sub-orders in a batch.
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/

package com.alipay.global.api.response.ams.pay;

import com.alipay.global.api.model.ams.*;
import com.alipay.global.api.model.ams.Amount;
import com.alipay.global.api.model.ams.PspCustomerInfo;
import com.alipay.global.api.model.ams.RedirectActionForm;
import com.alipay.global.api.response.AlipayResponse;
import java.util.List;
import lombok.*;

/** AlipayInquireBatchPaymentResponse */
@EqualsAndHashCode(callSuper = true)
@Data
public class AlipayInquireBatchPaymentResponse extends AlipayResponse {

/** Echo of queried batch ID (maximum 64 characters), returned when result.resultStatus is S. */
private String batchPaymentRequestId;

private Amount paymentAmount;

/** Batch payment creation time in ISO 8601 format, returned on successful inquiry. */
private String paymentCreateTime;

/**
* Payment method type (maximum 64 characters), for example ALIPAY_CN; returned with Checkout Page
* integration.
*/
private String paymentMethodType;

private RedirectActionForm redirectActionForm;

private PspCustomerInfo pspCustomerInfo;

/**
* ISO 8601 time when the batch payment reached final success; the start of cancellation and
* refund eligibility periods.
*/
private String paymentTime;

/** Authorization expiration time, returned when paymentMethodType is CARD. */
private String authExpirytime;

private Amount customsDeclarationAmount;

/** Sub-order payment summaries, returned when result.resultStatus is S. */
private List<AmsInquiryPaymentResult> paymentResults;
}
Loading