PaymentRequestSummary
Summary view of a payment request.
Contents
Note
In the following list, the required parameters are described first.
- 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_/-]+Required: No
- chargeAmount
-
The amount charged or to be charged to the buyer.
Type: String
Pattern:
[0-9]*(\.[0-9]{0,8})?Required: No
- chargeId
-
The unique identifier of the charge created after the payment request is approved. This field is only present for approved payment requests.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
ch-[a-zA-Z0-9]+Required: No
- createdAt
-
The date and time when the payment request was created.
Type: Timestamp
Required: No
- currencyCode
-
The currency code for the charge amount.
Type: String
Length Constraints: Fixed length of 3.
Pattern:
[A-Z]+Required: No
- name
-
The descriptive name of the payment request.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 64.
Pattern:
.+Required: No
- 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]+Required: No
- status
-
The current status of the payment request. Possible values include
VALIDATING,VALIDATION_FAILED,PENDING_APPROVAL,APPROVED,REJECTED, andCANCELLED.Type: String
Valid Values:
VALIDATING | VALIDATION_FAILED | PENDING_APPROVAL | APPROVED | REJECTED | CANCELLEDRequired: No
- updatedAt
-
The date and time when the payment request was last updated.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
