Create payment | Payroc | Documentation

1	using RestSharp;
2
3	var client = new RestClient("https://api.payroc.com/v1/bank-transfer-payments");
4	var request = new RestRequest(Method.POST);
5	request.AddHeader("Idempotency-Key", "8e03978e-40d5-43e8-bc93-6894a57f9324");
6	request.AddHeader("Authorization", "Bearer <token>");
7	request.AddHeader("Content-Type", "application/json");
8	request.AddParameter("application/json", "{\n \"processingTerminalId\": \"1234001\",\n \"order\": {\n \"amount\": 4999,\n \"currency\": \"USD\",\n \"orderId\": \"OrderRef6543\",\n \"breakdown\": {\n \"subtotal\": 4347,\n \"taxes\": [\n {\n \"rate\": 5,\n \"name\": \"Sales Tax\",\n \"type\": \"rate\"\n }\n ],\n \"tip\": {\n \"type\": \"percentage\",\n \"percentage\": 10\n }\n },\n \"description\": \"Large Pepperoni Pizza\"\n },\n \"paymentMethod\": {\n \"type\": \"ach\",\n \"accountNumber\": \"11101010\",\n \"nameOnAccount\": \"Sarah Hazel Hopper\",\n \"routingNumber\": \"053200983\",\n \"accountType\": \"checking\",\n \"secCode\": \"web\"\n },\n \"customer\": {\n \"notificationLanguage\": \"en\",\n \"contactMethods\": [\n {\n \"type\": \"email\",\n \"value\": \"[email protected]\"\n }\n ]\n },\n \"credentialOnFile\": {\n \"tokenize\": true\n },\n \"customFields\": [\n {\n \"name\": \"yourCustomField\",\n \"value\": \"abc123\"\n }\n ]\n}", ParameterType.RequestBody);
9	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 run a sale with a customer’s bank account details.

In the response, our gateway returns information about the bank transfer payment and a paymentId, which you need for the following methods:

Retrieve payment - View the details of the bank transfer payment.
Reverse payment - Cancel the bank transfer payment if it’s an open batch.
Refund payment - Run a referenced refund to return funds to the customer’s bank account.

Payment methods

Our gateway accepts the following payment methods:

Automated clearing house (ACH) details
Pre-authorized debit (PAD) details

You can also use secure tokens and single-use tokens that you created from ACH details or PAD details.

Use this method to run a sale with a customer's bank account details. In the response, our gateway returns information about the bank transfer payment and a paymentId, which you need for the following methods: - [Retrieve payment](https://docs.payroc.com/api/schema/bank-transfer-payments/payments/retrieve) - View the details of the bank transfer payment. - [Reverse payment](https://docs.payroc.com/api/schema/bank-transfer-payments/refunds/reverse-payment) - Cancel the bank transfer payment if it's an open batch. - [Refund payment](https://docs.payroc.com/api/schema/bank-transfer-payments/refunds/refund) - Run a referenced refund to return funds to the customer's bank account. **Payment methods** Our gateway accepts the following payment methods: - Automated clearing house (ACH) details - Pre-authorized debit (PAD) details You can also use [secure tokens](https://docs.payroc.com/api/schema/payments/secure-tokens/overview) and [single-use tokens](https://docs.payroc.com/api/schema/tokenization/single-use-tokens/create) that you created from ACH details or PAD details.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

processingTerminalIdstringRequired4-50 characters

Unique identifier that we assigned to the terminal.

orderobjectRequired

Object that contains information about the transaction.

paymentMethodobjectRequired

Polymorphic object that contains payment detail information.

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

ach - Automated Clearing House (ACH) details
pad - Pre-authorized debit (PAD) details
secureToken - Secure token details
singleUseToken - Single-use token details

customerobjectOptional

Object that contains information about the customer.

credentialOnFileobjectOptional

Object that contains information about saving the customer’s payment details.

customFieldslist of objectsOptional

Array of customField objects.

Response headers

locationstringOptional

URI reference to created resource.

Response

Successful request. We processed the sale.

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.

customerobjectOptional

Object that contains information about the customer.

refundslist of objectsOptional

List of refunds issued against the payment.

returnslist of objectsOptional

List of returns issued against the payment.

representmentobjectOptional

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

customFieldslist of objectsOptional

Array of customField objects.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

406

Not Acceptable Error

409

Conflict Error

415

Unsupported Media Type Error

500

Internal Server Error

Use this method to run a sale with a customer’s bank account details.

In the response, our gateway returns information about the bank transfer payment and a paymentId, which you need for the following methods:

Retrieve payment - View the details of the bank transfer payment.
Reverse payment - Cancel the bank transfer payment if it’s an open batch.
Refund payment - Run a referenced refund to return funds to the customer’s bank account.

Payment methods

Our gateway accepts the following payment methods:

Automated clearing house (ACH) details
Pre-authorized debit (PAD) details

You can also use secure tokens and single-use tokens that you created from ACH details or PAD details.

Authentication

Headers

Request

Response headers

Response

Errors