Skip to main content
Use the payments endpoints to create and retrieve payments made on a credit account, release payment holds, or transition payment statuses. A payment is an amount paid toward an account balance to reduce the total amount owed on the account. For more on payments, see About Credit Account Payments. To receive webhook notifications when ACH payment transition events occur, see Credit account payment transition events in Event Types. Creating a payment triggers the creation of a journal entry belonging to the PAYMENT group. For more on payment journal entries, see Payments in the About Credit Account Journal Entries guide.

​
Create account payment

Action: POST
Endpoint: /credit/accounts/{account_token}/payments Create a new payment to apply toward a credit account’s balance.

​
URL path parameters

FieldsDescription
account_token

string

Required		Unique identifier of the credit account for which to create a payment.

Send a GET request to /credit/accounts to retrieve existing credit account tokens.

Allowable Values:

Existing account token

​
Request body

FieldsDescription
token

string

Optional		Unique identifier of the payment.

Allowable Values:

36 char max
method

string

Required		Method of payment.

Allowable Values:

ACH, CHECK, DEBIT, CASH
payment_source_token

string

Optional		Unique identifier of the payment source. Required for ACH payments.

Allowable Values:

36 char max

Existing payment source token
amount

decimal

Required		Amount of the payment.

Allowable Values:

0 min
currency_code

string

Required		Valid three-digit ISO 4217 currency code.

Allowable Values:

USD
impact_time

datetime

Optional		Date and time when the payment impacts the account balance and fee calculations.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ
description

string

Required		Description of the payment.

Allowable Values:

255 char max
metadata

string

Optional		Customer-defined additional information about the payment (for example, a check number).

Allowable Values:

255 char max
hold_days

integer

Optional		Overrides the configured default number of days for which to hold ACH and check payments.

Allowable Values:

0–30

​
Sample request body

JSON
{
  "token": "payment_token_1239",
  "method": "ACH",
  "payment_source_token": "payment_source_token_1112",
  "amount": 2500,
  "currency_code": "USD",
  "description": "Account statement payment"
}

​
Response body

FieldsDescription
token

string

Returned		Unique identifier of the payment.

If in the detail_object, unique identifier of the detail object.

Allowable Values:

36 char max
account_token

string

Returned		Unique identifier of the credit account on which the payment is made.

Allowable Values:

36 char max

Existing account token
method

string

Returned		Method of payment.

Allowable Values:

ACH, CHECK, DEBIT, CASH
payment_source_token

string

Conditionally returned		Unique identifier of the payment source.

Required for ACH payments.

Allowable Values:

Existing payment source token
payment_schedule_token

string

Conditionally returned		Unique identifier of the payment schedule.

Allowable Values:

36 char max
amount

decimal

Returned		Total amount of the payment.

Allowable Values:

0 min
currency_code

string

Returned		Valid three-digit ISO 4217 currency code.

Allowable Values:

USD
status

string

Returned		Current status of the payment or refund.

Allowable Values:

INITIATED, PENDING, PROCESSING, SUBMITTED, CANCELLED, COMPLETED, RETURNED, REFUNDED, SYS_ERROR, ACH_ERROR
description

string

Returned		Description of the payment.

Allowable Values:

255 char max
metadata

string

Conditionally returned		Customer-defined additional information about the payment (for example, a check number).

Allowable Values:

255 char max
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
hold_end_time

datetime

Conditionally returned		Date and time when the available credit hold is released.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ
is_manually_released

boolean

Conditionally returned		Whether the available credit hold was manually released for this payment.

Allowable Values:

true, false

Default value:
false
on_hold

boolean

Conditionally returned		Whether the available credit is on hold for this payment.

Allowable Values:

true, false

Default value:
false
returned_details

object

Conditionally returned		Contains information on a returned payment.

Allowable Values:

Existing returned_details object
returned_details.return_code

string

Returned		Return code for the returned payment. For more, see NACHA ACH return codes.

Allowable Values:

Valid return code
returned_details.return_reason

string

Returned		Reason the payment was returned. For more, see NACHA ACH return codes.

Allowable Values:

Valid return reason
refund_details

object

Conditionally returned		Contains details for a refund.

Allowable Values:

Existing refund_details object
refund_details.method

string

Returned		Payment instrument used to issue the refund.

Allowable Values:

ACH, CHECK
refund_details.description

string

Returned		Description of the refund.

Allowable Values:

255 char max
refund_details.status

string

