Overview
- POST /api/orders
- GET /api/1.0/orders
- POST /api/1.0/orders
- GET /api/orders/{order_id}
- PATCH /api/orders/{order_id}
- PARAMETERS /api/orders/{order_id}
- POST /api/orders/{order_id}/capture
- PARAMETERS /api/orders/{order_id}/capture
- POST /api/1.0/orders/{order_id}/cancel
- PARAMETERS /api/1.0/orders/{order_id}/cancel
- POST /api/1.0/orders/{order_id}/refund
- PARAMETERS /api/1.0/orders/{order_id}/refund
- POST /api/1.0/orders/{order_id}/payments
- PARAMETERS /api/1.0/orders/{order_id}/payments
- GET /api/1.0/customers
- POST /api/1.0/customers
- GET /api/1.0/customers/{customer_id}
- DELETE /api/1.0/customers/{customer_id}
- PATCH /api/1.0/customers/{customer_id}
- PARAMETERS /api/1.0/customers/{customer_id}
- GET /api/1.0/customers/{customer_id}/payment-methods
- PARAMETERS /api/1.0/customers/{customer_id}/payment-methods
- GET /api/1.0/customers/{customer_id}/payment-methods/{payment_method_id}
- DELETE /api/1.0/customers/{customer_id}/payment-methods/{payment_method_id}
- PATCH /api/1.0/customers/{customer_id}/payment-methods/{payment_method_id}
- PARAMETERS /api/1.0/customers/{customer_id}/payment-methods/{payment_method_id}
- GET /api/payments/{payment_id}
- PARAMETERS /api/payments/{payment_id}
- POST /api/report-runs
- GET /api/report-runs/{report_run_id}
- PARAMETERS /api/report-runs/{report_run_id}
- GET /api/report-runs/{report_run_id}/file
- PARAMETERS /api/report-runs/{report_run_id}/file
- GET /api/1.0/webhooks
- POST /api/1.0/webhooks
- GET /api/1.0/webhooks/{webhook_id}
- DELETE /api/1.0/webhooks/{webhook_id}
- PATCH /api/1.0/webhooks/{webhook_id}
- PARAMETERS /api/1.0/webhooks/{webhook_id}
- POST /api/1.0/webhooks/{webhook_id}/rotate-signing-secret
- PARAMETERS /api/1.0/webhooks/{webhook_id}/rotate-signing-secret
- GET /api/locations
- POST /api/locations
- GET /api/locations/{location_id}
- DELETE /api/locations/{location_id}
- PATCH /api/locations/{location_id}
- PARAMETERS /api/locations/{location_id}
- POST /api/apple-pay/domains/register
- GET /api/synchronous-webhooks
- POST /api/synchronous-webhooks
- DELETE /api/synchronous-webhooks/{synchronous_webhook_id}
- PARAMETERS /api/synchronous-webhooks/{synchronous_webhook_id}
- GET /api/1.0/orders/{order_id}
- PATCH /api/1.0/orders/{order_id}
- PARAMETERS /api/1.0/orders/{order_id}
- POST /api/1.0/orders/{order_id}/capture
- PARAMETERS /api/1.0/orders/{order_id}/capture
POST /api/orders
Summary: Create an order
Create an Order object.
Full documentation: Merchant API - Create an order
OpenAPI snippet URL
GET /api/1.0/orders
Summary: Retrieve an order list
Retrieve all the orders that you’ve created. You can also use the query parameters for:
- Filtering
- Pagination
The response contains an array of simplified Order objects.
Full documentation: Merchant API - Retrieve an order list
OpenAPI snippet URL
POST /api/1.0/orders
Summary: Create an order (Deprecated)
Create an Order object.
Full documentation: Merchant API - Create an order (Deprecated)
OpenAPI snippet URL
GET /api/orders/{order_id}
Summary: Retrieve an order
Retrieve the details of an order that has been created. Provide the unique order ID, and the corresponding order information is returned.
Full documentation: Merchant API - Retrieve an order
OpenAPI snippet URL
PATCH /api/orders/{order_id}
Summary: Update an order
Update the details of an order.
Specific limitations apply based on the state of the order, see full documentation: Merchant API - Update an order.
OpenAPI snippet URL
PARAMETERS /api/orders/{order_id}
OpenAPI snippet URL
POST /api/orders/{order_id}/capture
Summary: Capture an order
Capture the funds of an existing, uncaptured order. When the payment for an order is authorized, the order is captured and sent to the processing stage.
Full documentation: Merchant API - Capture an order
OpenAPI snippet URL
PARAMETERS /api/orders/{order_id}/capture
OpenAPI snippet URL
POST /api/1.0/orders/{order_id}/cancel
Summary: Cancel an order
Cancel an existing uncaptured order.
Specific limitations apply based on the state of the order, see full documentation: Merchant API - Cancel an order
OpenAPI snippet URL
PARAMETERS /api/1.0/orders/{order_id}/cancel
OpenAPI snippet URL
POST /api/1.0/orders/{order_id}/refund
Summary: Refund an order
Issue a refund for a completed order. A refund can be either full or partial.
You can initiate a refund for an order only when it is in the COMPLETED state.
Full documentation: Merchant API - Refund an order
OpenAPI snippet URL
PARAMETERS /api/1.0/orders/{order_id}/refund
OpenAPI snippet URL
POST /api/1.0/orders/{order_id}/payments
Summary: Pay for an order
Initiate a payment to pay full amount for an order using a customer’s saved payment method.
Full documentation: Merchant API - Pay for an order
OpenAPI snippet URL
PARAMETERS /api/1.0/orders/{order_id}/payments
OpenAPI snippet URL
GET /api/1.0/customers
Summary: Retrieve a customer list
Get a list of all your customers.
Full documentation: Merchant API - Retrieve a customer list
OpenAPI snippet URL
POST /api/1.0/customers
Summary: Create a customer
Create a customer that has the information in the body of the request.
Full documentation: Merchant API - Create a customer
OpenAPI snippet URL
GET /api/1.0/customers/{customer_id}
Summary: Retrieve a customer
Get the information about a specific customer, based on its ID.
Full documentation: Merchant API - Retrieve a customer
OpenAPI snippet URL
DELETE /api/1.0/customers/{customer_id}
Summary: Delete a customer
Delete the profile of a specific customer.
Full documentation: Merchant API - Delete a customer
OpenAPI snippet URL
PATCH /api/1.0/customers/{customer_id}
Summary: Update a customer
Update the attributes of a specific customer.
Full documentation: Merchant API - Update a customer
OpenAPI snippet URL
PARAMETERS /api/1.0/customers/{customer_id}
OpenAPI snippet URL
GET /api/1.0/customers/{customer_id}/payment-methods
Summary: Retrieve all payment methods of a customer
Retrieve all the payment methods for a specific customer.
Full documentation: Merchant API - Retrieve all payment methods of a customer
OpenAPI snippet URL
PARAMETERS /api/1.0/customers/{customer_id}/payment-methods
OpenAPI snippet URL
GET /api/1.0/customers/{customer_id}/payment-methods/{payment_method_id}
Summary: Retrieve a customer’s payment method
Retrieve the information of a specific payment method that is saved.
Full documentation: Merchant API - Retrieve a customer’s payment method
OpenAPI snippet URL
DELETE /api/1.0/customers/{customer_id}/payment-methods/{payment_method_id}
Summary: Delete a customer’s payment method
Delete a specific payment method.
Full documentation: Merchant API - Delete a customer’s payment method
OpenAPI snippet URL
PATCH /api/1.0/customers/{customer_id}/payment-methods/{payment_method_id}
Summary: Update a customer’s payment method
When you use this request to update a customer’s payment method, the payment method can’t be used by the merchant to initiate transactions any more. This payment method can be used only when the customer is on the checkout page.
Full documentation: Merchant API - Update a customer’s payment method
OpenAPI snippet URL
PARAMETERS /api/1.0/customers/{customer_id}/payment-methods/{payment_method_id}
OpenAPI snippet URL
GET /api/payments/{payment_id}
Summary: Retrieve payment details
Retrieve information about a specific payment, based on the payment’s ID.
Full documentation: Merchant API - Retrieve payment details
OpenAPI snippet URL
PARAMETERS /api/payments/{payment_id}
OpenAPI snippet URL
POST /api/report-runs
Summary: Create a new report run
Start generating a new report of the relevant transactions.
Full documentation: Merchant API - Create a new report run
OpenAPI snippet URL
GET /api/report-runs/{report_run_id}
Summary: Retrieve report run details
Retrieve details of a report run, based on the report_run_id.
Full documentation: Merchant API - Retrieve report run details
OpenAPI snippet URL
PARAMETERS /api/report-runs/{report_run_id}
OpenAPI snippet URL
GET /api/report-runs/{report_run_id}/file
Summary: Download report file
Use this endpoint to download the generated report file.
Full documentation: Merchant API - Download report file
OpenAPI snippet URL
PARAMETERS /api/report-runs/{report_run_id}/file
OpenAPI snippet URL
GET /api/1.0/webhooks
Summary: Retrieve a webhook list
Get a list of webhooks that you are currently subscribed to.
Full documentation: Merchant API - Retrieve a webhook list
OpenAPI snippet URL
POST /api/1.0/webhooks
Summary: Create a webhook
Set up a webhook URL so that the Merchant API can push event notifications to the specified URL.
Full documentation: Merchant API - Create a webhook
OpenAPI snippet URL
GET /api/1.0/webhooks/{webhook_id}
Summary: Retrieve a webhook
Get the details of a specific webhook.
Full documentation: Merchant API - Retrieve a webhook
OpenAPI snippet URL
DELETE /api/1.0/webhooks/{webhook_id}
Summary: Delete a webhook
Delete a webhook so that events are not sent to the specified URL any more.
Full documentation: Merchant API - Delete a webhook
OpenAPI snippet URL
PATCH /api/1.0/webhooks/{webhook_id}
Summary: Update a webhook
Update the details of a specific webhook.
Full documentation: Merchant API - Update a webhook
OpenAPI snippet URL
PARAMETERS /api/1.0/webhooks/{webhook_id}
OpenAPI snippet URL
POST /api/1.0/webhooks/{webhook_id}/rotate-signing-secret
Summary: Rotate a webhook signing secret
Rotate the signing_secret for a specific webhook.
Full documentation: Merchant API: Rotate a webhook signing secret
OpenAPI snippet URL
PARAMETERS /api/1.0/webhooks/{webhook_id}/rotate-signing-secret
OpenAPI snippet URL
GET /api/locations
Summary: Retrieve location list
Retrieve a list of locations registered for the merchant.
Full documentation: Merchant API: Retrieve location list
OpenAPI snippet URL
POST /api/locations
Summary: Create a location
Create a Location object.
Full codumentation: Merchant API: Create a location
OpenAPI snippet URL
GET /api/locations/{location_id}
Summary: Retrieve a location
Retrieve details of a specific location, based on its ID.
Full documentation: Merchant API: Retrieve a location
OpenAPI snippet URL
DELETE /api/locations/{location_id}
Summary: Delete a location
Delete a specific location, based on its ID.
Full documentation: Merchant API: Delete a location
OpenAPI snippet URL
PATCH /api/locations/{location_id}
Summary: Update a location
Update details of a specific location, based on its ID.
NOTE: The value of the location’s
typecannot be updated.
Full documentation: Merchant API: Update a location
OpenAPI snippet URL
PARAMETERS /api/locations/{location_id}
OpenAPI snippet URL
POST /api/apple-pay/domains/register
Summary: Register domain for Apple Pay
Register your website’s domain to accept payments via Apple Pay.
Full documentation: Merchant API - Register domain for Apple Pay
OpenAPI snippet URL
GET /api/synchronous-webhooks
Summary: Retrieve synchronous webhook list
Retrieve a list of synchronous webhook objects.
You can use this endpoint to see your different address validation endpoints registered to different locations.
Full documentation: Merchant API - Retrieve synchronous webhook list
OpenAPI snippet URL
POST /api/synchronous-webhooks
Summary: Register address validation endpoint for Fast checkout
Use this endpoint to register a URL where Revolut can send shipping address(es) from a Revolut Pay customer for validation during the Fast checkout process.
Full documentation: Merchant API - Register address validation endpoint for Fast checkout
OpenAPI snippet URL
DELETE /api/synchronous-webhooks/{synchronous_webhook_id}
Summary: Delete a synchronous webhook
Delete a specific synchronous webhook registration, based on its ID.
Full documentation: Merchant API - Delete a synchronous webhook
OpenAPI snippet URL
PARAMETERS /api/synchronous-webhooks/{synchronous_webhook_id}
OpenAPI snippet URL
GET /api/1.0/orders/{order_id}
Summary: Retrieve an order (Deprecated)
Retrieve the details of an order that has been created. Provide the unique order ID, and the corresponding order information is returned.
Full documentation: Merchant API - Retrieve an order (Deprecated)
OpenAPI snippet URL
PATCH /api/1.0/orders/{order_id}
Summary: Update an order (Deprecated)
Update the details of an order.
Specific limitations apply based on the state of the order, see full documentation: Merchant API - Update an order (Deprecated)
OpenAPI snippet URL
PARAMETERS /api/1.0/orders/{order_id}
OpenAPI snippet URL
POST /api/1.0/orders/{order_id}/capture
Summary: Capture an order (Deprecated)
Capture the funds of an existing, uncaptured order. When the payment for an order is authorized, the order is captured and sent to the processing stage.
Full documentation: Merchant API - Capture an order (Deprecated)
OpenAPI snippet URL
PARAMETERS /api/1.0/orders/{order_id}/capture
OpenAPI snippet URL