# List Delivery Attempts for a Payment Link

When a Payment Link is submitted, a Delivery Attempt associated with the payment link is created. Use this endpoint to retrieve a list of delivery attempts for a specific payment link.

Endpoint: GET /payment_links/{payment_link_id}/delivery-attempts
Version: 2022-02-01
Security: BasicAuth

## Path parameters:

  - `payment_link_id` (string, required)
    The ID of the Payment Link to retrieve delivery attempts for.

## Header parameters:

  - `Finix-Version` (string)
    Specify the API version of your request. For more details, see Versioning.
    Example: "2022-02-01"

## Query parameters:

  - `after_cursor` (string)
    Return every resource created after the cursor value.

  - `before_cursor` (string)
    Return every resource created before the cursor value.

  - `created_at.gte` (string)
    Filter where created_at is after the given date.
    Example: "2022-09-27T11:21:23"

  - `created_at.lte` (string)
    Filter where created_at is before the given date.
    Example: "2026-09-27T11:21:23"

  - `limit` (integer)
    The numbers of items to return.
    Example: 10

## Response 200 fields (application/json):

  - `_embedded` (object)

  - `_embedded.delivery_attempts` (array)

  - `_embedded.delivery_attempts.id` (string)
    The ID of the Delivery Attempt resource.

  - `_embedded.delivery_attempts.created_at` (string)
    Timestamp of when the object was created.

  - `_embedded.delivery_attempts.updated_at` (string)
    Timestamp of when the object was last updated.

  - `_embedded.delivery_attempts.destination` (string)
    The delivery attempt destination.

  - `_embedded.delivery_attempts.entity_id` (string)
    The ID of the Payment Link that initiated the Delivery Attempt.

  - `_embedded.delivery_attempts.entity_type` (string)
    The type of entity that initiated the Delivery Attempt.
    Enum: "PAYMENT_LINK"

  - `_embedded.delivery_attempts.type` (string)
    The type of delivery method used.
    Enum: "EMAIL", "SMS", "PRINT"

  - `_embedded.delivery_attempts.state` (string)
    Whether the delivery attempt succeeded or failed.
    Enum: "SUCCEEDED", "FAILED"

  - `_links` (object)

  - `_links.self` (object)
    Link to the resource that was used in the request.

  - `_links.self.href` (string)

  - `_links.next` (object)
    Link to the next page of entries.

  - `page` (object)
    Details the page that's returned.

  - `page.limit` (integer)
    The number of entries to return.

  - `page.next_cursor` (string,null)
    The cursor to use for the next page of results.

## Response 401 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.source` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.source.href` (string)
    URL of the related resource.

## Response 403 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.source` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.source.href` (string)
    URL of the related resource.

## Response 404 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.source` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.source.href` (string)
    URL of the related resource.

## Response 406 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.source` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.source.href` (string)
    URL of the related resource.

## Response 422 fields (application/json):

  - `total` (integer, required)
    Total number of errors returned.

  - `_embedded` (object, required)
    Container for embedded error objects.

  - `_embedded.errors` (array)
    List of individual error objects.

  - `_embedded.errors.code` (string)
    The error code. The UNKNOWN error code is returned for a 401 Unauthorized or 403 Forbidden request.

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)
    A human-friendly error message.

  - `_embedded.errors._links` (object)
    Links related to this error.

  - `_embedded.errors._links.source` (object)
    Link to the resource related to the error.

  - `_embedded.errors._links.source.href` (string)
    URL of the related resource.