Returned		Current status of the refund.

Allowable Values:

INITIATED, PENDING, PROCESSING, SUBMITTED, CANCELLED, COMPLETED, RETURNED
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
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
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
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
transitions[].token

string

Returned		Unique identifier of the payment status transition.

Allowable Values:

36 char max
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
transitions[].payment_token

string

Returned		Unique identifier of the payment whose status you want to transition.

Allowable Values:

Existing payment token
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
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
allocations

array of objects

Conditionally returned		List of objects that contain information about how a payment is allocated.

Allowable Values:

List of payment allocations
allocations[].bucket

undefined

Returned		Category to which a portion of the payment is allocated.

Allowable Values:

PRINCIPAL, INTEREST, FEES

36 char max
allocations[].amount

decimal

Returned		Total amount of the payment allocation.

Allowable Values:

0 min
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
{
  "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,
  "refund_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"
    }
  ]
}

​
List account payments

Action: GET
Endpoint: /credit/accounts/{account_token}/payments Retrieve an array of payments on a credit account. This endpoint supports sorting and pagination.

​
URL path parameters

FieldsDescription
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

FieldsDescription
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

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

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.

Allowable Values:

Valid return code
data[].returned_details.return_reason

string

Returned		Reason the payment was returned. For more, see 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
{
  "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
        }
      ]
    }
  ]
}

​
Retrieve account payment

Action: GET
Endpoint: /credit/accounts/{account_token}/payments/{payment_token} Retrieve a payment for a credit account.

​
URL path parameters

FieldsDescription
account_token

string

Required		Unique identifier of the credit account for which to retrieve a payment.

Send a GET request to /credit/accounts to retrieve existing credit account tokens.

Allowable Values:

Existing account token
payment_token

string

Required		Unique identifier of the payment to retrieve.

Send a GET request to /credit/accounts/{token}/payments to retrieve existing payment tokens.

Allowable Values:

Existing payment token

​
Response body

FieldsDescription
token

string

Returned		Unique identifier of the payment.

If in the detail_object, unique identifier of the detail object.

Allowable Values:

36 char max
account_token

string

Returned		Unique identifier of the credit account on which the payment is made.

Allowable Values:

36 char max

Existing account token
method

string

Returned		Method of payment.

Allowable Values:

ACH, CHECK, DEBIT, CASH
payment_source_token

string

Conditionally returned		Unique identifier of the payment source.

Required for ACH payments.

Allowable Values:

Existing payment source token
payment_schedule_token

string

Conditionally returned		Unique identifier of the payment schedule.

Allowable Values:

36 char max
amount

decimal

Returned		Total amount of the payment.

Allowable Values:

0 min
currency_code

string

Returned		Valid three-digit ISO 4217 currency code.

Allowable Values:

USD
status

string

Returned		Current status of the payment or refund.

Allowable Values:

INITIATED, PENDING, PROCESSING, SUBMITTED, CANCELLED, COMPLETED, RETURNED, REFUNDED, SYS_ERROR, ACH_ERROR
description

string

Returned		Description of the payment.

Allowable Values:

255 char max
metadata

string

Conditionally returned		Customer-defined additional information about the payment (for example, a check number).

Allowable Values:

255 char max
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
hold_end_time

datetime

Conditionally returned		Date and time when the available credit hold is released.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ
is_manually_released

boolean

Conditionally returned		Whether the available credit hold was manually released for this payment.

Allowable Values:

true, false

Default value:
false
on_hold

boolean

Conditionally returned		Whether the available credit is on hold for this payment.

Allowable Values:

true, false

Default value:
false
returned_details

object

Conditionally returned		Contains information on a returned payment.

Allowable Values:

Existing returned_details object
returned_details.return_code

string

Returned		Return code for the returned payment. For more, see NACHA ACH return codes.

Allowable Values:

Valid return code
returned_details.return_reason

string

Returned		Reason the payment was returned. For more, see NACHA ACH return codes.

Allowable Values:

Valid return reason
refund_details

object

Conditionally returned		Contains details for a refund.

Allowable Values:

Existing refund_details object
refund_details.method

string

Returned		Payment instrument used to issue the refund.

Allowable Values:

ACH, CHECK
refund_details.description

string

Returned		Description of the refund.

Allowable Values:

255 char max
refund_details.status

string

Returned		Current status of the refund.

Allowable Values:

