BVbvnk
Fiat Payments

Refund pay-in

Initiates seamless one-click refund processing for any previous pay-in. Once accepted, a refund transaction appears in your portal and can be acquired via API.

Upon activation, the system automatically generates a new transaction according to our standard workflow. You can request multiple refunds for the same transaction, as long as the total refunded amount doesn't exceed what was originally paid in.

post/payment/v1/payins/{transactionReference}/refund

Request

Path parameters

transactionReferencestring uuid required
Example:023e5e53-6f50-4af5-a7e4-c9f15d493f90

Unique reference (UUID) of the pay-in you want to refund.

Headers

X-Idempotency-Keystring uuid required
Example:1e74002e-74a1-48fd-b707-147c3187a3e1

Unique request identifier (any string, preferably in UUID format).

Request body

paymentReferencestring required

Merchant-side reference that ties the refund to your order, user, or invoice.

metadataMetadata

Custom metadata key-value pairs. Structure: key: value. Restrictions:

  • Maximum five keys.

  • Each key maximum length 50 characters.

  • Each value maximum length 100 characters.

  • Keys and values must be simple strings.

Example request

{
  "paymentReference": "order123456",
  "amount": {
    "value": 150.5,
    "currency": "EUR"
  },
  "metadata": {
    "source": "api",
    "orderId": "ORD-48213"
  }
}

Response

Refund request accepted

transactionReferencestring uuid required

Unique identifier for the refund transaction

Example response

{
  "transactionReference": "018e5e83-ac50-4df0-a7e4-c9f15d493f90",
  "fee": {
    "value": 1.5,
    "currency": "EUR"
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.