/reverse_payment

post

https://api.paynearme-sandbox.com/json-api/reverse_payment

Use the /reverse_payment endpoint to either cancel or refund a payment. Set void_if_not_settled to true to completely cancel a payment that has not settled. The cutoff times for the cancellation window varies by card network and your site’s ACH submission timelines. Settled payments must be refunded by submitting the refund_amount and refund_currency parameters. This call gives you the ability to refund both full and partial amounts.

Body Params

Cancels unsettled payments and refunds settled payments

site_identifier

string

required

Defaults to S2411573363

Identifies your client site.

timestamp

string

required

The Unix Epoch time of the call

version

string

required

Defaults to 3.0

The version of the API. This version must match the version associated with your API key pair.

signature

string

required

The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm.

pnm_payment_identifier

string

required

Defaults to 342104401427

The unique, PayNearMe-created identifier for this payment.

agent_identifier

string

The name or ID of the client agent cancelling the payment.

void_if_not_settled

string

Set this parameter to true to completely cancel a payment that has not been settled. The cutoff times for the cancellation window varies by card network and your site’s ACH submission timelines.

Settled payments must be refunded by submitting the refund_amount and refund_currency parameters.

refund_amount

number

The amount to be refunded. This parameter should only be included for partial-amount refunds.

refund_currency

string

USD

Response

Language

URL

Response

Choose an example:

application/json

201Payment Reversed