resendPaymentRequest

Overview

This mutation takes the ID of a payment request and sends the request again.

Special Considerations

  • Must input the ID of a payment request.

Inputs

MutationResendPaymentRequestArgs

Required Data

paymentRequestId: string

Returns

Promise<SuccessResult>

A promise containing a success message.

Example

Running this mutation:

mutation {
  resendPaymentRequest(data: {
    paymentRequestId: "ckbb6fstg005y0716qca3aa8y"
  }) {
    message
  }
}

Gives us:

{
  "data": {
    "resendPaymentRequest": {
      "message": "Payment Request sent."
    }
  }
}

Common Errors

When running this mutation some of the common errors encountered include:

  • This payment request does not have a recipient. (I-4604)
    • The given ID returned a payment request that cannot be resent. Check your payment request ID.
← requestPaymentsubmitPaymentSession →