AgreementService / Client / get_agreement_payment_request

get_agreement_payment_request¶

AgreementService.Client.get_agreement_payment_request(**kwargs)¶

Retrieves detailed information about a specific payment request. Both sellers (proposers) and buyers (acceptors) can use this operation to view payment requests associated with their agreements. The response includes the current status, charge details, timestamps, and the charge ID if the request has been approved.

Note

The calling identity must be either the acceptor or proposer of the payment request. A ResourceNotFoundException is returned if the payment request does not exist.

Request Syntax

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

Parameters:

paymentRequestId (string) –
[REQUIRED]

The identifier of the payment request.
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',
    'statusMessage': 'string',
    'name': 'string',
    'description': 'string',
    'chargeId': '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 payment request.
- agreementId (string) –
  
  The unique identifier of the agreement associated with this payment request. Use DescribeAgreement to retrieve full agreement details.
- status (string) –
  
  The current status of the payment request. Possible values include:
  - VALIDATING – The payment request is being validated against agreement terms.
  - VALIDATION_FAILED – The payment request failed validation.
  - PENDING_APPROVAL – The payment request is awaiting buyer action.
  - APPROVED – The buyer has approved the payment request.
  - REJECTED – The buyer has rejected the payment request.
  - CANCELLED – The seller has cancelled the payment request.
- statusMessage (string) –
  
  An optional message providing additional context about the payment request status, such as a rejection reason or validation failure details.
- name (string) –
  
  The descriptive name of the payment request.
- description (string) –
  
  The detailed description of the payment request, if provided.
- chargeId (string) –
  
  The unique identifier of the charge created after the payment request is approved. This field is only present for approved payment requests and follows the pattern ch-[a-zA-Z0-9]+.
- chargeAmount (string) –
  
  The amount charged or to be charged to the buyer.
- currencyCode (string) –
  
  The currency code for the charge amount.
- createdAt (datetime) –
  
  The date and time when the payment request was created, in ISO 8601 format.
- updatedAt (datetime) –
  
  The date and time when the payment request was last updated, 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