Create referenced refund
Changed onUse this method to refund a bank transfer payment that is in a closed batch. For ACH payments, see Automated Clearing House (ACH) payments below before you use this method.
To refund a bank transfer payment, you need its paymentId. Our gateway returned the paymentId in the response of the Create Payment method.
Note: If you don’t have the paymentId, use our List Payments method to search for the bank transfer payment.
If your refund is successful, our gateway returns the payment amount to the customer's account.
Automated Clearing House (ACH) payments
For an ACH payment, this method succeeds only while the payment is in an open batch, and in that case our gateway reverses the payment instead of refunding it. After the batch closes, this method returns a 400 error, Bank transfer with status COMPLETE can not be refunded.
To return funds for an ACH payment that is in a closed batch, use our Create Refund method with the customer’s bank account details or a secure token.
This restriction doesn’t apply to pre-authorized debit (PAD) payments.
Things to consider
- If the merchant refunds a bank transfer payment that is in an open batch, our gateway reverses the bank transfer payment. In the response, transactionResult.type is payment and transactionResult.status is reversal.
- Some merchants can run unreferenced refunds, which means that they don’t need a paymentId to return an amount to a customer. For more information about how to run an unreferenced refund, go to Create Refund.
Request
- Base URLhttps://api.payroc.com/v1
- URLhttps://api.payroc.com/v1/bank-transfer-payments/{paymentId}/refund
- AuthHTTP bearer
Path parameters
Unique identifier that our gateway assigned to the payment.
Headers
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.
Request body
Response
Successful request. We refunded the payment.
Changes
- breaking
the
//response property's maxLength was increased from100to255for the response status
- breaking
- warning
deleted the
headerrequest parameterAuthorization - info
the endpoint scheme security
Bearerwas added to the API
- warning