SchemaBank Transfer PaymentsPayments

Re-present payment

View as MarkdownOpen in Claude
Use this method to re-present an ACH payment. To re-present a payment, 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. Our gateway uses the bank account details from the original payment. If you want to update the customer's bank account details, send the new bank account details in the request. If your request is successful, our gateway re-presents the payment.

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.

Headers

Idempotency-KeystringRequiredformat: "uuid"
Unique identifier that you generate for each request. You must use the [UUID v4 format](https://www.rfc-editor.org/rfc/rfc4122) for the identifier. For more information about the idempotency key, go to [Idempotency](https://docs.payroc.com/api/idempotency).

Request

This endpoint expects an object.
paymentMethodobjectOptional
Object that contains information about the customer's payment details.

Response

Successful request. We processed the payment.
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
Object that contains information about the bank account.
transactionResultobject
Object that contains information about the transaction.
customerobject or null
Object that contains information about the customer.
refundslist of objects or null
List of refunds issued against the payment.
returnslist of objects or null
List of returns issued against the payment.
representmentobject or null

List of re-presented payments linked to the return.

customFieldslist of objects or null
Array of customField objects.

Errors