Close return | Payroc | Documentation

using RestSharp;
var client = new RestClient("https://api.payroc.com/v1/bank-transfer-payments/M2MJOG6O2Y/close");
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);

1	{
2	"paymentId": "M2MJOG6O2Y",
3	"processingTerminalId": "1234001",
4	"order": {
5	"amount": 4999,
6	"currency": "USD",
7	"orderId": "OrderRef6543",
8	"breakdown": {
9	"subtotal": 4347,
10	"taxes": [
11	{
12	"name": "Sales Tax",
13	"rate": 5,
14	"amount": 217
15	}
16	],
17	"tip": {
18	"type": "percentage",
19	"amount": 435,
20	"percentage": 10
21	}
22	},
23	"dateTime": "2024-07-02T15:30:00Z",
24	"description": "Large Pepperoni Pizza"
25	},
26	"bankAccount": {
27	"type": "ach",
28	"accountNumber": "****3159",
29	"nameOnAccount": "Sarah Hazel Hopper",
30	"routingNumber": "053200983",
31	"secCode": "web",
32	"secureToken": {
33	"secureTokenId": "MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa",
34	"customerName": "Sarah Hazel Hopper",
35	"token": "296753123456",
36	"status": "notValidated",
37	"link": {
38	"rel": "self",
39	"method": "GET",
40	"href": "https://api.payroc.com/v1/processing-terminals/1234001/secure-tokens/MREF_abc1de23-f4a5-6789-bcd0-12e345678901fa"
41	}
42	}
43	},
44	"transactionResult": {
45	"type": "payment",
46	"status": "ready",
47	"responseCode": "A",
48	"authorizedAmount": 4999,
49	"currency": "USD",
50	"responseMessage": "NoError",
51	"processorResponseCode": "0"
52	},
53	"customer": {
54	"notificationLanguage": "en",
55	"contactMethods": [
56	{
57	"type": "email",
58	"value": "[email protected]"
59	}
60	]
61	},
62	"customFields": [
63	{
64	"name": "yourCustomField",
65	"value": "abc123"
66	}
67	]
68	}

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:

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

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

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](https://docs.payroc.com/api/schema/bank-transfer-payments/payments/retrieve) method to view the details of the original payment. 2. From the [returns object](https://docs.payroc.com/api/schema/bank-transfer-payments/payments/retrieve#response.body.returns) in the response, get the paymentId of the return. If your request is successful, our gateway closes the return.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

paymentIdstringRequired=10 characters

Unique identifier that our gateway assigned to the payment.

Response

Successful request. We closed the return.

paymentIdstring=10 characters

Unique identifier that we assigned to the payment.

processingTerminalIdstring4-50 characters

Unique identifier that we assigned to the terminal.

orderobject

Object that contains information about the transaction.

bankAccountobject

Polymorphic object that contains bank account information.

The value of the type field determines which variant you should use:

ach - Automated Clearing House (ACH) details
pad - Pre-authorized debit (PAD) details

transactionResultobjectRead-only

Object that contains information about the transaction.

customerobject

Object that contains information about the customer.

refundslist of objects

List of refunds issued against the payment.

returnslist of objects

List of returns issued against the payment.

representmentobject

Object that contains details about the re-presented payment linked to the return.

customFieldslist of objects

Array of customField objects.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

406

Not Acceptable Error

409

Conflict Error

415

Unsupported Media Type Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors