Intents

List all Intents

Changed on

Retrieve a paginated list of Intents, with optional filters for provider, currency, date range, and status.

get/v3.0/{ClientId}/payins/intents

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v3.0/{ClientId}/payins/intents
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

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

Query parameters

BeforeDateinteger

The date before which the object was created (based on the object's CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

AfterDateinteger

The date after which the object was created (based on the object's CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

Statusstring

Allowed values: AUTHORIZED, CAPTURED, PARTIALLY_CAPTURED, REFUNDED, REFUND_REVERSED, DISPUTED, DISPUTED_WON, DISPUTED_LOST, DEFENDED, CANCELLED

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

ExternalProviderNamestring

The third-party PSP name to filter by.

Currencystring

The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> of the currency to filter by.

pageinteger

Start value: 1

Default value: 1

Indicates the index of the page for the pagination.

per_pageinteger

Min. value: 1; max. value: 100

Default value: 10

Indicates the number of items returned for each page of the pagination.

Response

Success

Idstring

The unique identifier of the intent.

Amountinteger

The full amount authorized in the Intent.

Currencystring

The currency of the intent.

Statusstring

The status of the Intent.

Intent Status values:

  • AUTHORIZED – The Intent Amount was authorized for acquisition by the PSP and can be captured or canceled.
  • PARTIALLY_CAPTURED – Part of the Intent Amount from one or more LineItems was captured.
  • CAPTURED – All of the Intent Amount was captured.
  • CANCELLED – All of the Intent Amount was canceled.
  • REFUNDED – All of the CapturedAmount of all LineItems was refunded.
  • REFUND_REVERSED – The refund could not be completed and the funds were returned to the platform.
  • DISPUTED – All of the CapturedAmount of all LineItems was disputed.
  • DEFENDED – The dispute is being defended by the platform.
  • DISPUTED_WON – The dispute was resolved in favor of the platform.
  • DISPUTED_LOST – The dispute was resolved against the platform.
CreationDateinteger

The date and time the Intent was created.

ExecutionDateinteger nullable

Unix timestamp (UTC) of the date and time the Intent moved to AUTHORIZED.

Changes