> ## 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.

# List account payments

> Retrieve an array of payments on a credit account.

GET/credit/accounts/\{account\_token}/payments

Retrieve an array of payments on a credit account.

This endpoint supports [sorting and pagination](https://www.marqeta.com/docs/core-api/sorting-and-pagination.md).

## URL path parameters

| Fields | Description |
| - | - |
| account\_token string  Required | Unique identifier of the credit account for which to retrieve payments. Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens. **Allowable Values:**  Existing account token |

## URL query parameters

| Fields | Description |
| - | - |
| start\_date date  Optional | Beginning of the date range of the payments to return. **Allowable Values:**  Example: 2024-01-01 |
| end\_date date  Optional | End of the date range of the payments to return. **Allowable Values:**  Example: 2024-02-01 |
| count integer  Optional | Number of account payments resources to retrieve. **Allowable Values:**  1–100 |
| start\_index integer  Optional | Sort order index of the first resource in the returned array. **Allowable Values:**  0 min |
| sort\_by string  Optional | Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. **NOTE:** You must sort using system field names such as `lastModifiedTime`, and not by the field names appearing in response bodies such as `last_modified_time`. **Allowable Values:**  `lastModifiedTime`, `-lastModifiedTime` |
| statuses array of strings  Optional | Array of statuses by which to filter payments. **Allowable Values:**  `INITIATED`, `PENDING`, `PROCESSING`, `SUBMITTED`, `CANCELLED`, `COMPLETED`, `RETURNED`, `REFUNDED`, `SYS_ERROR`, `ACH_ERROR` |

## Response body

| Fields | Description |
| - | - |
| count integer  Returned | Number of resources returned. **Allowable Values:**  1-10 |
| start\_index integer  Returned | Sort order index of the first resource in the returned array. **Allowable Values:**  Any integer |
| end\_index integer  Returned | Sort order index of the last resource in the returned array. **Allowable Values:**  Any integer |
| is\_more boolean  Returned | A value of `true` indicates that more unreturned resources exist. **Allowable Values:**  `true`, `false` |
| data array of objects  Returned | Contains one or more payments on a credit account. **Allowable Values:**  One or more payment objects |
| data\[].**token** string  Returned | Unique identifier of the payment. If in the `detail_object`, unique identifier of the detail object. **Allowable Values:**  36 char max |
| data\[].**account\_token** string  Returned | Unique identifier of the credit account on which the payment is made. **Allowable Values:**  36 char max  Existing account token |
| data\[].**method** string  Returned | Method of payment. **Allowable Values:**  `ACH`, `CHECK`, `DEBIT`, `CASH` |
| data\[].**payment\_source\_token** string  Conditionally returned | Unique identifier of the payment source. Required for ACH payments. **Allowable Values:**  Existing payment source token |
| data\[].**payment\_schedule\_token** string  Conditionally returned | Unique identifier of the payment schedule. **Allowable Values:**  36 char max |
| data\[].**amount** decimal  Returned | Total amount of the payment. **Allowable Values:**  0 min |
| data\[].**currency\_code** string  Returned | Valid three-digit [ISO 4217 currency code](https://www.iso.org/iso-4217-currency-codes.html). **Allowable Values:**  `USD` |
| data\[].**status** string  Returned | Current status of the payment or refund. **Allowable Values:**  `INITIATED`, `PENDING`, `PROCESSING`, `SUBMITTED`, `CANCELLED`, `COMPLETED`, `RETURNED`, `REFUNDED`, `SYS_ERROR`, `ACH_ERROR` |
| data\[].**description** string  Returned | Description of the payment. **Allowable Values:**  255 char max |
| data\[].**metadata** string  Conditionally returned | Customer-defined additional information about the payment (for example, a check number). **Allowable Values:**  255 char max |
| data\[].**hold\_days** integer  Returned | After a payment completes, the number of days to hold the available credit on the account before increasing it. **Allowable Values:**  Any integer |
| data\[].**hold\_end\_time** datetime  Conditionally returned | Date and time when the available credit hold is released. **Allowable Values:**  Format: yyyy-MM-ddThh:mm:ssZ |
| data\[].**is\_manually\_released** boolean  Conditionally returned | Whether the available credit hold was manually released for this payment. **Allowable Values:**  `true`, `false` **Default value:** `false` |
| data\[].**on\_hold** boolean  Conditionally returned | Whether the available credit is on hold for this payment. **Allowable Values:**  `true`, `false` **Default value:** `false` |
| data\[].**returned\_details** object  Conditionally returned | Contains information on a returned payment. **Allowable Values:**  Existing `returned_details` object |
| data\[].returned\_details.**return\_code** string  Returned | Return code for the returned payment. For more, see [NACHA ACH return codes](https://www.marqeta.com/docs/developer-guides/ach-origination.md#_nacha_ach_return_codes). **Allowable Values:**  Valid return code |
| data\[].returned\_details.**return\_reason** string  Returned | Reason the payment was returned. For more, see [NACHA ACH return codes](https://www.marqeta.com/docs/developer-guides/ach-origination.md#_nacha_ach_return_codes). **Allowable Values:**  Valid return reason |
| data\[].**refund\_details** object  Conditionally returned | Contains details for a refund. **Allowable Values:**  Existing `refund_details` object |
| data\[].refund\_details.**method** string  Returned | Payment instrument used to issue the refund. **Allowable Values:**  `ACH`, `CHECK` |
| data\[].refund\_details.**description** string  Returned | Description of the refund. **Allowable Values:**  255 char max |
| data\[].refund\_details.**status** string  Returned | Current status of the refund. **Allowable Values:**  `INITIATED`, `PENDING`, `PROCESSING`, `SUBMITTED`, `CANCELLED`, `COMPLETED`, `RETURNED` |
| data\[].**waive\_returned\_payment\_fee** boolean  Conditionally returned | A value of `true` indicates that a returned payment fee should not be applied. The default value of this field is `false`. This field is only considered when transitioning the status of the fee to `REFUNDED`. **Allowable Values:**  `true`, `false` |
| data\[].**created\_time** datetime  Returned | Date and time when the payment was created on Marqeta's credit platform, in UTC. **Allowable Values:**  Format: yyyy-MM-ddThh:mm:ssZ |
| data\[].**updated\_time** datetime  Returned | Date and time when the payment was last updated on Marqeta's credit platform, in UTC. **Allowable Values:**  Format: yyyy-MM-ddThh:mm:ssZ |
| data\[].**transitions** array of objects  Returned | Contains one or more `transitions` objects, which contain information about a payment status transition. **Allowable Values:**  One or more `transitions` objects |
| data\[].transitions\[].**token** string  Returned | Unique identifier of the payment status transition. **Allowable Values:**  36 char max |
| data\[].transitions\[].**account\_token** string  Returned | Unique identifier of the credit account on which you want to transition a payment status. **Allowable Values:**  Existing account token |
| data\[].transitions\[].**payment\_token** string  Returned | Unique identifier of the payment whose status you want to transition. **Allowable Values:**  Existing payment token |
| data\[].transitions\[].**status** string  Returned | Current status of the payment or refund. **Allowable Values:**  `INITIATED`, `PENDING`, `PROCESSING`, `SUBMITTED`, `CANCELLED`, `COMPLETED`, `RETURNED`, `REFUNDED`, `SYS_ERROR`, `ACH_ERROR` |
| data\[].transitions\[].**created\_time** datetime  Conditionally returned | Date and time when the payment transition was created on Marqeta's credit platform, in UTC. **Allowable Values:**  Format: yyyy-MM-ddThh:mm:ssZ |
| data\[].**allocations** array of objects  Conditionally returned | List of objects that contain information about how a payment is allocated. **Allowable Values:**  List of payment allocations |
| data\[].allocations\[].**bucket** undefined  Returned | Category to which a portion of the payment is allocated. **Allowable Values:**  `PRINCIPAL`, `INTEREST`, `FEES`  36 char max |
| data\[].allocations\[].**amount** decimal  Returned | Total amount of the payment allocation. **Allowable Values:**  0 min |
| data\[].**program\_migration\_time** datetime  Conditionally returned | Date and time when the statement summary was migrated to Marqeta's credit platform, in UTC. The value of this field is `null` if it has not been migrated. **Allowable Values:**  Format: yyyy-MM-ddThh:mm:ssZ |

## Sample response body

```json JSON expandable lines wrap theme={null}
{
  "count": 2,
  "start_index": 0,
  "end_index": 2,
  "is_more": false,
  "data": [
    {
      "token": "4749ab00-fec1-471c-ac5b-b8d31d06d7e4",
      "account_token": "7d68f45b-1232-4283-a0ea-6b0418d37692",
      "method": "ACH",
      "payment_source_token": "4474c16b-7ba7-435b-8854-237d492e3f32",
      "amount": 2500,
      "currency_code": "USD",
      "status": "COMPLETED",
      "description": "Account statement payment",
      "metadata": "\\\"bank_account_last_4_digits\\\":\\\"7234\\\\\"bank_name\\\":\\\"Bank Finance Plus\\\"",
      "hold_days": 1,
      "hold_end_time": "2024-02-03T11:32:24.727Z",
      "is_manually_released": false,
      "on_hold": false,
      "returned_details": null,
      "created_time": "2024-01-31T15:03:09.717Z",
      "updated_time": "2024-02-03T12:00:30.072Z",
      "transitions": [
        {
          "token": "b62d45d5-4495-4490-a898-3781229b235d",
          "account_token": "7d68f45b-1232-4283-a0ea-6b0418d37692",
          "payment_token": "4749ab00-fec1-471c-ac5b-b8d31d06d7e4",
          "status": "PROCESSING",
          "created_time": "2024-02-01T02:04:11.645Z"
        },
        {
          "token": "82d79178-5c97-41c2-80e5-bd99bb6bb61c",
          "account_token": "7d68f45b-1232-4283-a0ea-6b0418d37692",
          "payment_token": "4749ab00-fec1-471c-ac5b-b8d31d06d7e4",
          "status": "SUBMITTED",
          "created_time": "2024-02-01T03:39:22.505Z"
        },
        {
          "token": "c2a83d12-eeff-460a-b88a-bf7a2e40b251",
          "account_token": "7d68f45b-1232-4283-a0ea-6b0418d37692",
          "payment_token": "4749ab00-fec1-471c-ac5b-b8d31d06d7e4",
          "status": "PENDING",
          "created_time": "2024-01-31T15:30:45.028Z"
        },
        {
          "token": "156b5134-b37d-49cf-89d5-7123b321ba5c",
          "account_token": "7d68f45b-1232-4283-a0ea-6b0418d37692",
          "payment_token": "4749ab00-fec1-471c-ac5b-b8d31d06d7e4",
          "status": "COMPLETED",
          "created_time": "2024-02-02T11:32:24.727Z"
        },
        {
          "token": "64ca6c83-937c-4d37-86ae-14766bf87540",
          "account_token": "7d68f45b-1232-4283-a0ea-6b0418d37692",
          "payment_token": "4749ab00-fec1-471c-ac5b-b8d31d06d7e4",
          "status": "INITIATED",
          "created_time": "2024-01-31T15:03:09.723Z"
        }
      ]
    },
    {
      "token": "my_payment_25",
      "account_token": "my_account_token_12",
      "method": "CHECK",
      "amount": 25,
      "currency_code": "USD",
      "status": "COMPLETED",
      "description": "minimum payment",
      "hold_days": 0,
      "is_manually_released": false,
      "on_hold": false,
      "created_time": "2024-09-03T23:03:05.675Z",
      "updated_time": "2024-09-03T23:03:05.675Z",
      "transitions": [
        {
          "token": "my_transition_token1234",
          "account_token": "my_account_token_12",
          "payment_token": "my_payment_25",
          "status": "COMPLETED",
          "created_time": "2024-09-03T23:03:05.683Z"
        }
      ],
      "allocations": [
        {
          "bucket": "PRINCIPAL",
          "amount": 25
        },
        {
          "bucket": "INTEREST",
          "amount": 15
        },
        {
          "bucket": "FEES",
          "amount": 5
        }
      ]
    }
  ]
}
```


## Related topics

- [Payments Overview](https://www.marqeta.com/docs/core-api/credit-account-payments.md)
- [List payment schedules](https://www.marqeta.com/docs/core-api/credit-account-payment-schedules/list-payment-schedules.md)
- [List payment sources](https://www.marqeta.com/docs/core-api/credit-account-payment-sources/list-payment-sources.md)
- [List accounts](https://www.marqeta.com/docs/core-api/credit-accounts/list-accounts.md)
- [List account adjustments](https://www.marqeta.com/docs/core-api/credit-account-adjustments/list-account-adjustments.md)
