GPA Orders

amount

The amount to fund.

Format: 0.00

business_token

The unique identifier of the business.

Pass either a business token or a user token, not both.

Send a GET request to /businesses to retrieve business tokens.

1–36 chars

currency_code

The three-digit ISO 4217 currency code.

A valid three-digit ISO 4217 currency code

fees

List of fees associated with the funding transaction.

Existing fee_model objects

fees[].memo

Additional text that describes the fee transfer.

1–99 chars

fees[].tags

Comma-delimited list of tags describing the fee.

255 char max

fees[].token

The unique identifier of the fee.

1–36 chars

Send a GET request to /fees to retrieve fee tokens.

funding_source_address_token

Identifies the funding source address to use for this order. If your funding source is an ACH account, then a funding source address is not required. If your funding source is a payment card, you must have at least one funding source address in order to create a GPA order. Send a GET request to /fundingsources/addresses/user/{token} to retrieve addresses for a specific user.

1–36 chars

funding_source_token

Identifies the funding source to use for this order.

You don’t have to supply a funding source token value in this call if you have a default funding source set up (verify the funding source’s is_default_account field). If you have only one funding source, then this source is used as the default. If you have multiple funding sources and none are configured as the default, then an error is returned.

Send a GET request to /fundingsources/user/{user_token} to retrieve funding source tokens for a user or to /fundingsources/business/{business_token} to retrieve funding source tokens for a business.

1–36 chars

memo

Additional descriptive text.

1–99 chars

tags

Comma-delimited list of tags describing the order.

1–255 chars

token

The unique identifier of the GPA order.

If you do not include a token, the system will generate one automatically. This token is necessary for use in other calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated.

1–36 chars

user_token

The unique identifier of the user.

Pass either a user token or a business token, not both.

Send a GET request to /users to retrieve business tokens.

1–36 chars

amount

The amount funded.

Format: 0.00

business_token

The unique identifier of the business.

This field is returned if it exists in the resource.

Existing business_token

created_time

The date and time when the GPA order was created, in UTC. 2021-10-26T20:03:05Z, for example.

Format: yyyy-MM-ddTHH:mm:ssZ

currency_code

The three-digit ISO 4217 currency code.

A valid three-digit ISO 4217 currency code

fees

List of fees associated with the funding transaction.

This array is returned if it exists in the resource.

Existing fee_model objects

fees[].fee

A fees object represents a monetary assessment against a user’s general purpose account (GPA).

A valid fees object

fees[].fee.active

Indicates whether the fee is active.

true, false

fees[].fee.amount

The amount of the fee.

Format: 0.00

fees[].fee.created_time

The date and time when the fees object was created, in UTC. 2021-10-26T20:03:05Z, for example.

Format: yyyy-MM-ddTHH:mm:ssZ

fees[].fee.currency_code

The three-digit ISO 4217 currency code.

A valid three-digit ISO 4217 currency code

fees[].fee.last_modified_time

The date and time when the fees object was created, in UTC. 2021-10-26T20:03:05Z, for example.

Format: yyyy-MM-ddTHH:mm:ssZ

fees[].fee.name

The name of the fees object.

50 char max

fees[].fee.real_time_assessment

Controls the assessment of real-time fees.

A valid real_time_fee_assessment object

fees[].fee.real_time_assessment.domestic_enabled

Enables fee assessments where the origin of the transaction acquirer is inside the US.

true, false

fees[].fee.real_time_assessment.international_enabled

Enables fee assessments where the origin of the transaction acquirer is outside the US.

true, false

fees[].fee.real_time_assessment.transaction_type

Indicates the type of transactions on which the fee is assessed.

authorization, pindebit.atm.withdrawal, pindebit

fees[].fee.tags

Descriptive metadata about the fee.

255 char max

fees[].fee.token

The unique identifier of the fee.

36 char max

fees[].memo

Additional text that describes the fee transfer.

1–99 chars

fees[].tags

Comma-delimited list of tags describing the fee.

255 char max

fees[].token

The unique identifier of the fee.

1–36 chars

Send a GET request to /fees to retrieve fee tokens.

fees[].transaction_token

Unique identifier of the transaction.

Format: UUID

funding

Contains funding information for the transaction, including funding amount, type, and time.

A valid funding object

funding.amount

Amount of funds loaded into the GPA.

Format: 0.00

funding.gateway_log

Contains information from the Just-in-Time (JIT) Funding gateway in response to a funding request.

A valid gateway_log object

funding.gateway_log.duration

Length of time the gateway took to respond to a funding request.

Any integer

funding.gateway_log.message

Message about the status of the funding request. Useful for determining whether it was approved and completed successfully, declined by the gateway, or timed out.

Approved or completed successfully, Declined by gateway, Operation timeout

funding.gateway_log.order_number

