Create payment | Payroc | Documentation

1	using Payroc;
2	using System.Threading.Tasks;
3	using Payroc.BankTransferPayments.Payments;
4	using System.Collections.Generic;
5
6	namespace Usage;
7
8	public class Example
9	{
10	public async Task Do() {
11	var client = new PayrocClient();
12
13	await client.BankTransferPayments.Payments.CreateAsync(
14	new BankTransferPaymentRequest {
15	IdempotencyKey = "8e03978e-40d5-43e8-bc93-6894a57f9324",
16	ProcessingTerminalId = "1234001",
17	Order = new BankTransferPaymentRequestOrder {
18	Amount = 4999L,
19	Currency = Currency.Usd,
20	OrderId = "OrderRef6543",
21	Breakdown = new BankTransferRequestBreakdown {
22	Subtotal = 4347L,
23	Taxes = new List<TaxRate>(){
24	new TaxRate {
25	Rate = 5,
26	Name = "Sales Tax",
27	Type = TaxRateType.Rate
28	},
29	}
30	,
31	Tip = new Tip {
32	Type = TipType.Percentage,
33	Percentage = 10
34	}
35	},
36	Description = "Large Pepperoni Pizza"
37	},
38	PaymentMethod = new BankTransferPaymentRequestPaymentMethod(
39	new AchPayload {
40	AccountNumber = "11101010",
41	NameOnAccount = "Sarah Hazel Hopper",
42	RoutingNumber = "053200983",
43	AccountType = AchPayloadAccountType.Checking,
44	SecCode = AchPayloadSecCode.Web
45	}
46	),
47	Customer = new BankTransferCustomer {
48	NotificationLanguage = BankTransferCustomerNotificationLanguage.En,
49	ContactMethods = new List<ContactMethod>(){
50	new ContactMethod(
51	new ContactMethodEmail {
52	Value = "[email protected]"
53	}
54	),
55	}
56
57	},
58	CredentialOnFile = new SchemasCredentialOnFile {
59	Tokenize = true
60	},
61	CustomFields = new List<CustomField>(){
62	new CustomField {
63	Name = "yourCustomField",
64	Value = "abc123"
65	},
66	}
67
68	}
69	);
70	}
71
72	}

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

locationstring

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.

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

List of re-presented payments linked to the return.

customFieldslist of objects

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

Authentication

Headers

Request

Response headers

Response

Errors