Skip to navigation
Card pay-insExtended Preauthorizations

List Extended Preauthorizations for a User

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Path parameters

ClientIdstringRequired
Platform's API account identifier, associated with the API key.
UserIdstringRequired

Query parameters

ResultCodestringOptional
The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.
StatusstringOptional

Allowed values: CREATED, SUCCEEDED, FAILED

The status of the transaction. You can filter on multiple values by separating them with a comma.

PaymentStatusstringRequired

Allowed values: WAITING, CANCELED, CANCEL_REQUESTED, EXPIRED, VALIDATED, FAILED

The payment status of the extended preauthorization object:

  • WAITING – The extended preauthorization can be used: the preauthorized funds can be captured (if Status is SUCCEEDED) or the preauthorization can be canceled manually.
  • CANCELED – Value to pass to manually cancel the extended preauthorization before use; indicates that the extended preauthorization was canceled manually.
  • CANCEL_REQUESTED – The cancellation of the extended preauthorization has been requested but not yet processed.
  • EXPIRED – The hold period on the preauthorized funds has ended without it being used.
  • VALIDATED – Indicates that the preauthorized funds were captured.
  • FAILED – The pay-in against the preauthorization has failed, but a retry may be possible.

Response

Success
Cardobject

Response if Extended Preauthorization's PaymentType is CARD.

OR
PayPalobject

Response if Extended Preauthorization's PaymentType is PAYPAL.