JUjustifi
Forwarding

List Forwarding Requests

List the forwarding requests for a sub account, newest first. This endpoint supports pagination.

get/forwarding/requests

Request

Query parameters

payment_method_idstring

filter records which are associated with a payment method.

created_beforestring date-time

filter records which were created before the date and time (UTC) specified. Dates without time specified will default to 00:00:00

created_afterstring date-time

filter records which were created after the date and time (UTC) specified. Dates without time specified will default to 00:00:00

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 list forwarding requests

idnumber

the object id

typestring

the object type, or array of objects

Example response

{
  "id": 1,
  "type": "array",
  "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"
    }
  ],
  "page_info": {
    "end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd",
    "start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd"
  }
}

Changes

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