Sign in
Payment account

Create refund

Create a refund request

post/v3/payment/payment-account/refunds

Request body

payment_account_transaction_idstring required

The id of the payment account transaction you want to refund

amountnumber required

The amount you wish to refund (positive and up to 2 decimals). You can partially refund the payment transaction.

client_referencestring

An optional reference to link this refund request to your system (100 characters max.)

descriptionstring

This description is only for an internal purpose and will allow to have information on the Dashboard (140 characters max.)

end_to_end_idstring

Technical id between you, Bridge and the bank (35 char. max.)

Example request

{
  "payment_account_transaction_id": "9f7052e8-96cd-45da-8e5c-08c82ef83164",
  "amount": 10,
  "client_reference": "client-reference",
  "description": "My product refund description",
  "end_to_end_id": "E2E_TEST-123"
}

Response

Refund creation response

idstring
payment_account_transaction_idstring
amountnumber
currencystring
status'created' | 'processing' | 'in_transit' | 'paid' | 'canceled' | 'rejected' | 'failed' | 'recalled'
client_referencestring

Your internal reference for reconciliation

descriptionstring

Your internal description

end_to_end_idEndToEndId — unresolved $ref
created_atstring date-time
updated_atstring date-time

Changes