payments

Close return

Changed on

Use this method to close a return if the customer used an alternative payment method to resolve a returned payment.

To close a return, you need the paymentId of the return. To get the paymentId of the return, complete the following steps:

  1. Use our Retrieve Payment method to view the details of the original payment.
  2. From the returns object in the response, get the paymentId of the return.

If your request is successful, our gateway closes the return.

post/bank-transfer-payments/{paymentId}/close

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/bank-transfer-payments/{paymentId}/close
  • Auth
    HTTP bearer

Path parameters

paymentIdstring required

Unique identifier that our gateway assigned to the payment.

Headers

Idempotency-Keystring uuid required

Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.

Response

Successful request. We closed the return.

paymentIdstring required

Unique identifier that we assigned to the payment.

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

Changes

  • 817f57a896f3Revision changes
    • breaking

      the // response property's maxLength was increased from 100 to 255 for the response status

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API