# Reverse a bank transfer payment

Reverse a bank transfer payment in an open batch by sending a POST request to the Bank Transfer Payments reverse endpoint with the paymentId.

**Prerequisites:** [Authentication](/api/authentication)

If a customer requests a refund and the payment is still in an open batch, the merchant can use their POS to look up the bank transfer payment and cancel the transaction.

To find the paymentId of the bank transfer payment that the merchant wants to reverse, they can retrieve a list of all the bank transfer payments that meet the search criteria that the merchant provides. They can then find the transaction that they want in the list of returned results.

**Note:** If the merchant runs a referenced refund on a bank transfer payment that is in an open batch, our gateway automatically reverses the payment.

<a id="integration-steps"></a>
## Integration steps

**Step 1.** (Optional) List bank transfer payments.  
**Step 2.** Reverse the bank transfer payment.

<a id="before-you-begin"></a>
## Before you begin

[Authenticate your requests](/api/authentication) before making API calls. If your request fails, see [Errors](/api/errors).

<a id="headers"></a>
### Headers

To create the header of each GET request, you must include the following parameters:

- **Content-Type:** Include application/json as the value for this parameter.
- **Authorization:** Include your Bearer token in this parameter.

```bash
curl
-H "Content-Type: application/json"
-H "Authorization: <Bearer token>"
```

To create the header of each POST request, you must include the following parameters:

- **Content-Type:** Include application/json as the value for this parameter.
- **Authorization:** Include your Bearer token in this parameter.
- **Idempotency-Key:** Include a UUID v4 to make the request idempotent.

```bash
curl
-H "Content-Type: application/json"
-H "Authorization: <Bearer token>"
-H "Idempotency-Key: <UUID v4>"
```

<a id="errors"></a>
### Errors

If your request is unsuccessful, we return an error. For more information about errors, see [Errors](/api/errors).

<a id="step-1-optional-list-bank-transfer-payments"></a>
## Step 1. (Optional) List bank transfer payments

To retrieve a list of bank transfer payments, send a GET request to our Bank Transfer Payments endpoint.

Use our filters to narrow down the search results.

