Skip to main content

Create Refund

POST 
/v2/deposits/:depositId/refunds
Feature in development

Create a deposit refund request. Not all deposit payment options are refundable. Refunds are supported for the following deposit payment options:

  • BANK_TRANSFER
  • CARD

Additionally, a refund requires completing the deposit and completing the internal reconciliation process. The refundable flag allows us to track if a deposit is refundable.

Refund criteria:

  • Deposit status must be COMPLETED
  • Deposit must have refundable flag set to true.
  • One refund per deposit is allowed.
  • The wallet account funding the refund must have the required refund amount
  • Refund is only forwarded back to the instrument associated with the deposit
  • Refund amount is up to the deposit amount (partial refund is possible).
  • Refund currency is the same as the deposit currency

Refunds are created in a PREVIEW state. It establishes the Refund resource and validates the refund parameters.

To move the payment forward you must request a status change using POST /v2/deposits/{depositId}/refunds/{refundId}/status. This will move the refund to PENDING state.

{
   "status": "PENDING"
}

To confirm the refund for execution use POST /v2/deposits/{depositId}/refunds/{refundId}/status:

{
   "status": "PROCESSING"
}

Poll for status or leverage webhooks to track the refund progress.

To navigate to a deposit based on transactionId from transaction history use GET /v2/customers/{customerId}/deposits?fundingTransaction={transactionId}, which returns a deposit object for a specific transaction.

Request​

Responses​

OK