INITIATED, PENDING, PROCESSING, SUBMITTED, CANCELLED, COMPLETED, RETURNED
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
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
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
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
transitions[].token

string

Returned		Unique identifier of the payment status transition.

Allowable Values:

36 char max
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
transitions[].payment_token

string

Returned		Unique identifier of the payment whose status you want to transition.

Allowable Values:

Existing payment token
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
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
allocations

array of objects

Conditionally returned		List of objects that contain information about how a payment is allocated.

Allowable Values:

List of payment allocations
allocations[].bucket

undefined

Returned		Category to which a portion of the payment is allocated.

Allowable Values:

PRINCIPAL, INTEREST, FEES

36 char max
allocations[].amount

decimal

Returned		Total amount of the payment allocation.

Allowable Values:

0 min
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
{
  "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"
    }
  ]
}

​
Release payment hold

Action: POST
Endpoint: /credit/accounts/{account_token}/payments/{payment_token}/releasehold Manually release a payment hold on a credit account.

​
URL path parameters

FieldsDescription
account_token

string

Required		Unique identifier of the credit account on which a payment hold is being released.

Send a GET request to /credit/accounts to retrieve existing credit account tokens.

Allowable Values:

Existing account token
payment_token

string

Required		Unique identifier of the payment currently on hold.

Send a GET request to /credit/accounts/{account_token}/payments to retrieve existing payment tokens.

Allowable Values:

Existing payment token

​
Response body

FieldsDescription
token

string

Returned		Unique identifier of the payment.

If in the detail_object, unique identifier of the detail object.

Allowable Values:

36 char max
account_token

string

Returned		Unique identifier of the credit account on which the payment is made.

Allowable Values:

36 char max

Existing account token
method

string

Returned		Method of payment.

Allowable Values:

ACH, CHECK, DEBIT, CASH
payment_source_token

string

Conditionally returned		Unique identifier of the payment source.

Required for ACH payments.

Allowable Values:

Existing payment source token
payment_schedule_token

string

Conditionally returned		Unique identifier of the payment schedule.

Allowable Values:

36 char max
amount

decimal

Returned		Total amount of the payment.

Allowable Values:

0 min
currency_code

string

Returned		Valid three-digit ISO 4217 currency code.

Allowable Values:

USD
status

string

Returned		Current status of the payment or refund.

Allowable Values:

INITIATED, PENDING, PROCESSING, SUBMITTED, CANCELLED, COMPLETED, RETURNED, REFUNDED, SYS_ERROR, ACH_ERROR
description

string

Returned		Description of the payment.

Allowable Values:

255 char max
metadata

string

Conditionally returned		Customer-defined additional information about the payment (for example, a check number).

Allowable Values:

255 char max
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
hold_end_time

datetime

Conditionally returned		Date and time when the available credit hold is released.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ
is_manually_released

boolean

Conditionally returned		Whether the available credit hold was manually released for this payment.

Allowable Values:

true, false

Default value:
false
on_hold

boolean

Conditionally returned		Whether the available credit is on hold for this payment.

Allowable Values:

true, false

Default value:
false
returned_details

object

Conditionally returned		Contains information on a returned payment.

Allowable Values:

Existing returned_details object
returned_details.return_code

string

Returned		Return code for the returned payment. For more, see NACHA ACH return codes.

Allowable Values:

Valid return code
returned_details.return_reason

string

Returned		Reason the payment was returned. For more, see NACHA ACH return codes.

Allowable Values:

Valid return reason
refund_details

object

Conditionally returned		Contains details for a refund.

Allowable Values:

Existing refund_details object
refund_details.method

string

Returned		Payment instrument used to issue the refund.

Allowable Values:

ACH, CHECK
refund_details.description

string

Returned		Description of the refund.

Allowable Values:

255 char max
refund_details.status

string

Returned		Current status of the refund.

Allowable Values:

INITIATED, PENDING, PROCESSING, SUBMITTED, CANCELLED, COMPLETED, RETURNED
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
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
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
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
transitions[].token

string

Returned		Unique identifier of the payment status transition.

Allowable Values:

36 char max
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
transitions[].payment_token

string

Returned		Unique identifier of the payment whose status you want to transition.

Allowable Values:

Existing payment token
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
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
allocations

array of objects

Conditionally returned		List of objects that contain information about how a payment is allocated.

Allowable Values:

List of payment allocations
allocations[].bucket

undefined

Returned		Category to which a portion of the payment is allocated.

Allowable Values:

