Statuses
Status
The Payment Intent status field is used to determine whether or not a Payment Intent can be used to create a Payment by Plastiq Connect.
Payment Intent statuses:
| Status | Description |
|---|---|
| 'NOT_CAPTURABLE' | Payment Intent cannot be supported in its current form. |
| 'EXPIRED' | Payment Intent can no longer be fulfilled by the specified delivery date. |
| 'CAPTURABLE' | Payment Intent is supported and can be used to create a Payment. |
| 'CAPTURED' | Payment Intent has already been used to create a successfully processed Payment. |
Status Reasons
Status reasons represent feedback on the status of a given Payment Intent. If the status is NOT_CAPTURABLE or EXPIRED, there will be statusReasons containing details on how to resolve the status before creating a Payment. Each status reason object will have a code and a message.
Examples
{
"status": "NOT_CAPTURABLE",
"statusReasons": [
{
"code": "CARD_BRAND_BLOCK",
"message": "The card brand prohibits this payment type. Please try another card."
}
]
}
{
"status": "EXPIRED",
"statusReasons": [
{
"code": "DELIVERY_EXPIRATION_BLOCK",
"message": "The payment can no longer be fulfilled by the quoted delivery date. Please try to resubmit."
}
]
}
{
"status": "CAPTURABLE",
"statusReasons": []
}
{
"status": "CAPTURED",
"statusReasons": []
}
CAPTURABLE
CAPTURABLEThe Payment Intent is supported by Plastiq. statusReasons will present an empty array since no action is required for processing as a Payment.
CAPTURED
CAPTUREDThe Payment Intent was successfully processed as a Payment. The statusReasons array will be empty. To create another Payment, a new Payment Intent will need to be created first. Reusing a CAPTURED Payment Intent ID will result in a validation error.
EXPIRED
EXPIREDIf a Payment Intent has an EXPIRED status, the current time exceeds the expiresAt timestamp. Create a new Payment Intent with a later delivery date because Plastiq can no longer fulfill the delivery by the specified date.
| Code | Message |
|---|---|
DELIVERY_EXPIRATION_BLOCK | The payment can no longer be fulfilled by the quoted delivery date. Please try to resubmit. |
NOT_CAPTURABLE
NOT_CAPTURABLETo resolve a Payment Intent with a NOT_CAPTURABLE status, the Payment Intent or associated utilized resource will need to be updated. Below is a list of the possible status reason codes and messages for a Payment Intent with this status.
| Code | Message | Resolution |
|---|---|---|
| 'CARD_BRAND_BLOCK' | The card brand prohibits this payment type. Please try another card. | PATCH Payment Intents with a different Payment Method. The Recipient can be paid with a bank account or another card belonging to a different card brand. |
| 'CARD_ISSUER_BLOCK' | The card issuer prohibits this payment type. Please try another card. | PATCH Payment Intents with a different Payment Method. The Recipient can be paid with a bank account or another card belonging to a different card issuer. |
| 'UNSUPPORTED_PAYMENT_BLOCK' | The payment type is unsupported. Please try another card. | PATCH Payment Intents with a different Payment Method. The Recipient can be paid with a bank account or another card product. |
| 'PAYMENT_METHOD_INACTIVE' | This payment intent was created with an inactive payment method. Please use a valid payment method before submitting the payment intent. | PATCH Payers and provide valid Identity Document types and values. Plastiq Connect requires a Taxpayer Identification Number on file for Payer in Texas. |
| 'TEXAS_COMPLIANCE_BLOCK' | Texas Law requires the collection of a Taxpayer Identification Number (TIN) in order to process payments for payers domiciled in the state of Texas. Please provide a Taxpayer Identification Number (TIN) for the payer. | PATCH Payers and provide valid Identity Document types and values. Plastiq Connect requires a Taxpayer Identification Number on file for Payer in Texas. |
| 'DELIVERY_EXPIRATION_BLOCK' | The payment can no longer be fulfilled by the quoted delivery date. Please try to resubmit. | The Payment Intent Id is no longer usable, make a new call to POST Payment Intents to receive a new Payment Intent Id. |
| 'PAYMENT_AMOUNTS_ZERO_OR_NULL' | The payment does not have a valid payment amount to create a charge. | Patch Payment Intents with a targetAmountgreater than 0. |
Some status reasons may require updating the Payment Intent to use a new resource ID. For example, in the case of a CARD_BRAND_BLOCK code, the Payer will need to select a new card (Payment Method ID) before the status changes to CAPTURABLE.
Updated over 5 years ago