Refund an order (Deprecated)
Issue a refund for a completed order. This operation allows for either a full or partial refund, which will be processed back to the customer's original payment method.
Operation details
- The refund operation generates a new order with
type: REFUND. This new order represents a full or partial refund of the original amount paid. - Refunds can only be initiated for orders that are in the
COMPLETEDstate. Orders in any other state are not eligible for refunds to ensure transaction integrity and to prevent errors.
- Ensure that the order to be refunded is confirmed as
COMPLETEDbefore attempting a refund operation. - Consider using the
Idempotency-Keyheader to make the refund operation idempotent, preventing duplicate refund processing in cases of multiple submissions.
Request
The ID of the Order object.
Example: "Bearer sk_1234567890ABCdefGHIjklMNOpqrSTUvwxYZ_1234567890-Ab_cdeFGHijkLMNopq"
This parameter accepts the Merchant API Secret key to authorise requests coming from the merchant's backend.
It ensures that ensures that each request is authenticated and authorised by verifying the secret key. The secret key should be included in all request headers as a Bearer token.
For more information, see: Authentication
The Idempotency-Key ensures that refund orders are processed only once, preventing multiple executions of the same operation due to retries or duplicate requests.
This header is optional and can accept any unique string value the merchant uses.
A recommended practice is to utilise the refund entity's ID from the merchant's system as the idempotency key. This facilitates tracking and managing refund requests effectively.
The amount of the refund (minor currency unit). For example, enter 7034 for €70.34 in the field.
This amount can't exceed the remaining amount of the original order. To get the refundable amount, subtract the value of the refunded_amount from the value of the order_amount in the original order. See Retrieve an order.
The description of the refund.
Merchant order ID for external reference.
Use this field to set the ID that your own system can use to easily track orders.
Possible number of items: <= 50 items
Additional information to track your orders in your system, by providing custom metadata using "<key>" : "<value>" pairs.
Restrictions:
- Max number of items:
50 - Max length of metadata values:
500 - Format of metadata keys:
^[a-zA-Z][a-zA-Z\\d_]{0,39}$
Response
OK
Permanent order ID used to retrieve, capture, cancel, or refund an order after authorization.
Temporary ID for the order.
It expires when the payment is authorized.
Possible values: [PAYMENT, REFUND, CHARGEBACK]
The type of the order.
Possible values: [PENDING, PROCESSING, AUTHORISED, COMPLETED, CANCELLED, FAILED]
The state of the order.
For more information about the order lifecycle, see: Order and payment lifecycle.
The date and time the order was created.
The date and time the order was last updated.
The date and time the order was completed.
The description of the order.
Possible values: [AUTOMATIC, MANUAL]
The capture mode of the order. AUTOMATIC is used by default.
AUTOMATIC: The order is captured automatically after payment authorisation.MANUAL: The order is not captured automatically. You must manually capture the order later.
For more information, see Capture an order.
ISO 4217 currency code in upper case.
If settlement_currency is different from the value of currency, the money will be exchanged when the amount is settled to your merchant account. In case of a refund or chargeback, the money will be exchanged to the order's initial currency.
If settlement_currency is not specified, this value is taken from currency.
For more information about the supported currencies, see: Help Center.
Merchant order ID for external reference.
Use this field to set the ID that your own system can use to easily track orders.
The ID of the customer associated with this order.
The email of the customer.
The phone number of the customer.
The customer's full name.
The amount and currency of the order.
The order total expressed in minor currency units, according to the ISO 4217 standard. For example, 7034 in EUR corresponds to €70.34.
Conversion between major and minor units varies by currency. For instance, 100 minor units equal £1.00 in GBP, whereas in ISK they represent 100 units. For more details, see the ISO 4217 standard.
Possible length: >= 3 characters and <= 3 characters
ISO 4217 currency code in upper case.
For more information about the supported currencies, see: Help Center.
The amount and currency outstanding to be paid for this order.
The amount of the order (minor currency unit) that is outstanding. For example, enter 7034 for €70.34 in the field.
The currency of the amount that is outstanding. ISO 4217 currency code in upper case.
For more information about the supported currencies, see: Help Center.
The amount and currency of the refunded order.
The amount of the refunded order (minor currency unit). For example, enter 7034 for €70.34 in the field.
The currency of the refunded order. ISO 4217 currency code in upper case.
For more information about the supported currencies, see: Help Center.
Address
Street line 1 information.
Street line 2 information.
The region associated with the address.
The city associated with the address.
The country associated with the address.
The postcode associated with the address.
The details of all the payment attempts that have been made towards this order (successful or unsuccessful).
The ID of the payment.
Possible values: [PROCESSING, AUTHORISED, CAPTURED, COMPLETED, FAILED, DECLINED, CANCELLED]
The state of the payment.
Possible values: [do_not_honour, 3ds_challenge_abandoned, 3ds_challenge_failed, 3ds_challenge_failed_manually, insufficient_funds, transaction_not_allowed_for_cardholder, high_risk, cardholder_name_missing, unknown_card, invalid_card, invalid_email, restricted_card, expired_card, rejected_by_customer, withdrawal_limit_exceeded, pick_up_card, invalid_amount]
The reason for a FAILED or DECLINED payment.
A failed or declined payment can result from multiple reasons. To learn more, check our decline reasons.
The date and time the payment was created.
The date and time the payment was last updated.
Temporary token of the payment used to fetch the reward offer during checkout and link user registrations to the given offers.
The token is only valid for a limited time.
The amount and currency of the payment.
The amount of the payment (minor currency unit). For example, enter
7034 for €70.34 in the field.
The currency of the payment. ISO 4217 currency code in upper case.
For more information about the supported currencies, see: Help Center.
The amount and currency of the settled payment.
The amount of the settled payment (minor currency unit). For example,
enter 7034 for €70.34 in the field.
The currency of the settled payment. ISO 4217 currency code in upper case.
For more information about the supported currencies, see: Help Center.
The details of the payment method used to make the payment.
The ID of the payment method. This value is present only if the payment method was previously saved.
Possible values: [CARD, REVOLUT]
The type of the payment.
The details of the card. Only present for payments with payment_method.type = CARD.
Possible values: [VISA, MASTERCARD]
The type of the card.
Possible values: [CREDIT, DEBIT, PREPAID]
The type of card funding.
The country where the card was issued.
Possible length: >= 6 characters and <= 6 characters
The BIN of the card.
Possible length: >= 4 characters and <= 4 characters
The last four digits of the card.
The expiry date of the card in the format of MM/YY.
The name of the cardholder.
The details of the check for card payment. Only for orders with successful payments.
The details of the 3D Secure check. Only for orders with successful payments.
Possible values: [VERIFIED, FAILED, CHALLENGE]
The result of 3D Secure check.
The 3D Secure version.
Possible values: [MATCH, NOT_MATCH, INCORRECT, NOT_PROCESSED]
The result of CVV verification.
| Verification result | Description |
|---|---|
MATCH | Provided CVV matches the card's CVV |
NOT_MATCH | Provided CVV does not match the card's CVV |
INCORRECT | Provided CVV format is incorrect for this type of card |
NOT_PROCESSED | CVV verification was not performed |
Possible values: [MATCH, NOT_MATCH, N_A, INVALID]
The result of address verification.
Possible values: [MATCH, NOT_MATCH, N_A, INVALID]
The result of postcode verification.
Possible values: [MATCH, NOT_MATCH, N_A, INVALID]
The result of cardholder verification.
Address
Street line 1 information.
Street line 2 information.
The region associated with the address.
The city associated with the address.
The country associated with the address.
The postcode associated with the address.
Possible values: [LOW, HIGH]
The risk level of the card.
If the risk level is HIGH, the payment might be declined.
The details of the order fee.
Possible values: [FX, ACQUIRING]
The type of the order fee.
The amount and currency of the payment fee.
The amount of the payment fee (minor currency unit). For
example, enter 7034 for €70.34 in the field.
The currency of the payment fee. ISO 4217 currency code in upper case.
For more information about the supported currencies, see: Help Center.
The details of related orders. You can use the ID of the related order to Retrieve the order information.
The ID of the related order. You can use this ID to get more information about the related order using the Retrieve an order operation.
Possible values: [PAYMENT, REFUND, CHARGEBACK]
The type of the related order.
Possible values: [PENDING, PROCESSING, AUTHORISED, COMPLETED, CANCELLED, FAILED]
The state of the related order.
The amount and currency of the related order.
The order total expressed in minor currency units, according to the ISO 4217 standard. For example, 7034 in EUR corresponds to €70.34.
Conversion between major and minor units varies by currency. For instance, 100 minor units equal £1.00 in GBP, whereas in ISK they represent 100 units. For more details, see the ISO 4217 standard.
Possible length: >= 3 characters and <= 3 characters
ISO 4217 currency code in upper case.
For more information about the supported currencies, see: Help Center.
Possible number of items: <= 50 items
Additional information to track your orders in your system, by providing custom metadata using "<key>" : "<value>" pairs.
Restrictions:
- Max number of items:
50 - Max length of metadata values:
500 - Format of metadata keys:
^[a-zA-Z][a-zA-Z\\d_]{0,39}$
Link to a checkout page hosted by Revolut.
Possible length: <= 2000 characters
The URI of the order stored in the merchant's order management system.
This URI will be included in the order confirmation email for payments made via Revolut Pay. If specified, this URI will override the default link to the merchant's Business website configured in the Revolut Business account.
Restrictions:
- Max length of
merchant_order_uristring:2000 - Only valid
http://orhttps://domains are accepted - Domain cannot be
localhostor IP address