Customer order number, same value as transaction.token.

Existing transaction.token value

funding.gateway_log.response

Contains information from the gateway in response to a funding request.

A valid gateway_response object

funding.gateway_log.response.code

Code received from the gateway.

funding.gateway_log.response.data

Contains the gateway’s information about the JIT Funding transaction.

A valid jit_funding object

funding.gateway_log.response.data.jit_funding

Contains the information about the JIT Funding load event, where funds are loaded into an account.

Existing jit_funding object

funding.gateway_log.response.data.jit_funding.acting_user_token

User who conducted the transaction.

Can be a child user configured to share its parent’s account balance.

36 char max

Existing user token matching the request.

funding.gateway_log.response.data.jit_funding.address_verification

Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match.

Existing address_verification object

funding.gateway_log.response.data.jit_funding.address_verification.gateway

Contains funding source address verification information.

A valid address_verification_source object

funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file

Contains address verification information.

A valid avs_information object

funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.postal_code

Postal code.

10 char max

funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.street_address

Street address provided by the cardholder.

40 char max

funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.zip

United States ZIP code.

10 char max

funding.gateway_log.response.data.jit_funding.address_verification.gateway.response

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

A valid response object.

funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.additional_information

Information about the relevant velocity control for the transaction, if applicable.

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined. In the example given previously, the velocity control name 500 max spend per day indicates that the cardholder is only authorized to spend 500 dollars per calendar day, and the transaction was declined because it would have brought the cumulative transaction amount to 750 dollars.

funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.code

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

Four digit code

funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.memo

Information on the outcome of the attempted transaction type.

255 char max

funding.gateway_log.response.data.jit_funding.address_verification.issuer

Contains funding source address verification information.

A valid address_verification_source object

funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file

Contains address verification information.

A valid avs_information object

funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.postal_code

Postal code.

10 char max

funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.street_address

Street address provided by the cardholder.

40 char max

funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.zip

United States ZIP code.

10 char max

funding.gateway_log.response.data.jit_funding.address_verification.issuer.response

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

A valid response object.

funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.additional_information

Information about the relevant velocity control for the transaction, if applicable.

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined. In the example given previously, the velocity control name 500 max spend per day indicates that the cardholder is only authorized to spend 500 dollars per calendar day, and the transaction was declined because it would have brought the cumulative transaction amount to 750 dollars.

funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.code

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

Four digit code

funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.memo

Information on the outcome of the attempted transaction type.

255 char max

funding.gateway_log.response.data.jit_funding.address_verification.request

Contains address verification information.

A valid avs_information object

funding.gateway_log.response.data.jit_funding.address_verification.request.postal_code

Postal code.

10 char max

funding.gateway_log.response.data.jit_funding.address_verification.request.street_address

Street address provided by the cardholder.

40 char max

funding.gateway_log.response.data.jit_funding.address_verification.request.zip

United States ZIP code.

10 char max

funding.gateway_log.response.data.jit_funding.amount

Requested amount of funding.

0 min

funding.gateway_log.response.data.jit_funding.balances

Contains the GPA’s balance details.

Existing balances object

funding.gateway_log.response.data.jit_funding.business_token

Holder of the business account that was funded.

36 char max

Existing business_token

funding.gateway_log.response.data.jit_funding.decline_reason

The reason the transaction was declined.

INVALID_AMOUNT, INSUFFICIENT_FUNDS, TRANSACTION_NOT_PERMITTED, SUSPECTED_FRAUD, AMOUNT_LIMIT_EXCEEDED, TRANSACTION_COUNT_LIMIT_EXCEEDED, DUPLICATE_TRANSACTION, INVALID_MERCHANT, INVALID_CARD, NO_CREDIT_ACCOUNT, EXPIRED_CARD, NO_CHECKING_ACCOUNT, NO_SAVINGS_ACCOUNT, STOP_PAYMENT, REVOCATION_AUTHORIZATION_ORDER, REVOCATION_ALL_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, CLOSED_ACCOUNT

funding.gateway_log.response.data.jit_funding.incremental_authorization_jit_funding_tokens

Array of tokens referencing the JIT Funding tokens of all previous associated incremental authorization JIT Funding requests. Useful for ascertaining the final transaction amount when the original amount was incremented.

Existing incremental authorization JIT funding tokens

funding.gateway_log.response.data.jit_funding.memo

Additional information that describes the JIT funding transaction.

99 char max

funding.gateway_log.response.data.jit_funding.method

JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method.

pgfs.authorization, pgfs.balanceinquiry, pgfs.authorization.incremental, pgfs.authorization.capture, pgfs.authorization.reversal, pgfs.auth_plus_capture, pgfs.refund, pgfs.force_capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.directdeposit.credit, pgfs.directdeposit.debit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit.reversal, pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.auth_plus_capture.standin, pgfs.authorization.standin, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.refund.authorization, pgfs.refund.authorization.reversalpgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.authorization.account_verification

