Files
rust-mollie-sdk/docs/DelayedRoutingApiApi.md
Zomatree e738db98b9 init
2025-10-20 14:41:17 +01:00

2.9 KiB

\DelayedRoutingApiApi

All URIs are relative to https://api.mollie.com/v2

Method HTTP request Description
payment_create_route POST /payments/{paymentId}/routes Create a delayed route
payment_list_routes GET /payments/{paymentId}/routes List payment routes

payment_create_route

models::RouteCreateResponse payment_create_route(payment_id, idempotency_key, route_create_request) Create a delayed route

Create a route for a specific payment. The routed amount is credited to the account of your customer.

Parameters

Name Type Description Required Notes
payment_id String Provide the ID of the related payment. [required]
idempotency_key Option<String> A unique key to ensure idempotent requests. This key should be a UUID v4 string.
route_create_request Option<RouteCreateRequest>

Return type

models::RouteCreateResponse

Authorization

apiKey, oAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/hal+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

payment_list_routes

models::PaymentListRoutes200Response payment_list_routes(payment_id, testmode, idempotency_key) List payment routes

Retrieve a list of all routes created for a specific payment.

Parameters

Name Type Description Required Notes
payment_id String Provide the ID of the related payment. [required]
testmode Option<bool> Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter can be omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true. Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
idempotency_key Option<String> A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Return type

models::PaymentListRoutes200Response

Authorization

apiKey, oAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/hal+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]