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

CancelAgreementPaymentRequest

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


{
   "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 unique identifier of the payment request to cancel.

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",
   "createdAt": number,
   "currencyCode": "string",
   "description": "string",
   "name": "string",
   "paymentRequestId": "string",
   "status": "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.

Type: String

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

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

chargeAmount

The amount that was requested to be charged.

Type: String

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

createdAt

The date and time when the payment request was originally 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 cancelled payment request.

Type: String

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

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

status

The updated status of the payment request, which is CANCELLED.

Type: String

updatedAt

The date and time when the payment request was cancelled, 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

ConflictException

The request could not be completed due to a conflict with the current state of the resource.

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

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 CancelAgreementPaymentRequest.


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

Sample response

This example illustrates one usage of CancelAgreementPaymentRequest.


{
    "paymentRequestId": "prEXAMPLE-1bb7-5f53-9826-7b2EXAMPLE06",
    "agreementId": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95",
    "status": "CANCELLED",
    "name": "Q1 2024 Usage Charges",
    "description": "Payment request for Q1 2024 usage charges for premium support services",
    "chargeAmount": "1250.50",
    "currencyCode": "USD",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-16T09:15:00.000Z"
}