funding.gateway_log.response.data.jit_funding.original_jit_funding_token

Token of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages.

36 char max

funding.gateway_log.response.data.jit_funding.tags

Customer-defined tag for the JIT funding transaction.

255 char max

funding.gateway_log.response.data.jit_funding.token

Existing JIT Funding token matching the funding.gateway_log.transaction_id field of the associated general purpose account (GPA) order. Note that the transaction_id field updates if a subsequent JIT Funding message associated with that GPA order is sent. If multiple JIT Funding messages are associated with the same GPA order, the transaction_id field matches the token of the most recent message.

36 char max

funding.gateway_log.response.data.jit_funding.user_token

Holder of the user account that was funded.

36 char max

funding.gateway_log.timed_out

Whether the gateway sent a response (true) or timed out (false).

true, false

funding.gateway_log.transaction_id

Customer-defined identifier for the transaction.

255 char max

funding.source

A program funding source represents a bank account from which funds are drawn for Managed Just-in-Time (JIT) Funding transactions.

A valid funding_source object

funding.source.active

Whether the funding source is active.

true, false

funding.source.created_time

The date and time when the funding source was created, in UTC. 2021-10-26T20:03:05Z, for example.

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source.is_default_account

If there are multiple funding sources, this field specifies which source is used by default in funding calls. If there is only one funding source, the system ignores this field and always uses that source.

true, false

funding.source.last_modified_time

The date and time when the funding source was last modified, in UTC. 2021-10-26T20:03:05Z, for example.

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source.token

The unique identifier of the funding source.

36 char max

funding.source.type

The type of account.

checking, savings

funding.source_address

Contains information about the billing address of the funding source.

A valid funding_source_address object

funding.source_address.active

Whether the address is active.

true, false

funding.source_address.address_1

Street address of the funding source.

255 char max

funding.source_address.address_2

Additional address information for the funding source.

255 char max

funding.source_address.business_token

Unique identifier of the business account holder associated with the address.

1–36 chars

funding.source_address.city

City of the funding source.

40 char max

funding.source_address.country

Country of the funding source.

1–40 chars

funding.source_address.created_time

Date and time when the address was created.

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source_address.first_name

First name of the account holder associated with the funding source.

40 char max

funding.source_address.is_default_address

Whether this address is the default address used by the funding source.

true, false

funding.source_address.last_modified_time

Date and time when the address was last modified.

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source_address.last_name

Last name of the account holder associated with the funding source.

40 char max

funding.source_address.phone

Phone number of the funding source.

255 char max

funding.source_address.postal_code

Postal code of the funding source.

10 char max

funding.source_address.state

State of the funding source.

2 char max

funding.source_address.token

Unique identifier of the funding_source_address object.

1–36 chars

funding.source_address.user_token

Unique identifier of the user account holder associated with the address.

1–36 chars

funding.source_address.zip

United States ZIP code of the funding source.

10 char max

funding_source_address_token

Identifies the funding source address to use for this order.

Existing funding_source_address token

funding_source_token

Identifies the funding source to use for this order.

Existing funding_source token

gateway_message

Message about the status of the funding request. Useful for determining whether it was approved and completed successfully, declined by the gateway, or timed out.

This field is returned if it exists in the resource.

Approved or completed successfully, Declined by gateway, Operation timeout

gateway_token

Unique identifier of the JIT Funding request and response.

This field is returned if it exists in the resource.

Existing gateway_token

jit_funding

Contains the information about the JIT Funding load event, where funds are loaded into an account.

Existing jit_funding object

jit_funding.acting_user_token

User who conducted the transaction.

Can be a child user configured to share its parent’s account balance.

36 char max

Existing user token matching the request.

jit_funding.address_verification

Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match.

Existing address_verification object

jit_funding.address_verification.gateway

Contains funding source address verification information.

A valid address_verification_source object

jit_funding.address_verification.gateway.on_file

Contains address verification information.

A valid avs_information object

jit_funding.address_verification.gateway.on_file.postal_code

Postal code.

10 char max

jit_funding.address_verification.gateway.on_file.street_address

Street address provided by the cardholder.

40 char max

jit_funding.address_verification.gateway.on_file.zip

United States ZIP code.

10 char max

jit_funding.address_verification.gateway.response

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

A valid response object.

jit_funding.address_verification.gateway.response.additional_information

Information about the relevant velocity control for the transaction, if applicable.

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined. In the example given previously, the velocity control name 500 max spend per day indicates that the cardholder is only authorized to spend 500 dollars per calendar day, and the transaction was declined because it would have brought the cumulative transaction amount to 750 dollars.

