AgreementService / Client / cancel_agreement_payment_request

cancel_agreement_payment_request¶

AgreementService.Client.cancel_agreement_payment_request(**kwargs)¶

Allows sellers (proposers) to cancel a payment request that is in PENDING_APPROVAL status. Once cancelled, the payment request transitions to CANCELLED status and can no longer be accepted or rejected by the buyer.

Note

Only payment requests in PENDING_APPROVAL status can be cancelled. A ConflictException is thrown if the payment request is in any other status.

Request Syntax

response = client.cancel_agreement_payment_request(
    paymentRequestId='string',
    agreementId='string'
)

Parameters:

paymentRequestId (string) –
[REQUIRED]

The unique identifier of the payment request to cancel.
agreementId (string) –
[REQUIRED]

The unique identifier of the agreement associated with the payment request.

Return type:

dict

Returns:

Response Syntax

{
    'paymentRequestId': 'string',
    'agreementId': 'string',
    'status': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED',
    'name': 'string',
    'description': 'string',
    'chargeAmount': 'string',
    'currencyCode': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- paymentRequestId (string) –
  
  The unique identifier of the cancelled payment request.
- agreementId (string) –
  
  The unique identifier of the agreement associated with this payment request.
- status (string) –
  
  The updated status of the payment request, which is CANCELLED.
- name (string) –
  
  The descriptive name of the payment request.
- description (string) –
  
  The detailed description of the payment request, if provided.
- chargeAmount (string) –
  
  The amount that was requested to be charged.
- currencyCode (string) –
  
  The currency code for the charge amount.
- createdAt (datetime) –
  
  The date and time when the payment request was originally created, in ISO 8601 format.
- updatedAt (datetime) –
  
  The date and time when the payment request was cancelled, in ISO 8601 format.

Exceptions

AgreementService.Client.exceptions.ValidationException
AgreementService.Client.exceptions.AccessDeniedException
AgreementService.Client.exceptions.ResourceNotFoundException
AgreementService.Client.exceptions.ThrottlingException
AgreementService.Client.exceptions.InternalServerException
AgreementService.Client.exceptions.ConflictException