payments

Create payment

Changed on

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.

post/bank-transfer-payments

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/bank-transfer-payments
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring uuid required

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

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

Response

Successful request. We processed the sale.

paymentIdstring required

Unique identifier that we assigned to the payment.

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

Changes

  • 817f57a896f3Revision changes
    • breaking

      the // response property's maxLength was increased from 100 to 255 for the response status

    • info

      the // request property's maxLength was increased from 100 to 255

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API