jit_funding.address_verification.gateway.response.code

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

Four digit code

jit_funding.address_verification.gateway.response.memo

Information on the outcome of the attempted transaction type.

255 char max

jit_funding.address_verification.issuer

Contains funding source address verification information.

A valid address_verification_source object

jit_funding.address_verification.issuer.on_file

Contains address verification information.

A valid avs_information object

jit_funding.address_verification.issuer.on_file.postal_code

Postal code.

10 char max

jit_funding.address_verification.issuer.on_file.street_address

Street address provided by the cardholder.

40 char max

jit_funding.address_verification.issuer.on_file.zip

United States ZIP code.

10 char max

jit_funding.address_verification.issuer.response

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

A valid response object.

jit_funding.address_verification.issuer.response.additional_information

Information about the relevant velocity control for the transaction, if applicable.

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined. In the example given previously, the velocity control name 500 max spend per day indicates that the cardholder is only authorized to spend 500 dollars per calendar day, and the transaction was declined because it would have brought the cumulative transaction amount to 750 dollars.

jit_funding.address_verification.issuer.response.code

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

Four digit code

jit_funding.address_verification.issuer.response.memo

Information on the outcome of the attempted transaction type.

255 char max

jit_funding.address_verification.request

Contains address verification information.

A valid avs_information object

jit_funding.address_verification.request.postal_code

Postal code.

10 char max

jit_funding.address_verification.request.street_address

Street address provided by the cardholder.

40 char max

jit_funding.address_verification.request.zip

United States ZIP code.

10 char max

jit_funding.amount

Requested amount of funding.

0 min

jit_funding.balances

Contains the GPA’s balance details.

Existing balances object

jit_funding.business_token

Holder of the business account that was funded.

36 char max

Existing business_token

jit_funding.decline_reason

The reason the transaction was declined.

INVALID_AMOUNT, INSUFFICIENT_FUNDS, TRANSACTION_NOT_PERMITTED, SUSPECTED_FRAUD, AMOUNT_LIMIT_EXCEEDED, TRANSACTION_COUNT_LIMIT_EXCEEDED, DUPLICATE_TRANSACTION, INVALID_MERCHANT, INVALID_CARD, NO_CREDIT_ACCOUNT, EXPIRED_CARD, NO_CHECKING_ACCOUNT, NO_SAVINGS_ACCOUNT, STOP_PAYMENT, REVOCATION_AUTHORIZATION_ORDER, REVOCATION_ALL_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, CLOSED_ACCOUNT

jit_funding.incremental_authorization_jit_funding_tokens

Array of tokens referencing the JIT Funding tokens of all previous associated incremental authorization JIT Funding requests. Useful for ascertaining the final transaction amount when the original amount was incremented.

Existing incremental authorization JIT funding tokens

jit_funding.memo

Additional information that describes the JIT funding transaction.

99 char max

jit_funding.method

JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method.

pgfs.authorization, pgfs.balanceinquiry, pgfs.authorization.incremental, pgfs.authorization.capture, pgfs.authorization.reversal, pgfs.auth_plus_capture, pgfs.refund, pgfs.force_capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.directdeposit.credit, pgfs.directdeposit.debit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit.reversal, pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.auth_plus_capture.standin, pgfs.authorization.standin, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.refund.authorization, pgfs.refund.authorization.reversalpgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.authorization.account_verification

jit_funding.original_jit_funding_token

Token of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages.

36 char max

jit_funding.tags

Customer-defined tag for the JIT funding transaction.

255 char max

jit_funding.token

Existing JIT Funding token matching the funding.gateway_log.transaction_id field of the associated general purpose account (GPA) order. Note that the transaction_id field updates if a subsequent JIT Funding message associated with that GPA order is sent. If multiple JIT Funding messages are associated with the same GPA order, the transaction_id field matches the token of the most recent message.

36 char max

jit_funding.user_token

Holder of the user account that was funded.

36 char max

last_modified_time

The date and time when the GPA order was last modified, in UTC. 2021-10-26T20:03:05Z, for example.

Format: yyyy-MM-ddTHH:mm:ssZ

memo

Additional descriptive text.

This field is returned if it exists in the resource.

99 char max

response

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

A valid response object.

response.additional_information

Information about the relevant velocity control for the transaction, if applicable.

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined. In the example given previously, the velocity control name 500 max spend per day indicates that the cardholder is only authorized to spend 500 dollars per calendar day, and the transaction was declined because it would have brought the cumulative transaction amount to 750 dollars.

response.code

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

Four digit code

response.memo

Information on the outcome of the attempted transaction type.

255 char max

state

Current status of the funding transaction.

PENDING, CLEARED, COMPLETION, DECLINED, ERROR, ALL

tags

Comma-delimited list of tags describing the order.

This field is returned if it exists in the resource.