| Environment | URL |
| --- | --- |
| Test | [https://api.uat.payroc.com/v1/bank-transfer-payments](https://api.uat.payroc.com/v1/bank-transfer-payments) |
| Production | [https://api.payroc.com/v1/bank-transfer-payments](https://api.payroc.com/v1/bank-transfer-payments) |

<a id="request-parameters"></a>
### Request parameters

To create the body of your request, use the following parameters:

<a id="schema-requestquery"></a>
### Schema (`request.query`)

[Query parameters for `GET /bank-transfer-payments`](/api/list-bank-transfer-payments)

<a id="example-request"></a>
### Example request

<a id="request"></a>
### Request

GET [https://api.payroc.com/v1/bank-transfer-payments](https://api.payroc.com/v1/bank-transfer-payments)

**`Bank Transfer Payment`**

```curl
curl -G https://api.payroc.com/v1/bank-transfer-payments \
     -H "Authorization: Bearer <token>" \
     -d after=8516 \
     -d before=2571 \
     --data-urlencode dateFrom=2024-07-01T00:00:00Z \
     --data-urlencode dateTo=2024-07-31T23:59:59Z \
     -d last4=7890 \
     -d limit=25 \
     --data-urlencode nameOnAccount=Sarah%20Hazel%20Hopper \
     -d orderId=OrderRef6543 \
     -d paymentLinkId=JZURRJBUPS \
     -d processingTerminalId=1234001 \
     -d settlementDate=2024-07-15 \
     -d settlementState=settled \
     -d status=ready \
     -d type=payment
```

**`Bank Transfer Payment`**

```python
import requests

url = "https://api.payroc.com/v1/bank-transfer-payments"

querystring = {"after":"8516","before":"2571","dateFrom":"2024-07-01T00:00:00Z","dateTo":"2024-07-31T23:59:59Z","last4":"7890","limit":"25","nameOnAccount":"Sarah%20Hazel%20Hopper","orderId":"OrderRef6543","paymentLinkId":"JZURRJBUPS","processingTerminalId":"1234001","settlementDate":"2024-07-15","settlementState":"settled","status":"[\"ready\"]","type":"[\"payment\"]"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

**`Bank Transfer Payment`**

```javascript
const url = 'https://api.payroc.com/v1/bank-transfer-payments?after=8516&before=2571&dateFrom=2024-07-01T00%3A00%3A00Z&dateTo=2024-07-31T23%3A59%3A59Z&last4=7890&limit=25&nameOnAccount=Sarah%2520Hazel%2520Hopper&orderId=OrderRef6543&paymentLinkId=JZURRJBUPS&processingTerminalId=1234001&settlementDate=2024-07-15&settlementState=settled&status=%5B%22ready%22%5D&type=%5B%22payment%22%5D';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

**`Bank Transfer Payment`**

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.payroc.com/v1/bank-transfer-payments?after=8516&before=2571&dateFrom=2024-07-01T00%3A00%3A00Z&dateTo=2024-07-31T23%3A59%3A59Z&last4=7890&limit=25&nameOnAccount=Sarah%2520Hazel%2520Hopper&orderId=OrderRef6543&paymentLinkId=JZURRJBUPS&processingTerminalId=1234001&settlementDate=2024-07-15&settlementState=settled&status=%5B%22ready%22%5D&type=%5B%22payment%22%5D"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

**`Bank Transfer Payment`**

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.payroc.com/v1/bank-transfer-payments?after=8516&before=2571&dateFrom=2024-07-01T00%3A00%3A00Z&dateTo=2024-07-31T23%3A59%3A59Z&last4=7890&limit=25&nameOnAccount=Sarah%2520Hazel%2520Hopper&orderId=OrderRef6543&paymentLinkId=JZURRJBUPS&processingTerminalId=1234001&settlementDate=2024-07-15&settlementState=settled&status=%5B%22ready%22%5D&type=%5B%22payment%22%5D")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

**`Bank Transfer Payment`**

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.payroc.com/v1/bank-transfer-payments?after=8516&before=2571&dateFrom=2024-07-01T00%3A00%3A00Z&dateTo=2024-07-31T23%3A59%3A59Z&last4=7890&limit=25&nameOnAccount=Sarah%2520Hazel%2520Hopper&orderId=OrderRef6543&paymentLinkId=JZURRJBUPS&processingTerminalId=1234001&settlementDate=2024-07-15&settlementState=settled&status=%5B%22ready%22%5D&type=%5B%22payment%22%5D")
  .header("Authorization", "Bearer <token>")
  .asString();
```

**`Bank Transfer Payment`**

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.payroc.com/v1/bank-transfer-payments?after=8516&before=2571&dateFrom=2024-07-01T00%3A00%3A00Z&dateTo=2024-07-31T23%3A59%3A59Z&last4=7890&limit=25&nameOnAccount=Sarah%2520Hazel%2520Hopper&orderId=OrderRef6543&paymentLinkId=JZURRJBUPS&processingTerminalId=1234001&settlementDate=2024-07-15&settlementState=settled&status=%5B%22ready%22%5D&type=%5B%22payment%22%5D', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

**`Bank Transfer Payment`**

```csharp
using RestSharp;

var client = new RestClient("https://api.payroc.com/v1/bank-transfer-payments?after=8516&before=2571&dateFrom=2024-07-01T00%3A00%3A00Z&dateTo=2024-07-31T23%3A59%3A59Z&last4=7890&limit=25&nameOnAccount=Sarah%2520Hazel%2520Hopper&orderId=OrderRef6543&paymentLinkId=JZURRJBUPS&processingTerminalId=1234001&settlementDate=2024-07-15&settlementState=settled&status=%5B%22ready%22%5D&type=%5B%22payment%22%5D");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

**`Bank Transfer Payment`**

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.payroc.com/v1/bank-transfer-payments?after=8516&before=2571&dateFrom=2024-07-01T00%3A00%3A00Z&dateTo=2024-07-31T23%3A59%3A59Z&last4=7890&limit=25&nameOnAccount=Sarah%2520Hazel%2520Hopper&orderId=OrderRef6543&paymentLinkId=JZURRJBUPS&processingTerminalId=1234001&settlementDate=2024-07-15&settlementState=settled&status=%5B%22ready%22%5D&type=%5B%22payment%22%5D")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

<a id="response-fields"></a>
### Response fields

If your request is successful, we retrieve a list of the bank transfer payments and return a response. The response contains the following fields:

<a id="schema-responsebody"></a>
### Schema (`response.body`)

[Response body schema for `GET /bank-transfer-payments`](/api/list-bank-transfer-payments)

<a id="example-response"></a>
### Example response

<a id="response-200"></a>
### Response (200)

```json
{
  "limit": 2,
  "count": 2,
  "hasMore": true,
  "data": [
    {
      "paymentId": "M2MJOG6O2Y",
      "processingTerminalId": "1234001",
      "order": {
        "amount": 4999,
        "currency": "USD",
        "orderId": "OrderRef6543",
        "breakdown": {
          "subtotal": 4347,
          "taxes": [
            {
              "name": "Sales Tax",
              "rate": 5,
              "amount": 217
            }
          ],
          "tip": {
            "type": "percentage",
            "amount": 435,
            "percentage": 10
          }
        },
        "dateTime": "2024-07-02T15:30:00Z",
        "description": "Large Pepperoni Pizza"
      },
      "bankAccount": {
        "type": "pad",
        "accountNumber": "*******3159",
        "institutionNumber": "543",
        "nameOnAccount": "Sarah Hazel Hopper",
        "transitNumber": "76543"
      },
      "transactionResult": {
        "type": "payment",
        "status": "ready",
        "responseCode": "A",
        "authorizedAmount": 4999,
        "currency": "USD"
      },
      "customer": {
        "notificationLanguage": "en",
        "contactMethods": [
          {
            "type": "email",
            "value": "sarah.hopper@example.com"
          }
        ]
      }
    },
    {
      "paymentId": "E29U8OU8Q4",
      "processingTerminalId": "1234001",
      "order": {
        "amount": 3999,
        "currency": "USD",
        "orderId": "OrderRef7654",
        "breakdown": {
          "subtotal": 3477,
          "taxes": [
            {
              "name": "Sales Tax",
              "rate": 5,
              "amount": 174
            }
          ],
          "tip": {
            "type": "percentage",
            "amount": 348,
            "percentage": 10
          }
        },
        "dateTime": "2024-07-02T15:30:00Z",
        "description": "test"
      },
      "bankAccount": {
        "type": "pad",
        "accountNumber": "*******7890",
        "institutionNumber": "543",
        "nameOnAccount": "Sarah Hazel Hopper",
        "transitNumber": "76543"
      },
      "transactionResult": {
        "type": "payment",
        "status": "ready",
        "responseCode": "A",
        "authorizedAmount": 3999,
        "currency": "USD"
      },
      "customer": {
        "notificationLanguage": "en",
        "contactMethods": [
          {
            "type": "email",
            "value": "sarah.hopper@example.com"
          }
        ]
      },
      "customFields": [
        {
          "name": "yourCustomField",
          "value": "abc123"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "next",
      "method": "get",
      "href": "https://api.payroc.com/v1/bank-transfer-payments?limit=2&processingTerminalId=1234001&after=E29U8OU8Q4"
    },
    {
      "rel": "previous",
      "method": "get",
      "href": "https://api.payroc.com/v1//bank-transfer-payments?limit=2&processingTerminalId=1234001&before=M2MJOG6O2Y"
    }
  ]
}
```

<a id="step-2-reverse-the-bank-transfer-payment"></a>
## Step 2. Reverse the bank transfer payment

To reverse a bank transfer payment, send a POST request to the Bank Transfer Payments endpoint.  
If the merchant wants to reverse only part of the transaction, send the amount that they want to reverse in the amount parameter.

| Environment | URL |
| --- | --- |
| Test | [https://api.uat.payroc.com/v1/bank-transfer-payments/\{paymentId\}/reverse](https://api.uat.payroc.com/v1/bank-transfer-payments/%7BpaymentId%7D/reverse) |
| Production | [https://api.payroc.com/v1/bank-transfer-payments/\{paymentId\}/reverse](https://api.payroc.com/v1/bank-transfer-payments/%7BpaymentId%7D/reverse) |

<a id="request-parameters-1"></a>
### Request parameters

To create the body of your request, use the following parameters:

<a id="schema-requestpath"></a>
### Schema (`request.path`)

[Path parameters for `POST /bank-transfer-payments/{paymentId}/reverse`](/api/reverse-bank-transfer-payment)

<a id="example-request-1"></a>
### Example request

<a id="request-1"></a>
### Request

POST [https://api.payroc.com/v1/bank-transfer-payments/\{paymentId\}/reverse](https://api.payroc.com/v1/bank-transfer-payments/%7BpaymentId%7D/reverse)

**`Reverse Bank Transfer Payment`**

```curl
curl -X POST https://api.payroc.com/v1/bank-transfer-payments/M2MJOG6O2Y/reverse \
     -H "Idempotency-Key: 8e03978e-40d5-43e8-bc93-6894a57f9324" \
     -H "Authorization: Bearer <token>"
```

**`Reverse Bank Transfer Payment`**

```python
import requests

url = "https://api.payroc.com/v1/bank-transfer-payments/M2MJOG6O2Y/reverse"

headers = {
    "Idempotency-Key": "8e03978e-40d5-43e8-bc93-6894a57f9324",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.json())
```

**`Reverse Bank Transfer Payment`**

```javascript
const url = 'https://api.payroc.com/v1/bank-transfer-payments/M2MJOG6O2Y/reverse';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '8e03978e-40d5-43e8-bc93-6894a57f9324',
    Authorization: 'Bearer <token>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

**`Reverse Bank Transfer Payment`**

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.payroc.com/v1/bank-transfer-payments/M2MJOG6O2Y/reverse"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Idempotency-Key", "8e03978e-40d5-43e8-bc93-6894a57f9324")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

**`Reverse Bank Transfer Payment`**

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.payroc.com/v1/bank-transfer-payments/M2MJOG6O2Y/reverse")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '8e03978e-40d5-43e8-bc93-6894a57f9324'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

**`Reverse Bank Transfer Payment`**

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.payroc.com/v1/bank-transfer-payments/M2MJOG6O2Y/reverse")
  .header("Idempotency-Key", "8e03978e-40d5-43e8-bc93-6894a57f9324")
  .header("Authorization", "Bearer <token>")
  .asString();
```

**`Reverse Bank Transfer Payment`**

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.payroc.com/v1/bank-transfer-payments/M2MJOG6O2Y/reverse', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Idempotency-Key' => '8e03978e-40d5-43e8-bc93-6894a57f9324',
  ],
]);

echo $response->getBody();
```

**`Reverse Bank Transfer Payment`**

```csharp
using RestSharp;

var client = new RestClient("https://api.payroc.com/v1/bank-transfer-payments/M2MJOG6O2Y/reverse");
var request = new RestRequest(Method.POST);
request.AddHeader("Idempotency-Key", "8e03978e-40d5-43e8-bc93-6894a57f9324");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

**`Reverse Bank Transfer Payment`**

```swift
import Foundation

let headers = [
  "Idempotency-Key": "8e03978e-40d5-43e8-bc93-6894a57f9324",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.payroc.com/v1/bank-transfer-payments/M2MJOG6O2Y/reverse")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

<a id="response-fields-1"></a>
### Response fields

If your request is successful, we reverse the bank transfer payment and return a response. The response contains the following fields:

<a id="schema-responsebody-1"></a>
### Schema (`response.body`)

[Response body schema for `POST /bank-transfer-payments/{paymentId}/reverse`](/api/reverse-bank-transfer-payment)

<a id="example-response-1"></a>
### Example response

<a id="response-200-1"></a>
### Response (200)

```json
{
  "paymentId": "M2MJOG6O2Y",
  "processingTerminalId": "1234001",
  "order": {
    "amount": 4999,
    "currency": "USD",
    "orderId": "OrderRef6543",
    "breakdown": {
      "subtotal": 4347,
      "taxes": [
        {
          "name": "VAT",
          "rate": 5,
          "amount": 217
        }
      ],
      "tip": {
        "type": "percentage",
        "percentage": 10
      }
    },
    "dateTime": "2024-07-02T15:30:00Z",
    "description": "Large Pepperoni Pizza"
  },
  "bankAccount": {
    "type": "pad",
    "accountNumber": "*******7890",
    "institutionNumber": "543",
    "nameOnAccount": "Sarah Hazel Hopper",
    "transitNumber": "76543"
  },
  "transactionResult": {
    "type": "payment",
    "status": "reversal",
    "responseCode": "A",
    "authorizedAmount": 4999,
    "currency": "USD"
  },
  "customer": {
    "notificationLanguage": "en",
    "contactMethods": [
      {
        "type": "email",
        "value": "sarah.hopper@example.com"
      }
    ]
  },
  "customFields": [
    {
      "name": "yourCustomField",
      "value": "abc123"
    }
  ]
}
```