extendedPreauthorizations

List Extended Preauthorizations for a User

Changed on
get/v2.01/{ClientId}/users/{UserId}/extended-preauthorizations

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/users/{UserId}/extended-preauthorizations
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

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

UserIdstring required

Query parameters

ResultCodestring

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

Statusstring

Allowed values: CREATED, SUCCEEDED, FAILED

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

PaymentStatusstring required

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

Changes