255 char max

token

The unique identifier of the GPA order.

36 char max

transaction_token

Unique identifier of the transaction being funded.

Format: UUID

user_token

The unique identifier of the user.

This field is returned if it exists in the resource.

Existing user token

token

Existing GPA order token.

Send a GET request to /transactions?type=gpa.credit to retrieve GPA order tokens.

amount

The amount funded.

Format: 0.00

business_token

The unique identifier of the business.

This field is returned if it exists in the resource.

Existing business_token

created_time

The date and time when the GPA order was created, in UTC. 2021-10-26T20:03:05Z, for example.

Format: yyyy-MM-ddTHH:mm:ssZ

currency_code

The three-digit ISO 4217 currency code.

A valid three-digit ISO 4217 currency code

fees

List of fees associated with the funding transaction.

This array is returned if it exists in the resource.

Existing fee_model objects

fees[].fee

A fees object represents a monetary assessment against a user’s general purpose account (GPA).

A valid fees object

fees[].fee.active

Indicates whether the fee is active.

true, false

fees[].fee.amount

The amount of the fee.

Format: 0.00

fees[].fee.created_time

The date and time when the fees object was created, in UTC. 2021-10-26T20:03:05Z, for example.

Format: yyyy-MM-ddTHH:mm:ssZ

fees[].fee.currency_code

The three-digit ISO 4217 currency code.

A valid three-digit ISO 4217 currency code

fees[].fee.last_modified_time

The date and time when the fees object was created, in UTC. 2021-10-26T20:03:05Z, for example.

Format: yyyy-MM-ddTHH:mm:ssZ

fees[].fee.name

The name of the fees object.

50 char max

fees[].fee.real_time_assessment

Controls the assessment of real-time fees.

A valid real_time_fee_assessment object

fees[].fee.real_time_assessment.domestic_enabled

Enables fee assessments where the origin of the transaction acquirer is inside the US.

true, false

fees[].fee.real_time_assessment.international_enabled

Enables fee assessments where the origin of the transaction acquirer is outside the US.

true, false

fees[].fee.real_time_assessment.transaction_type

Indicates the type of transactions on which the fee is assessed.

authorization, pindebit.atm.withdrawal, pindebit

fees[].fee.tags

Descriptive metadata about the fee.

255 char max

fees[].fee.token

The unique identifier of the fee.

36 char max

fees[].memo

Additional text that describes the fee transfer.

1–99 chars

fees[].tags

Comma-delimited list of tags describing the fee.

255 char max

fees[].token

The unique identifier of the fee.

1–36 chars

Send a GET request to /fees to retrieve fee tokens.

fees[].transaction_token

Unique identifier of the transaction.

Format: UUID

funding

Contains funding information for the transaction, including funding amount, type, and time.

A valid funding object

funding.amount

Amount of funds loaded into the GPA.

Format: 0.00

funding.gateway_log

Contains information from the Just-in-Time (JIT) Funding gateway in response to a funding request.

A valid gateway_log object

funding.gateway_log.duration

Length of time the gateway took to respond to a funding request.

Any integer

funding.gateway_log.message

Message about the status of the funding request. Useful for determining whether it was approved and completed successfully, declined by the gateway, or timed out.

Approved or completed successfully, Declined by gateway, Operation timeout

funding.gateway_log.order_number

Customer order number, same value as transaction.token.

Existing transaction.token value

funding.gateway_log.response

Contains information from the gateway in response to a funding request.

A valid gateway_response object

funding.gateway_log.response.code

Code received from the gateway.

funding.gateway_log.response.data

Contains the gateway’s information about the JIT Funding transaction.

A valid jit_funding object

funding.gateway_log.response.data.jit_funding

Contains the information about the JIT Funding load event, where funds are loaded into an account.

Existing jit_funding object

funding.gateway_log.response.data.jit_funding.acting_user_token

User who conducted the transaction.

Can be a child user configured to share its parent’s account balance.

36 char max

Existing user token matching the request.

funding.gateway_log.response.data.jit_funding.address_verification

Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match.

Existing address_verification object

funding.gateway_log.response.data.jit_funding.address_verification.gateway

Contains funding source address verification information.

A valid address_verification_source object

funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file

Contains address verification information.

A valid avs_information object

funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.postal_code

Postal code.

10 char max

funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.street_address

Street address provided by the cardholder.

40 char max

funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.zip

United States ZIP code.

10 char max

funding.gateway_log.response.data.jit_funding.address_verification.gateway.response

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

A valid response object.

funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.additional_information

Information about the relevant velocity control for the transaction, if applicable.

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined. In the example given previously, the velocity control name 500 max spend per day indicates that the cardholder is only authorized to spend 500 dollars per calendar day, and the transaction was declined because it would have brought the cumulative transaction amount to 750 dollars.

funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.code

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

Four digit code

funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.memo

Information on the outcome of the attempted transaction type.

255 char max

funding.gateway_log.response.data.jit_funding.address_verification.issuer

Contains funding source address verification information.

A valid address_verification_source object

funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file

Contains address verification information.

A valid avs_information object

funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.postal_code

Postal code.

10 char max

funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.street_address

Street address provided by the cardholder.

40 char max

funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.zip

United States ZIP code.

10 char max

funding.gateway_log.response.data.jit_funding.address_verification.issuer.response

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

A valid response object.

funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.additional_information

Information about the relevant velocity control for the transaction, if applicable.

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined. In the example given previously, the velocity control name 500 max spend per day indicates that the cardholder is only authorized to spend 500 dollars per calendar day, and the transaction was declined because it would have brought the cumulative transaction amount to 750 dollars.

funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.code

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

Four digit code

funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.memo

Information on the outcome of the attempted transaction type.

255 char max

funding.gateway_log.response.data.jit_funding.address_verification.request

Contains address verification information.

A valid avs_information object

funding.gateway_log.response.data.jit_funding.address_verification.request.postal_code

Postal code.

10 char max

funding.gateway_log.response.data.jit_funding.address_verification.request.street_address

Street address provided by the cardholder.

40 char max

funding.gateway_log.response.data.jit_funding.address_verification.request.zip

United States ZIP code.

10 char max

funding.gateway_log.response.data.jit_funding.amount

Requested amount of funding.

0 min

funding.gateway_log.response.data.jit_funding.balances

Contains the GPA’s balance details.

Existing balances object

funding.gateway_log.response.data.jit_funding.business_token

Holder of the business account that was funded.

36 char max

Existing business_token

funding.gateway_log.response.data.jit_funding.decline_reason

The reason the transaction was declined.

INVALID_AMOUNT, INSUFFICIENT_FUNDS, TRANSACTION_NOT_PERMITTED, SUSPECTED_FRAUD, AMOUNT_LIMIT_EXCEEDED, TRANSACTION_COUNT_LIMIT_EXCEEDED, DUPLICATE_TRANSACTION, INVALID_MERCHANT, INVALID_CARD, NO_CREDIT_ACCOUNT, EXPIRED_CARD, NO_CHECKING_ACCOUNT, NO_SAVINGS_ACCOUNT, STOP_PAYMENT, REVOCATION_AUTHORIZATION_ORDER, REVOCATION_ALL_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, CLOSED_ACCOUNT

funding.gateway_log.response.data.jit_funding.incremental_authorization_jit_funding_tokens

Array of tokens referencing the JIT Funding tokens of all previous associated incremental authorization JIT Funding requests. Useful for ascertaining the final transaction amount when the original amount was incremented.

Existing incremental authorization JIT funding tokens

funding.gateway_log.response.data.jit_funding.memo

Additional information that describes the JIT funding transaction.

99 char max

funding.gateway_log.response.data.jit_funding.method

JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method.

pgfs.authorization, pgfs.balanceinquiry, pgfs.authorization.incremental, pgfs.authorization.capture, pgfs.authorization.reversal, pgfs.auth_plus_capture, pgfs.refund, pgfs.force_capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.directdeposit.credit, pgfs.directdeposit.debit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit.reversal, pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.auth_plus_capture.standin, pgfs.authorization.standin, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.refund.authorization, pgfs.refund.authorization.reversalpgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.authorization.account_verification

funding.gateway_log.response.data.jit_funding.original_jit_funding_token

Token of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages.

36 char max

funding.gateway_log.response.data.jit_funding.tags

Customer-defined tag for the JIT funding transaction.

255 char max

funding.gateway_log.response.data.jit_funding.token

Existing JIT Funding token matching the funding.gateway_log.transaction_id field of the associated general purpose account (GPA) order. Note that the transaction_id field updates if a subsequent JIT Funding message associated with that GPA order is sent. If multiple JIT Funding messages are associated with the same GPA order, the transaction_id field matches the token of the most recent message.

36 char max

funding.gateway_log.response.data.jit_funding.user_token

Holder of the user account that was funded.

36 char max

funding.gateway_log.timed_out

Whether the gateway sent a response (true) or timed out (false).

true, false

funding.gateway_log.transaction_id

Customer-defined identifier for the transaction.

255 char max

funding.source

A program funding source represents a bank account from which funds are drawn for Managed Just-in-Time (JIT) Funding transactions.

A valid funding_source object

funding.source.active

Whether the funding source is active.

true, false

funding.source.created_time

The date and time when the funding source was created, in UTC. 2021-10-26T20:03:05Z, for example.

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source.is_default_account

If there are multiple funding sources, this field specifies which source is used by default in funding calls. If there is only one funding source, the system ignores this field and always uses that source.

