reject_agreement_payment_request
async
¶
reject_agreement_payment_request(
payment_request_id: PaymentRequestId,
agreement_id: AgreementId,
*,
config_overrides: Optional[AsyncMarketplaceAgreementClientConfig] = None,
rejection_reason: Optional[PaymentRequestRejectionReason] = None,
) -> RejectAgreementPaymentRequestOutput
Allows buyers (acceptors) to reject a payment request that is in PENDING_APPROVAL status. Once rejected, the payment request transitions to REJECTED status and cannot be accepted. Buyers can optionally provide a reason for the rejection.
Only payment requests in PENDING_APPROVAL status can be rejected. A ConflictException is thrown if the payment request is in any other status.
Parameters:
-
payment_request_id(PaymentRequestId) –The unique identifier of the payment request to reject.
-
agreement_id(AgreementId) –The unique identifier of the agreement associated with the payment request.
-
rejection_reason(Optional[PaymentRequestRejectionReason], default:None) –An optional reason for rejecting the payment request (1-250 characters). This message is visible to the seller.
Raises:
-
AccessDeniedException–User does not have sufficient access to perform this action.
-
ConflictException–Request was denied due to a resource conflict.
-
InternalServerException–Unexpected error during processing of request.
-
ResourceNotFoundException–Request references a resource which does not exist.
-
ThrottlingException–Request was denied due to request throttling.
-
ValidationException–The input fails to satisfy the constraints specified by the service.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_marketplace_agreement/_services/async_marketplace_agreement.py
1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 | |