Skip to main content

Get Payment Notification

GET 
/api/payment-notifications/:messageId

Get a payment event notification by message id.

See Custodial Funding Protocol for details about payment event notifications.

Request​

Path Parameters

    messageId stringrequired

    Payment notification message id.

Responses​

Successful operation

Schema

    id stringrequired

    Payment notification primary identifier.

    accountId stringrequired

    Cardholder account this payment notification belongs to.

    fundingSourceId stringrequired

    Funding Source this payment notification belongs to.

    createdAt stringrequired

    Timestamp of payment notification creation.

    paymentId stringrequired

    Payment id this notification belongs to.

    attempts numberrequired

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

    delivered booleanrequired

    Payment notification has been delivered successfully to the partner webhook.

    lastDelivery

    object

    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.

    requestBody object

    Payment notification payload sent to the partner webhook.

    requestUrl string

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

    requestTimestamp string

    Timestamp of payment notification last delivery request.

    responseBody object

    The partner webhook response to this payment notification last delivery.

    responseStatus number

    HTTP Response status code of this payment notification last delivery

    responseTimestamp string

    Timestamp of Payment Notification last delivery response.

    duration number

    Number of milliseconds between the request and response

Loading...