true, false

funding.source.last_modified_time

The date and time when the funding source was last modified, in UTC. 2021-10-26T20:03:05Z, for example.

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source.token

The unique identifier of the funding source.

36 char max

funding.source.type

The type of account.

checking, savings

funding.source_address

Contains information about the billing address of the funding source.

A valid funding_source_address object

funding.source_address.active

Whether the address is active.

true, false

funding.source_address.address_1

Street address of the funding source.

255 char max

funding.source_address.address_2

Additional address information for the funding source.

255 char max

funding.source_address.business_token

Unique identifier of the business account holder associated with the address.

1–36 chars

funding.source_address.city

City of the funding source.

40 char max

funding.source_address.country

Country of the funding source.

1–40 chars

funding.source_address.created_time

Date and time when the address was created.

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source_address.first_name

First name of the account holder associated with the funding source.

40 char max

funding.source_address.is_default_address

Whether this address is the default address used by the funding source.

true, false

funding.source_address.last_modified_time

Date and time when the address was last modified.

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source_address.last_name

Last name of the account holder associated with the funding source.

40 char max

funding.source_address.phone

Phone number of the funding source.

255 char max

funding.source_address.postal_code

Postal code of the funding source.

10 char max

funding.source_address.state

State of the funding source.

2 char max

funding.source_address.token

Unique identifier of the funding_source_address object.

1–36 chars

funding.source_address.user_token

Unique identifier of the user account holder associated with the address.

1–36 chars

funding.source_address.zip

United States ZIP code of the funding source.

10 char max

funding_source_address_token

Identifies the funding source address to use for this order.

Existing funding_source_address token

funding_source_token

Identifies the funding source to use for this order.

Existing funding_source token

gateway_message

Message about the status of the funding request. Useful for determining whether it was approved and completed successfully, declined by the gateway, or timed out.

This field is returned if it exists in the resource.

Approved or completed successfully, Declined by gateway, Operation timeout

gateway_token

Unique identifier of the JIT Funding request and response.

This field is returned if it exists in the resource.

Existing gateway_token

jit_funding

Contains the information about the JIT Funding load event, where funds are loaded into an account.

Existing jit_funding object

jit_funding.acting_user_token

User who conducted the transaction.

Can be a child user configured to share its parent’s account balance.

36 char max

Existing user token matching the request.

jit_funding.address_verification

Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match.

Existing address_verification object

jit_funding.address_verification.gateway

Contains funding source address verification information.

A valid address_verification_source object

jit_funding.address_verification.gateway.on_file

Contains address verification information.

A valid avs_information object

jit_funding.address_verification.gateway.on_file.postal_code

Postal code.

10 char max

jit_funding.address_verification.gateway.on_file.street_address

Street address provided by the cardholder.

40 char max

jit_funding.address_verification.gateway.on_file.zip

United States ZIP code.

10 char max

jit_funding.address_verification.gateway.response

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

A valid response object.

jit_funding.address_verification.gateway.response.additional_information

Information about the relevant velocity control for the transaction, if applicable.

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined. In the example given previously, the velocity control name 500 max spend per day indicates that the cardholder is only authorized to spend 500 dollars per calendar day, and the transaction was declined because it would have brought the cumulative transaction amount to 750 dollars.

jit_funding.address_verification.gateway.response.code

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

Four digit code

jit_funding.address_verification.gateway.response.memo

Information on the outcome of the attempted transaction type.

255 char max

jit_funding.address_verification.issuer

Contains funding source address verification information.

A valid address_verification_source object

jit_funding.address_verification.issuer.on_file

Contains address verification information.

A valid avs_information object

jit_funding.address_verification.issuer.on_file.postal_code

Postal code.

10 char max

jit_funding.address_verification.issuer.on_file.street_address

Street address provided by the cardholder.

40 char max

jit_funding.address_verification.issuer.on_file.zip

United States ZIP code.

10 char max

jit_funding.address_verification.issuer.response

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

A valid response object.

jit_funding.address_verification.issuer.response.additional_information

Information about the relevant velocity control for the transaction, if applicable.

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined. In the example given previously, the velocity control name 500 max spend per day indicates that the cardholder is only authorized to spend 500 dollars per calendar day, and the transaction was declined because it would have brought the cumulative transaction amount to 750 dollars.

jit_funding.address_verification.issuer.response.code

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

Four digit code

jit_funding.address_verification.issuer.response.memo

Information on the outcome of the attempted transaction type.

255 char max

jit_funding.address_verification.request

Contains address verification information.

A valid avs_information object

jit_funding.address_verification.request.postal_code

Postal code.

10 char max

jit_funding.address_verification.request.street_address

Street address provided by the cardholder.

40 char max

jit_funding.address_verification.request.zip

