Merchant API
Capture an order (Deprecated)
api
post
/api/1.0/orders/{order_id}/capture

Capture an order (Deprecated)

Capture the funds of an existing, uncaptured order. When the payment for an order is authorised, the order is captured and sent to the processing stage.

When you create an order, you can choose one of the following capture modes:

  • AUTOMATIC: The order is captured automatically after payment authorisation, so you don't need to take any action then.
  • MANUAL: The order is not captured automatically and stays in AUTHORISED state. You must manually capture the order later using one of the following methods:
    • Web UI: Complete the following steps:
      1. Log in to your Revolut Business portal.
      2. Navigate to the Merchant tab on the dashboard, and click the See all button in the Transactions section.
      3. Select an uncaptured payment, and click Capture.
    • Endpoint: Use the /capture endpoint.

Optionally, you can send a fraction of the full amount in the capture request to do a partial capture. You can only capture an order once. The amount that isn't captured will be voided.

note

Orders stay uncaptured for 7 days. After this period, the funds are returned to the customer's original payment method.

Authorization​

Each Merchant API request must contain an authorization header in the following format to make a call: 

'Authorization: Bearer <yourSecretApiKey>'

Before you start, ensure that you've successfully applied for a Merchant Account in your Revolut Business Account.

The Public key is on the same path in your Revolut Business account as the Secret key. There are two different functions for each:

  • Public key should be provided with payment methods at checkout
  • Secret key is used as a part of the authorization header for all server calls, e.g., creating order

Complete the following steps to generate the Production API keys (Secret, Public):

  1. Log in to your Revolut Business portal.
  2. On the top left corner, click your account name, click APIs then select Merchant API.
  3. Under the Production API Secret key and Production API Public key sections you will find the API keys needed. If it's your first time on this page, you will need to click the Generate button to create your unique API keys.

You can also use this link to directly open the Merchant API page.

Merchant API - Settings

note

Use these keys only for the production environment. For the Revolut Business Sandbox environment, use the sandbox API keys.

SSL​

note

This authentication protocol is used exclusively when using Fast checkout.

Connection over HTTPS is using SSL authentication. For successful authentication, your system's certificate should be issued by a Public Certificate Authority (PCA) and your system should trust Revolut's public certificate.

Revolut-Pay-Payload-Signature​

note

This authentication protocol is used exclusively when using Fast checkout.

Data integrity and authorship will be verified using a payload-based signature. The response of a successful URL registration for address validation (see: Register address validation for Fast checkout) will contain a secret signing key.

The signing key will be used by Revolut to compute a Hash-based Message Authentication Code (HMAC) payload signature whenever the registered URL is called, which should be verified by your backend.

Request​

Path Parameters
Path Parameters

The ID of the Order object.

Header Parameters
Header Parameters

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.

info

For more information, see: Authorization

Request body
Body object

Specify an amount to capture. This amount must be less than the amount that was originally captured.

The remaining amount in the order will be voided and can't be captured.

Response​

OK

Response body
Body object

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.

info

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.

info

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 amount and currency of the order.

The total amount of the order in minor currency units. For example, 7034 represents €70.34.

ISO 4217 currency code in upper case.

info

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.

info

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.

info

For more information about the supported currencies, see: Help Center.

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.

info

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.

info

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 values: >= 6 characters and <= 6 characters

The BIN of the card.

Possible values: >= 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 resultDescription
MATCHProvided CVV matches the card's CVV
NOT_MATCHProvided CVV does not match the card's CVV
INCORRECTProvided CVV format is incorrect for this type of card
NOT_PROCESSEDCVV 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.

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.

info

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 total amount of the order in minor currency units. For example, 7034 represents €70.34.

ISO 4217 currency code in upper case.

info

For more information about the supported currencies, see: Help Center.

Possible values: <= 50

Additional information to track your orders in your system, by providing custom metadata using "<key>" : "<value>" pairs.

caution

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 values: <= 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.

caution

Restrictions:

  • Max length of merchant_order_uri string: 2000
  • Only valid http:// or https:// domains are accepted
  • Domain cannot be localhost or IP address
Was this page helpful?
Loading...