v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB

Vault Instant Proxy

Execute an instant proxy request

Executes a proxy request from our Vault to an external provider.

post/payment/providers/{providerId}/proxy

Path parameters

providerIdstring uuid required

Identifier of the resource in Payrails.

Headers

x-idempotency-keystring uuid required

Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.

Acceptstring required

Accept key indicates which content types the client is able to understand.

Content-Typestring required

Content Type key to indicate the original media type of the resource.

Authorizationstring

Authorization header used to authenticate requests. Mandatory for payments via Checkout and send the bearer token from Checkout.

Request body

paymentInstrumentIdstring uuid required

Payment Instrument that should be used.

headersobject required

Headers that should be used for the request to the provider. The "Content-Type" header is required and must be passed exactly once.

urlstring uri required

URL address of the payment provider server to be called.

bodyobject required

Body that should be used for the request to the provider.

encryptedSecurityCodestring

Encrypted instrument security code replacing the security code from an earlier tokenization (if any). The instrument security code should be encrypted with the RSA public key provided by Payrails SDK using JWE with encryption algorithm RSA-OAEP-256 and content encryption A256CBC-HS512.

Response

Executed.

statusinteger required

HTTP status that was returned by the provider.

headersobject

Headers that were returned by the provider.

bodyobject

Body that was returned by the provider.