Immersve Docs
GithubX

List Payment Notifications

get/api/accounts/{partnerAccountId}/payment-notifications

List payment event notifications for the given accountId. This endpoint is exclusively intended for accounts operating under the custodial funding mode. The notification account id will be the same as the partner account that owns the Card Program for the payments. See Custodial Funding Protocol for details about payment event notifications. Results are paginated and ordered by descending createdAt date.

Request

Path Parameters

  • partnerAccountIdstringrequired

    Partner account id.

Query Parameters

  • limitnumber

    Amount of records to return (max 100).

  • cursorstring

    Cursor to retrieve the next page.

  • createdFromstring

    Filter for transactions from this date (inclusive). Value should be a ISO 8601 string.

  • createdTostring

    Filter for transactions up to this date (inclusive). Value should be a ISO 8601 string.

Response

Successful operation.

Body application/json

  • itemsobject[]

    Items

    • idstringrequired

      Payment notification primary identifier.

    • accountIdstringrequired

      Cardholder account this payment notification belongs to.

    • fundingSourceIdstringrequired

      Funding Source this payment notification belongs to.

    • createdAtstringrequired

      Timestamp of payment notification creation.

    • paymentIdstringrequired

      Payment id this notification belongs to.

    • attemptsnumberrequired

      Number of times this payment notification was attempted to be delivered.

    • deliveredbooleanrequired

      Payment notification has been delivered successfully to the partner webhook.

    • lastDeliveryobject

      Last delivery attempt details. This can be empty if the payment notification is still scheduled for delivery. Response fields can be empty if there is no response from the partner webhook yet.

      • requestBodyobject

        Payment notification payload sent to the partner webhook.

      • requestUrlstring

        The url of the partner webhook this payment notification was attempted to be delivered to.

      • requestTimestampstring

        Timestamp of payment notification last delivery request.

      • responseBodyobject

        The partner webhook response to this payment notification last delivery.

      • responseStatusnumber

        HTTP Response status code of this payment notification last delivery

      • responseTimestampstring

        Timestamp of Payment Notification last delivery response.

      • durationnumber

        Number of milliseconds between the request and response

  • pageInfoobject

    Page info for paginated results, undefined if no page info

    • nextCursorstring

      Cursor for next page, undefined if no more pages