API Reference
Start typing to search…
  1. BXNK APIs
  2. Payments

Refund a payment

post
https://sandbox-api.bxnk.com/api/v1/product-apis/payments//refund

Refund a payment.

Authentication

Requires X-Access-Key and X-Secret-Key headers.

Path parameters

  • paymentId (string): the payment identifier to refund

Request body

JSON payload matching RefundPaymentDto.

Required fields:

  • refundAmount (number, min 0.01)

Optional fields:

  • reason (string)

Response

  • 201: Refund processed successfully. Returned data (RefundResponseDto) includes:
    • refundId
    • paymentId
    • refundAmount
    • refundStatus
    • reason (object)
    • createdAt
  • 400: Bad request
  • 401: Unauthorized
  • 403: Forbidden
  • 404: Not found
  • 500: Internal server error
Language
Credentials
Response
Click Try It! to start a request and see the response here!