> ## Documentation Index
> Fetch the complete documentation index at: https://www.marqeta.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Credit Payments

> Use this view endpoint to retrieve payment details for the credit accounts in a program. The data is derived from the balance-related activity on the Marqeta platform.

export const EndpointCard = ({method = "API", title, children, href, arrow = true}) => {
  const METHOD_STYLES = {
    GET: {
      bg: "mint-bg-green-400/20 dark:mint-bg-green-400/20",
      text: "mint-text-green-700 dark:mint-text-green-400",
      border: "mint-border-green-300 dark:mint-border-green-700"
    },
    POST: {
      bg: "mint-bg-blue-400/20 dark:mint-bg-blue-400/20",
      text: "mint-text-blue-700 dark:mint-text-blue-400"
    },
    PUT: {
      bg: "mint-bg-yellow-400/20 dark:mint-bg-yellow-400/20",
      text: "mint-text-yellow-700 dark:mint-text-yellow-400"
    },
    PATCH: {
      bg: "mint-bg-orange-400/20 dark:mint-bg-orange-400/20",
      text: "mint-text-orange-700 dark:mint-text-orange-400"
    },
    DELETE: {
      bg: "mint-bg-red-400/20 dark:mint-bg-red-400/20",
      text: "mint-text-red-700 dark:mint-text-red-400"
    },
    API: {
      bg: "mint-bg-black",
      text: "mint-text-white"
    }
  };
  const MethodBadge = ({method}) => {
    const style = METHOD_STYLES[method?.toUpperCase()] ?? METHOD_STYLES.GET;
    return <span className={`
          method-pill rounded-lg font-semibold px-1.5 py-0.5 text-xs leading-5 ${style.bg} ${style.text}`}>
        {method?.toUpperCase()}
      </span>;
  };
  const content = <div className="group flex items-center gap-4 border border-gray-200 dark:border-gray-700 rounded-xl p-5 hover:border-gray-400 dark:hover:border-gray-500 hover:shadow-md transition-all cursor-pointer">
      {}
      <div className="shrink-0">
        <MethodBadge method={method} />
      </div>
      {}
      <div className="flex-1 min-w-0">
        <p className="font-semibold text-gray-900 dark:text-white text-sm leading-snug">{title}</p>
        {children && <p className="mt-1 text-sm text-gray-500 dark:text-gray-400 line-clamp-2">{children}</p>}
      </div>
    </div>;
  if (!href) return content;
  return <a href={href} className="block no-underline border-b-0 mb-2">
      {content}
    </a>;
};

Use this view endpoint to retrieve payment details for the credit accounts in a program. The data is derived from the balance-related activity on the Marqeta platform.

This endpoint supports multiple response formats, query filtering, field filtering, sorting, pagination, and currency conversion. For more information about response options, see [Response Customization](/diva-api/response-customization/).

<h2 id="_retrieve_payments_detail_json">
  Retrieve payments detail (JSON)
</h2>

**Action:** `GET`\
**Endpoint:** `/views/credit/payments/detail`

Retrieve payment details for the credit accounts in a program. This endpoint returns a JSON object that contains an array of records matching your filter query.

<h3 id="_sample_response_body">
  Sample response body
</h3>

The following sample shows a representative response for a `GET` request to the `/views/credit/payments/detail?program=my_program&fields=post_date,currency,amount_to_send` endpoint.

```json JSON expandable lines wrap theme={null}
{
    "total": 76,
    "is_more": false,
    "count": 76,
    "info": {},
    "start_date": null,
    "end_date": null,
    "last_run_time": "",
    "schema": [
        {
            "field": "amount",
            "type": "NUMBER",
            "scale": 2.0,
            "character_maximum_length": null,
            "description": "#N/A",
            "display": "Amount",
            "units": null,
            "has_total": true,
            "is_filter_only": false
        },
        {
            "field": "interest_allocation",
            "type": "NUMBER",
            "scale": 2.0,
            "character_maximum_length": null,
            "description": null,
            "display": "Interest Allocation",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        },
        {
            "field": "fees_allocation",
            "type": "NUMBER",
            "scale": 2.0,
            "character_maximum_length": null,
            "description": null,
            "display": "Fees Allocation",
            "units": null,
            "has_total": false,
            "is_filter_only": false
        }
    ],
    "records": [
        {
            "amount": 250.0,
            "interest_allocation": 12.0,
            "fees_allocation": 2.0
        },
        {
            "amount": 2100.0,
            "interest_allocation": 30.0,
            "fees_allocation": 12.0
        },

        ...

        {
            "amount": 300.98,
            "interest_allocation": 15.0,
            "fees_allocation": 4.0
        }
    ]
}
```

