/refund_payment

post

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

Use the pnm_payment_identifier to refund a payment for the full or partial amount. Include the refund_amount and the refund_currency parameters for partial-amount refunds.

Only processed payments can be refunded. For ACH payments, this is after the daily batch transfer to the bank. For cards, the cutoff time is based on the card processing network.

Body Params

Refunds the full or partial amount of the payment associated with the specified pnm_payment_identifier.

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.

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 Refunded