Skip to main content
POST
/
vault-forward
curl --request POST \
  --url https://api.sandbox.{id}.gr4vy.app/vault-forward \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: */*' \
  --header 'x-vault-forward-checkout-session: <x-vault-forward-checkout-session>' \
  --header 'x-vault-forward-http-method: <x-vault-forward-http-method>' \
  --header 'x-vault-forward-payment-methods: <x-vault-forward-payment-methods>' \
  --header 'x-vault-forward-url: <x-vault-forward-url>' \
  --data '"{\n  \"number\":\"{{CARD_NUMBER_1}}\",\n  \"expiry\":\"{{CARD_EXPIRATION_DATE_1}}\"\n}\n"'
"<string>"
This endpoint requires the vault-forwards.write scope.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-vault-forward-payment-methods
string
required

A comma-separated list of Payment Method IDs that can be used to fill in the request template. At least 1 must be given, and a maximum of 100 are accepted.

Example:

"faaad066-30b4-4997-a438-242b0752d7e1,faaad066-30b4-4997-a438-242b0752d7e2"

​
x-vault-forward-checkout-session
string
required

A Checkout Session IDs that can be used to fill in the request template. At most 1 can be provided.

Example:

"faaad066-30b4-4997-a438-242b0752d7e2"

​
x-vault-forward-authentications
string

A comma-separated list of IDs for the authentication methods that will be applied to a Vault Forward request.

Example:

"faaad066-30b4-4997-a438-242b0752d7e1,faaad066-30b4-4997-a438-242b0752d7e2"

​
x-vault-forward-url
string
required

The URL to forward card data to.

Example:

"https://api.amadeus.com/booking"

​
x-vault-forward-http-method
enum<string>
required

The HTTP method that is used when forwarding the request to the x-vault-forward-url.

Available options:
POST,
PUT,
PATCH
Example:

"POST"

​
x-vault-forward-header-{HEADER_NAME}
string

A header that is forwarded to the x-vault-forward-url. The header will be forwarded without the x-vault-forward-header part. For example, x-vault-forward-header-x-frame-options: SAMEORIGIN is forwarded as x-frame-options: SAMEORIGIN.

Example:

"x-vault-forward-header-x-frame-options"

​
x-vault-forward-timeout
integer
default:30

The number of seconds to wait before timing out when forwarding the request.

Required range: x >= 1
Example:

10

Body

*/* · string

Payload to forward in the request.

The body is of type string.

Response

Returns the payload received from the forwarded request. If the request timed out or there was a network error, the payload will be empty instead.

The response is of type string.