United States ZIP code.

10 char max

jit_funding.amount

Requested amount of funding.

0 min

jit_funding.balances

Contains the GPA’s balance details.

Existing balances object

jit_funding.business_token

Holder of the business account that was funded.

36 char max

Existing business_token

jit_funding.decline_reason

The reason the transaction was declined.

INVALID_AMOUNT, INSUFFICIENT_FUNDS, TRANSACTION_NOT_PERMITTED, SUSPECTED_FRAUD, AMOUNT_LIMIT_EXCEEDED, TRANSACTION_COUNT_LIMIT_EXCEEDED, DUPLICATE_TRANSACTION, INVALID_MERCHANT, INVALID_CARD, NO_CREDIT_ACCOUNT, EXPIRED_CARD, NO_CHECKING_ACCOUNT, NO_SAVINGS_ACCOUNT, STOP_PAYMENT, REVOCATION_AUTHORIZATION_ORDER, REVOCATION_ALL_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, CLOSED_ACCOUNT

jit_funding.incremental_authorization_jit_funding_tokens

Array of tokens referencing the JIT Funding tokens of all previous associated incremental authorization JIT Funding requests. Useful for ascertaining the final transaction amount when the original amount was incremented.

Existing incremental authorization JIT funding tokens

jit_funding.memo

Additional information that describes the JIT funding transaction.

99 char max

jit_funding.method

JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method.

pgfs.authorization, pgfs.balanceinquiry, pgfs.authorization.incremental, pgfs.authorization.capture, pgfs.authorization.reversal, pgfs.auth_plus_capture, pgfs.refund, pgfs.force_capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.directdeposit.credit, pgfs.directdeposit.debit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit.reversal, pgfs.adjustment.credit, pgfs.adjustment.debit, pgfs.auth_plus_capture.standin, pgfs.authorization.standin, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.refund.authorization, pgfs.refund.authorization.reversalpgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.authorization.account_verification

jit_funding.original_jit_funding_token

Token of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages.

36 char max

jit_funding.tags

Customer-defined tag for the JIT funding transaction.

255 char max

jit_funding.token

Existing JIT Funding token matching the funding.gateway_log.transaction_id field of the associated general purpose account (GPA) order. Note that the transaction_id field updates if a subsequent JIT Funding message associated with that GPA order is sent. If multiple JIT Funding messages are associated with the same GPA order, the transaction_id field matches the token of the most recent message.

36 char max

jit_funding.user_token

Holder of the user account that was funded.

36 char max

last_modified_time

The date and time when the GPA order was last modified, in UTC. 2021-10-26T20:03:05Z, for example.

Format: yyyy-MM-ddTHH:mm:ssZ

memo

Additional descriptive text.

This field is returned if it exists in the resource.

99 char max

response

Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder.

A valid response object.

response.additional_information

Information about the relevant velocity control for the transaction, if applicable.

The additional_information field returns a string in the following format: <Velocity control name>, cumulative transaction amount is <X>, where X is the cumulative transaction amount value calculated by Marqeta. For example: 500 max spend per day, cumulative transaction amount is 750.

Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined. In the example given previously, the velocity control name 500 max spend per day indicates that the cardholder is only authorized to spend 500 dollars per calendar day, and the transaction was declined because it would have brought the cumulative transaction amount to 750 dollars.

response.code

Four-digit code corresponding with the outcome of the attempted transaction type.

card_security_code_verification.response.code indicates whether the verification check passed and can have these possible values:

Four digit code

response.memo

Information on the outcome of the attempted transaction type.

255 char max

state

Current status of the funding transaction.

PENDING, CLEARED, COMPLETION, DECLINED, ERROR, ALL

tags

Comma-delimited list of tags describing the order.

This field is returned if it exists in the resource.

255 char max

token

The unique identifier of the GPA order.

36 char max

transaction_token

Unique identifier of the transaction being funded.

Format: UUID

user_token

The unique identifier of the user.

This field is returned if it exists in the resource.

Existing user token

amount

The amount of funds to unload (i.e., to return to the funding source).

Format: 0.00

funding_source_address_token

Identifies the funding source to use for this GPA unload order.

Send a GET request to /fundingsources/addresses/user/{token} to retrieve addresses for a specific user.

1–36 chars

memo

Additional descriptive text about the GPA unload.

99 char max

original_order_token

Identifies the original GPA order.

1–36 chars

tags

Comma-delimited list of tags describing the GPA unload order.

255 char max

token

The unique identifier of the GPA unload order.

If you do not include a token, the system will generate one automatically. This token is necessary for use in other calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated.

1–36 chars

amount

The amount of funds unloaded (returned to funding source).

Format: 0.00

created_time

Date and time when the GPA unload order was created, in UTC.

Format: yyyy-MM-ddTHH:mm:ssZ