Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetAgreementPaymentRequest

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


{
   "agreementId": "string",
   "paymentRequestId": "string"
}

Request Parameters

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

agreementId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_/-]+

Required: Yes

paymentRequestId

The identifier of the payment request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: pr-[a-zA-Z0-9]+

Required: Yes

Response Syntax


{
   "agreementId": "string",
   "chargeAmount": "string",
   "chargeId": "string",
   "createdAt": number,
   "currencyCode": "string",
   "description": "string",
   "name": "string",
   "paymentRequestId": "string",
   "status": "string",
   "statusMessage": "string",
   "updatedAt": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

agreementId

The unique identifier of the agreement associated with this payment request. Use DescribeAgreement to retrieve full agreement details.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_/-]+

chargeAmount

The amount charged or to be charged to the buyer.

Type: String

Pattern: [0-9]*(\.[0-9]{0,8})?

chargeId

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]+.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ch-[a-zA-Z0-9]+

createdAt

The date and time when the payment request was created, in ISO 8601 format.

Type: Timestamp

currencyCode

The currency code for the charge amount.

Type: String

Length Constraints: Fixed length of 3.

Pattern: [A-Z]+

description

The detailed description of the payment request, if provided.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Pattern: .+

name

The descriptive name of the payment request.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 64.

Pattern: .+

paymentRequestId

The unique identifier of the payment request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: pr-[a-zA-Z0-9]+

status

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.

Type: String

statusMessage

An optional message providing additional context about the payment request status, such as a rejection reason or validation failure details.

Type: String

updatedAt

The date and time when the payment request was last updated, in ISO 8601 format.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

User does not have sufficient access to perform this action.

requestId: The unique identifier for the error.

HTTP Status Code: 400

InternalServerException

Unexpected error during processing of request.

requestId: The unique identifier for the error.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

requestId: The unique identifier for the error.
resourceId: The unique identifier for the resource.
resourceType: The type of resource.

HTTP Status Code: 400

ThrottlingException

Request was denied due to request throttling.

requestId: The unique identifier for the error.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by the service.

fields: The fields associated with the error.
reason: The reason associated with the error.
requestId: The unique identifier associated with the error.

HTTP Status Code: 400

Examples

Sample request

This example illustrates one usage of GetAgreementPaymentRequest.


{
    "paymentRequestId": "prEXAMPLE-1bb7-5f53-9826-7b2EXAMPLE06",
    "agreementId": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95"
}

Sample response

This example illustrates one usage of GetAgreementPaymentRequest.


{
    "paymentRequestId": "prEXAMPLE-1bb7-5f53-9826-7b2EXAMPLE06",
    "agreementId": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95",
    "status": "APPROVED",
    "statusMessage": null,
    "name": "Q1 2024 Usage Charges",
    "description": "Payment request for Q1 2024 usage charges for premium support services",
    "chargeId": "chEXAMPLE-4dd9-7h75-1048-9d4EXAMPLE28",
    "chargeAmount": "1250.50",
    "currencyCode": "USD",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-16T11:45:00.000Z"
}