PRINCIPAL, INTEREST, FEES

36 char max
allocations[].amount

decimal

Returned		Total amount of the payment allocation.

Allowable Values:

0 min
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
{
  "token": "my_payment_25",
  "account_token": "my_account_token_12",
  "method": "CHECK",
  "amount": 25,
  "currency_code": "USD",
  "status": "COMPLETED",
  "description": "minimum payment",
  "metadata": "check_number123",
  "hold_days": 5,
  "hold_end_time": "2024-09-09T22:48:09.721Z",
  "is_manually_released": true,
  "on_hold": false,
  "created_time": "2024-09-09T22:42:35.065Z",
  "updated_time": "2024-09-09T22:48:09.722Z",
  "transitions": [
    {
      "token": "my_transition_token1234",
      "account_token": "account-12",
      "payment_token": "my_payment_25",
      "status": "COMPLETED",
      "created_time": "2024-09-09T22:42:35.068Z"
    }
  ]
}

​
Transition account payment status

Action: POST
Endpoint: /credit/accounts/{account_token}/payments/{payment_token}/transitions Transition a credit account payment’s status to a new status.

​
URL path parameters

FieldsDescription
account_token

string

Required		Unique identifier of the credit account for which you want to transition a payment status.

Send a GET request to /credit/accounts to retrieve existing credit account tokens.

Allowable Values:

Existing account token
payment_token

string

Required		Unique identifier of the payment whose status you want to transition.

Send a GET request to /credit/accounts/{account_token}/payments endpoint to retrieve existing payment tokens for a given account.

Allowable Values:

Existing payment token

​
Request body

FieldsDescription
token

string

Optional		Unique identifier of the payment status transition.

Allowable Values:

36 char max
status

string

Required		Current status of the payment or refund.

Allowable Values:

INITIATED, PENDING, PROCESSING, SUBMITTED, CANCELLED, COMPLETED, RETURNED, REFUNDED, SYS_ERROR, ACH_ERROR
refund_details

object

Optional		Contains details for a refund.

Allowable Values:

method, description
refund_details.method

string

Required		Payment instrument used to issue the refund.

Allowable Values:

ACH, CHECK
refund_details.description

string

Required		Description of the refund.

Allowable Values:

255 char max
waive_returned_payment_fee

boolean

Optional		A value of true indicates that a returned payment fee should not be applied if one is applicable. This is false by default. This field is only considered during a transition to REFUNDED

Allowable Values:

true, false

​
Sample request body

JSON
{
  "status": "RETURNED"
}

​
Response body

FieldsDescription
token

string

Returned		Unique identifier of the payment status transition.

Allowable Values:

36 char max
account_token

string

Returned		Unique identifier of the credit account on which you want to transition a payment status.

Allowable Values:

Existing account token
payment_token

string

Returned		Unique identifier of the payment whose status you want to transition.

Allowable Values:

Existing payment token
status

string

Returned		Current status of the payment or refund.

Allowable Values:

INITIATED, PENDING, PROCESSING, SUBMITTED, CANCELLED, COMPLETED, RETURNED, REFUNDED, SYS_ERROR, ACH_ERROR
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

​
Resend credit event notification

Action: POST
Endpoint: /credit/webhooks/{event_type}/{resource_token} Resends a credit event notification to your webhook endpoint. Although you send this request as a POST, all parameters are passed in the URL and the body is empty. The event notification is resent to your webhook endpoint and also returned in the response to this request. For details on how to configure your webhook endpoint, see the About Webhooks tutorial. For the complete /webhooks endpoint reference, see Webhooks.

​
URL path parameters

FieldsDescription
event_type

string

Required		Specifies the type of event you want to resend.

Allowable Values:

ledgerentry, journalentry, accounttransition, accountstatement, paymenttransition, delinquencytransition, paymentreminders, substatus, accountsignupbonus
resource_token

string

Required		Unique identifier of the resource for which you want to resend a notification.

- Send a GET request to /credit/accounts/{account_token}/journalentries to retrieve existing journal entry tokens.
- Send a GET request to /credit/accounts/{account_token}/ledgerentries to retrieve existing ledger entry tokens.
- Send a GET request to /accounts/{account_token}/accounttransitions to retrieve existing account transition tokens.
- Send a GET request to /credit/accounts/{account_token}/payments/{payment_token} to retrieve existing payment transition tokens.
- Send a GET request to /accounts/{account_token}/statements to retrieve existing statement summary tokens.
- Send a GET request to /accounts/{account_token}/delinquencystate/transitions to retrieve existing delinquency state transition tokens.
- Send a GET request to /accounts/{account_token}/statements/{statement_summary_token}/paymentreminders/{token} to retrieve existing payment reminder tokens.
- Send a GET request to /credit/substatuses to retrieve existing substatus tokens.
- Send a GET request to /credit/accounts to retrieve existing credit account tokens and identify the specific account for the resend event.

