JUjustifi
Forwarding

Get a Forwarding Request

Retrieve a forwarding request, and the destination's response once there is one.

While status is pending or processing, response is null. Once status is completed, response holds the status code, body and headers the destination answered with — a completed forwarding request means the destination answered, not that it accepted the request, so check response.status_code. Once status is failed, response stays null and failure_reason explains why the destination could not be reached.

Card details are never returned in readable form. The card number renders as its last four digits in request.body, every value in request.headers renders as [FILTERED], and anything in the destination's response that looks like a card number is reduced to its last four digits.

get/forwarding/requests/{id}

Request

Path parameters

idstring uuid required

Headers

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Sub-Accountstring

the id of the sub account that this request applies to

Response

Successfully get forwarding request

idstring uuid

the object id, also found in the data object

typestring

the object type, or array of objects

page_infounknown

Example response

{
  "id": "prefix_xyz (same as id of data object)",
  "type": "forwarding_request",
  "data": {
    "id": "fwd_123xyz",
    "account_id": "acc_123xyz",
    "payment_method_id": "pm_123xyz",
    "url": "https://api.stripe.com/v1/payment_methods",
    "http_method": "POST",
    "provider": "stripe",
    "status": "completed",
    "failure_reason": "timeout",
    "replacements": [
      "card_number",
      "card_expiry_month",
      "card_expiry_year",
      "cardholder_name"
    ],
    "request": {
      "body": {
        "type": "card",
        "card": {
          "number": "4242",
          "exp_month": 5,
          "exp_year": 2042
        },
        "billing_details": {
          "name": "Lindsay Whalen"
        }
      },
      "headers": {
        "Authorization": "[FILTERED]",
        "Content-Type": "[FILTERED]"
      }
    },
    "response": {
      "id": "fwdr_123xyz",
      "status_code": 200,
      "body": {
        "id": "pm_1QabcStripeExample",
        "object": "payment_method",
        "card": {
          "last4": "4242"
        }
      },
      "headers": {
        "content-type": "application/json",
        "request-id": "req_stripe_123"
      },
      "response_time_ms": 512
    },
    "attempted_at": "2024-01-01T12:00:01Z",
    "created_at": "2024-01-01T12:00:00Z",
    "updated_at": "2024-01-01T12:00:02Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.