Sign in

v1

latestOpenAPI 3.0.02026-07-26355499.1 KB
Refunds

Create Refund

Allows for the creation of a full or partial refund for a previously completed deposit.

  • For credit card deposits, the refund is processed to the same card, requiring only deposit identification.
  • For other payment methods, beneficiary bank account details are necessary.
  • Multiple partial refunds can be issued for a single deposit, provided the total refunded amount does not exceed the original deposit amount.
post/v3/refunds

Headers

Content-Typestring required

Media type of the body sent to the API.

X-Datestring date-time required

ISO8601 Datetime with Timezone (e.g., 2023-05-27T10:00:00Z).

X-Loginstring required

Merchant X-Login API Key.

Authorizationstring required

Authorization control hash, calculated as explained in the Directa24 documentation.

X-Idempotency-Keystring

Unique idempotency key to prevent duplicate processing of the same request.

Request body

deposit_idinteger required

Directa24 deposit_id. It is obtained when creating the deposit. Must be a valid deposit_id of a completed deposit.

invoice_idstring required

The invoice_id you sent while creating the deposit or the merchant_invoice_id auto-generated by Directa24. Must be a valid invoice_id of a completed deposit.

amountnumber double

Amount to refund. Positive, up to 2 decimal places. Must be equal to or smaller than the deposit amount. If not sent, a full refund is assumed.

commentsstring

Optional comments about the refund.

notification_urlstring uri

Valid HTTPS URL (URI) used to send asynchronous notifications about the refund's status changes.

Response

Refund request accepted and processing initiated, or completed synchronously (for some credit card refunds). The response structure might be more detailed for synchronously processed credit card refunds.

refund_idstring

Unique ID for the created refund. This might be an integer or a string depending on the refund method.

deposit_idinteger

Directa24 deposit_id. Returned for synchronously processed credit card refunds.

merchant_invoice_idstring

The merchant_invoice_id. Returned for synchronously processed credit card refunds.