Allowable Values:

Existing journal entry token, ledger entry token, account transition token, payment transition token, statement summary token, delinquency transition token, or substatus token

​
Response body

FieldsDescription
unused

string

Conditionally returned		Event notification that was resent to your webhook endpoint.

Allowable Values:

Valid event notification

​
Sample response body

The following code block shows a sample of a resent creditaccounttransitions event.
JSON
{
  "token": "my_credit_account_transition_token1234",
  "account_token": "my_credit_account_token1234",
  "original_status": "UNACTIVATED",
  "status": "ACTIVE",
  "created_time": "2024-08-18T20:25:10.408Z"
}
The following code block shows a sample of a resent creditaccountstatements event.
JSON
{
  "token": "my_credit_account_statement_token",
  "account_token": "my_credit_account_token",
  "opening_balance": 496.45,
  "closing_balance": 506.41,
  "credit_limit": 500,
  "available_credit": 0,
  "past_due_amount": 10,
  "purchases": 0,
  "interest": 4.96,
  "fees": 15,
  "credits": 0,
  "payments": 10,
  "days_in_billing_cycle": 31,
  "cycle_type": "REVOLVING",
  "opening_date": "2025-03-01T05:00:00.000Z",
  "closing_date": "2025-04-01T03:59:59.999Z",
  "created_time": "2023-08-18T22:04:31.261Z"
}
The following code block shows a sample of a resent creditjournalentries event.
JSON
{
  "token": "my_journal_entry_token1234",
  "related_token": null,
  "root_token": null,
  "account_token": "my_credit_account_token1234",
  "card_token": "my_credit_card_token1234",
  "status": "PENDING",
  "group": "PURCHASE",
  "type": "authorization",
  "id": "12345678",
  "amount": 10,
  "currency_code": "USD",
  "memo": "Jane's Bakery",
  "request_time": "2024-08-18T22:06:52.000Z",
  "impact_time": "2024-08-18T22:07:21.422Z",
  "created_time": "2024-08-18T22:07:21.422Z",
  "dispute_token": null,
  "detail_token": "my_detail_token1234",
  "detail_object": {
    "type": "authorization",
    "state": "PENDING",
    "identifier": "234",
    "token": "my_detail_token1234",
    "user_token": "my_user_token",
    "acting_user_token": "my_user_token",
    "card_token": "my_credit_card_token1234",
    "gpa": {
      "currency_code": "USD",
      "ledger_balance": 510.87,
      "available_balance": 0,
      "credit_balance": 0,
      "pending_credits": 0,
      "impacted_amount": -10,
      "balances": {
        "USD": {
          "currency_code": "USD",
          "ledger_balance": 510.87,
          "available_balance": 0,
          "credit_balance": 0,
          "pending_credits": 0,
          "impacted_amount": -10
        }
      }
    },
    "gpa_order": {
      "token": "my_gpa_order_token1234",
      "amount": 10,
      "created_time": "2024-08-18T22:06:53Z",
      "last_modified_time": "2024-08-18T22:06:53Z",
      "transaction_token": "my_transaction_token1234",
      "state": "PENDING",
      "response": {
        "code": "0000",
        "memo": "Approved or completed successfully"
      },
      "funding": {
        "amount": 10,
        "source": {
          "type": "programgateway",
          "token": "**********1ab2",
          "active": true,
          "name": "credit_backed_funding_source",
          "is_default_account": false,
          "created_time": "2024-10-14T17:26:35Z",
          "last_modified_time": "2024-10-14T17:26:35Z"
        },
        "gateway_log": {
          "order_number": "my_gateway_token12345",
          "transaction_id": "my_transaction_id1234",
          "message": "Approved or completed successfully",
          "duration": 485,
          "timed_out": false,
          "response": {
            "code": "200",
            "data": {
              "jit_funding": {
                "token": "my_jit_funding_token1234",
                "method": "pgfs.authorization",
                "user_token": "my_user_token",
                "acting_user_token": "my_user_token",
                "amount": 10
              }
            }
          }
        }
      },
      "funding_source_token": "**********1ab2",
      "jit_funding": {
        "token": "my_transaction_id1234",
        "method": "pgfs.authorization",
        "user_token": "my_user_token",
        "acting_user_token": "my_user_token",
        "amount": 10
      },
      "user_token": "my_user_token",
      "currency_code": "USD"
    },
    "duration": 837,
    "created_time": "2024-08-18T22:06:52Z",
    "user_transaction_time": "2024-08-18T22:06:52Z",
    "settlement_date": "2024-08-18T00:00:00Z",
    "request_amount": 10,
    "amount": 10,
    "currency_code": "USD",
    "approval_code": "974406",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "network": "DISCOVER",
    "acquirer_fee_amount": 0,
    "acquirer": {
      "system_trace_audit_number": "376582"
    },
    "user": {
      "metadata": {
        "key1": "value1",
        "key2": "value2",
        "notification_email": "user@domain.com",
        "notification_language": "spa"
      }
    },
    "card": {
      "last_four": "9949",
      "metadata": {}
    },
    "issuer_received_time": "2024-08-18T22:06:52.771Z",
    "issuer_payment_node": "f8205a67b12b90d695b15704a64c074b",
    "network_reference_id": "484311571095",
    "card_acceptor": {
      "mid": "1234",
      "mcc": "6411",
      "name": "Jane's Bakery",
      "street_address": "1989 Fillmore St",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94115",
      "country_code": "USA"
    },
    "pos": {
      "pin_present": false,
      "partial_approval_capable": true,
      "purchase_amount_only": false,
      "is_recurring": false,
      "is_installment": false
    }
  }
}
The following code block shows a sample of a resent creditledgerentries event.
JSON
{
  "token": "my_ledger_entry_token1234",
  "related_token": null,
  "root_token": null,
  "account_token": "my_credit_account_token1234",
  "card_token": "my_credit_card_token1234",
  "status": "PENDING",
  "group": "PURCHASE",
  "type": "authorization",
  "id": "12345678",
  "amount": 10,
  "currency_code": "USD",
  "memo": "Jane's Bakery",
  "request_time": "2024-08-18T22:06:52.000Z",
  "impact_time": "2024-08-18T22:07:21.422Z",
  "created_time": "2024-08-18T22:07:21.422Z",
  "dispute_token": null,
  "detail_token": "my_detail_token1234",
  "detail_object": {
    "type": "authorization",
    "state": "PENDING",
    "identifier": "234",
    "token": "my_detail_token1234",
    "user_token": "my_user_token",
    "acting_user_token": "my_user_token",
    "card_token": "my_credit_card_token1234",
    "gpa": {
      "currency_code": "USD",
      "ledger_balance": 510.87,
      "available_balance": 0,
      "credit_balance": 0,
      "pending_credits": 0,
      "impacted_amount": -10,
      "balances": {
        "USD": {
          "currency_code": "USD",
          "ledger_balance": 510.87,
          "available_balance": 0,
          "credit_balance": 0,
          "pending_credits": 0,
          "impacted_amount": -10
        }
      }
    },
    "gpa_order": {
      "token": "my_gpa_order_token1234",
      "amount": 10,
      "created_time": "2024-08-18T22:06:53Z",
      "last_modified_time": "2024-08-18T22:06:53Z",
      "transaction_token": "my_transaction_token1234",
      "state": "PENDING",
      "response": {
        "code": "0000",
        "memo": "Approved or completed successfully"
      },
      "funding": {
        "amount": 10,
        "source": {
          "type": "programgateway",
          "token": "**********1ab2",
          "active": true,
          "name": "credit_backed_funding_source",
          "is_default_account": false,
          "created_time": "2024-10-14T17:26:35Z",
          "last_modified_time": "2024-10-14T17:26:35Z"
        },
        "gateway_log": {
          "order_number": "my_gateway_token12345",
          "transaction_id": "my_transaction_id1234",
          "message": "Approved or completed successfully",
          "duration": 485,
          "timed_out": false,
          "response": {
            "code": "200",
            "data": {
              "jit_funding": {
                "token": "my_jit_funding_token1234",
                "method": "pgfs.authorization",
                "user_token": "my_user_token",
                "acting_user_token": "my_user_token",
                "amount": 10
              }
            }
          }
        }
      },
      "funding_source_token": "**********1ab2",
      "jit_funding": {
        "token": "my_transaction_id1234",
        "method": "pgfs.authorization",
        "user_token": "my_user_token",
        "acting_user_token": "my_user_token",
        "amount": 10
      },
      "user_token": "my_user_token",
      "currency_code": "USD"
    },
    "duration": 837,
    "created_time": "2024-08-18T22:06:52Z",
    "user_transaction_time": "2024-08-18T22:06:52Z",
    "settlement_date": "2024-08-18T00:00:00Z",
    "request_amount": 10,
    "amount": 10,
    "currency_code": "USD",
    "approval_code": "974406",
    "response": {
      "code": "0000",
      "memo": "Approved or completed successfully"
    },
    "network": "DISCOVER",
    "acquirer_fee_amount": 0,
    "acquirer": {
      "system_trace_audit_number": "376582"
    },
    "user": {
      "metadata": {
        "key1": "value1",
        "key2": "value2",
        "notification_email": "user@domain.com",
        "notification_language": "spa"
      }
    },
    "card": {
      "last_four": "9949",
      "metadata": {}
    },
    "issuer_received_time": "2024-08-18T22:06:52.771Z",
    "issuer_payment_node": "f8205a67b12b90d695b15704a64c074b",
    "network_reference_id": "484311571095",
    "card_acceptor": {
      "mid": "1234",
      "mcc": "6411",
      "name": "Jane's Bakery",
      "street_address": "1989 Fillmore St",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94115",
      "country_code": "USA"
    },
    "pos": {
      "pin_present": false,
      "partial_approval_capable": true,
      "purchase_amount_only": false,
      "is_recurring": false,
      "is_installment": false
    }
  }
}
The following code block shows a sample of a resent creditpaymenttransitions event.
JSON
{
  "token": "my_payment_transition_token1234",
  "account_token": "my_credit_account_token1234",
  "payment_token": "my_credit_account_payment_token1234",
  "status": "COMPLETED",
  "refund_details": null,
  "created_time": "2024-08-17T18:26:47.591Z"
}
The following code block shows a sample of a resent creditdelinquencytransitions event.
JSON
{
  "token": "my_delinquency_transition_token1234",
  "account_token": "my_credit_account_token1234",
  "transition_trigger_reason": "STATEMENT_GENERATION",
  "transition_trigger_time": "2024-03-01 04:59:59.999",
  "original_status": "CURRENT",
  "status": "DELINQUENT",
  "impact_time": "2024-03-01 04:59:59.999",
  "total_past_due": 100,
  "current_due": 40,
  "total_due": 140,
  "oldest_payment_due_date": "2023-02-01 04:59:59.999",
  "bucket_count": 2,
  "is_rolled_back": false,
  "created_time": "2024-03-01 04:59:59.999",
  "updated_time": "2024-03-01 04:59:59.999"
}
The following code block shows a sample of a resent substatus event.
JSON
{
  "token": "substatus_token",
  "resource_type": "ACCOUNT",
  "resource_token": "my_account_token",
  "substatus": "FRAUD",
  "state": "INACTIVE",
  "is_active": false,
  "attributes": [],
  "created_time": "2024-04-02T11:23:23Z",
  "updated_time": "2024-04-02T11:23:23Z",
  "events": [
    {
      "state": "ACTIVE",
      "channel": "SYSTEM",
      "reason": "Fraud system detected suspicious activity",
      "effective_date": "2024-04-02T11:23:23Z",
      "created_time": "2024-04-02T11:23:23Z"
    },
    {
      "state": "INACTIVE",
      "channel": "ADMIN",
      "reason": "Verified non-fraud with cardholder",
      "effective_date": "2024-04-02T11:23:23Z",
      "created_time": "2024-04-02T11:23:23Z"
    }
  ]
}
The following code block shows a sample of a resent accountsignupbonus event.
JSON
{
  "token": "my_accountsignupbonus_token",
  "account_token": "my_account_token",
  "type": "STATEMENT_CREDIT",
  "status": "ISSUED",
  "accrual_start_time": "2024-04-02T11:23:23Z",
  "maturity_time": "2024-04-02T11:23:23Z",
  "spend_total": 10,
  "reward_token": "my_reward_token",
  "journal_entry_token": "my_journal_entry_token"
}

Related topics

Payment SourcesPush-to-Card PaymentsCredit PaymentsAbout Credit Account PaymentsPayment Schedules