---
title: "Forward payment method"
method: POST
path: "/v1/payment_methods/{payment_method_id}/forward"
tags: ["Forward Requests"]
---

# Forward payment method

`POST /v1/payment_methods/{payment_method_id}/forward`

Forward payment method details to an approved 3rd party. This endpoint requires Rainforest approval.

## Path parameters

- `payment_method_id` string, required

## Headers

- `Rainforest-Api-Version` '2024-10-16' | '2023-12-01'

## Request body

- object
  - `url` string — The 3rd party URL to forward the payment method details to. The platform must be approved to forward the request to the URL.
  - `http_method` string — The HTTP Method to use to forward the request to the 3rd party.
  - `headers` object — HTTP Headers to include while forwarding the request to the 3rd party.
  - `body` string — The body template to use while forwarding the request to the 3rd party.

## Response `200`

OK

- object
  - `status` 'SUCCESS' | 'ERROR' — Status of the request. If the request status code is 2XX, then the `status` will be `SUCCESS`. If the request status code is 4XX or 5XX, then the `status` will be `ERROR`.
  - `data` object — Response to Forward Request
    - `forward_request_id` string — The unique Forward Request identifier. Prefix is "fwd" in production and "sbx_fwd" in sandbox.
    - `url` string — The 3rd party URL the request was forwarded to.
    - `http_method` string — The HTTP Method used to forward the request.
    - `payment_method_id` string — The unique payment method identifier. Prefix is "mtd" in production and "sbx_mtd" in sandbox.
    - `merchant_id` string — The unique merchant identifier. Prefix is "mid" in production and "sbx_mid" in sandbox.
    - `request_details` object
      - `headers` object — The HTTP request headers forwarded to the 3rd party.
      - `body` string — The body template used to forward to the 3rd party.
    - `response_details` object
      - `headers` object — The HTTP response headers returned from the 3rd party.
      - `status_code` number — The HTTP response status code returned from the 3rd party.
      - `body` string — The HTTP response body returned from the 3rd party.
  - `errors` object[] — List of errors, if applicable.
    - `field` string — The field in the request that had an error, if applicable.
    - `code` string — The code describing the error.
    - `message` string — The description of the error related to the field.

## Other responses

- `400` — Bad request, check for validation errors.
- `401` — Authorization missing or invalid.
- `403` — Authorization insufficient for requested action.
- `404` — Resource not found.
- `5XX` — Unexpected error.

---

[API](https://skmtc.dev/rainforestpay/apis/authentication.md) · [All operations](https://skmtc.dev/rainforestpay/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rainforestpay/authentication/revisions/529a0dab0f90/schema)