<h2 id="_retrieve_payments_detail_file_export">
  Retrieve payments detail (file export)
</h2>

**Action:** `GET`\
**Endpoint:** `/views/credit/payments/detail/{export_type}`

Retrieve payment details for the credit accounts in a program and export to a file. This endpoint asynchronously generates a file in the specified format and returns a job token for retrieving the file when it is completed. The file contains a list of records matching your filter query.

<h3 id="_url_path_parameters">
  URL path parameters
</h3>

| Fields                                       | Description                                                                              |
| -------------------------------------------- | ---------------------------------------------------------------------------------------- |
| export\_type<br /><br />string<br />Required | File format in which to export the data.<br /><br />**Allowable Values:**<br /><br />csv |

<h3 id="_query_parameters">
  Query parameters
</h3>

| Fields                                   | Description                                                                                                                               |
| ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| compress<br /><br />string<br />optional | Type of file compression for the exported file.<br /><br />**Allowable Values:**<br /><br />gz, zip<br /><br />**Default value:**<br />gz |

<h3 id="_sample_response_body_2">
  Sample response body
</h3>

```json JSON lines wrap theme={null}
{
    "token": "111122226c444d8888888a9999ae11111db63da4.csv.gz"
}
```

<h2 id="_retrieve_schema_for_payments_detail">
  Retrieve schema for payments detail
</h2>

**Action:** `GET`\
**Endpoint:** `/views/credit/payments/detail/schema`

Retrieve a JSON representation of the payments detail view schema for credit accounts in a program. The schema object contains an array of objects that describe the available columns and the data type of each column.

<h3 id="_sample_response_body_3">
  Sample response body
</h3>

The following sample shows a representative response for a `GET` request to the `/views/credit/payments/detail/schema?program=my_program` endpoint. The schema can vary based on the data you are authorized to access (based on the credentials you provide in your request).

```json JSON expandable lines wrap theme={null}
[[
    {
        "field": "token",
        "type": "character varying(36)",
        "display": "Token",
        "description": "#N/A",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "account_token",
        "type": "character varying(36)",
        "display": "Account Token",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "method",
        "type": "character varying(255)",
        "display": "Method",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "payment_source_token",
        "type": "character varying(36)",
        "display": "Payment Source Token",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "amount",
        "type": "numeric(14,2)",
        "display": "Amount",
        "description": "#N/A",
        "units": "USD",
        "has_total": true,
        "is_filter_only": false
    },
    {
        "field": "interest_allocation",
        "type": "numeric(14,2)",
        "display": "Interest Allocation",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "fees_allocation",
        "type": "numeric(14,2)",
        "display": "Fees Allocation",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "purchases_allocation",
        "type": "numeric(14,2)",
        "display": "Purchases Allocation",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "currency_code",
        "type": "character varying(3)",
        "display": "Currency Code",
        "description": "The three-number code of the currency.",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "status",
        "type": "character varying(255)",
        "display": "Status",
        "description": "The program status.",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "description",
        "type": "character varying(255)",
        "display": "Description",
        "description": null,
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "created_time",
        "type": "timestamp without time zone",
        "display": "Created Time",
        "description": "The time the ACH verification was created.",
        "date_format": "YYYY-MM-DD HH:mm:ss",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    },
    {
        "field": "report_load_timestamp",
        "type": "timestamp without time zone",
        "display": "Report Load Timestamp",
        "description": "UTC time when the record was loaded into Marqeta's reporting system",
        "date_format": "YYYY-MM-DD",
        "units": null,
        "has_total": false,
        "is_filter_only": false
    }
]
```