Create refund

post

https://api.sandbox.eu.ppro.com/v1/payment-charges/{paymentChargeId}/refunds

Refund all or part of an authorization on a payment charge that has been captured.

Path Params

paymentChargeId

string

required

Body Params

merchantRefundReference

string

The merchant provided refund reference.

amount

int64

required

≥ 1

The refund amount in the payment charge currency's smallest unit.

refundDescriptor

string

The refund descriptor (arbitrary string). To provide consumer's bank account details

refundReason

string

enum

The reason for the refund request.

Allowed:

Headers

Merchant-Id

string

required

The merchant identifier.

Request-Reference

string

Unique request reference to facilitate debugging.

Request-Idempotency-Key

string

Optional Idempotency Key for the request. Sending duplicate requests will result in 409 HTTP status code.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

200OK

409Duplicate request received with the same idempotency key.

504Call to the upstream dependency timed out.