/
125 minute read
March 24, 2022

GPA Orders

Hidden

The /gpaorders endpoint moves funds from a funding source into an account holder’s general-purpose account (GPA).

GPA orders can also be used to move funds from an account holder’s funding source into your program’s fee account.

GPA orders can be funded by the account holder or your program.

Create GPA order

Action: POST
Endpoint: /gpaorders

Use this endpoint to create an order to fund an account holder’s GPA.

You can assess a fee while funding a GPA by using the optional fees array to attach one or more fee resources to the GPA order. When you create a GPA order, the GPA is first credited for the fees, then debited at funding time.

Request body
Fields Description

amount

decimal
Required

The amount to fund.

Allowable Values:

Format: 0.00

business_token

string
Optional

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.

Allowable Values:

1–36 chars

currency_code

string
Required

The three-digit ISO 4217 currency code.

Allowable Values:

A valid three-digit ISO 4217 currency code

fees

array of objects
Optional

List of fees associated with the funding transaction.

Allowable Values:

Existing fee_model objects

fees[].memo

string
Optional

Additional text that describes the fee transfer.

Allowable Values:

1–99 chars

fees[].tags

string
Optional

Comma-delimited list of tags describing the fee.

Allowable Values:

255 char max

fees[].token

string
Required

The unique identifier of the fee.

Allowable Values:

1–36 chars

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

funding_source_address_token

string
Optional

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.

Allowable Values:

1–36 chars

funding_source_token

string
Required

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.

Allowable Values:

1–36 chars

memo

string
Optional

Additional descriptive text.

Allowable Values:

1–99 chars

tags

string
Optional

Comma-delimited list of tags describing the order.

Allowable Values:

1–255 chars

token

string
Optional

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.

Allowable Values:

1–36 chars

user_token

string
Optional

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.

Allowable Values:

1–36 chars

Sample request body
JSON
Copied

Is this helpful?

Yes
No
Response body
Fields Description

amount

decimal
Returned

The amount funded.

Allowable Values:

Format: 0.00

business_token

string
Conditionally returned

The unique identifier of the business.

This field is returned if it exists in the resource.

Allowable Values:

Existing business_token

created_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

currency_code

string
Returned

The three-digit ISO 4217 currency code.

Allowable Values:

A valid three-digit ISO 4217 currency code

fees

array of objects
Conditionally returned

List of fees associated with the funding transaction.

This array is returned if it exists in the resource.

Allowable Values:

Existing fee_model objects

fees[].fee

object
Returned

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

Allowable Values:

A valid fees object

fees[].fee.active

boolean
Returned

Indicates whether the fee is active.

Allowable Values:

true, false

fees[].fee.amount

decimal
Returned

The amount of the fee.

Allowable Values:

Format: 0.00

fees[].fee.created_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

fees[].fee.currency_code

string
Returned

The three-digit ISO 4217 currency code.

Allowable Values:

A valid three-digit ISO 4217 currency code

fees[].fee.last_modified_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

fees[].fee.name

string
Returned

The name of the fees object.

Allowable Values:

50 char max

fees[].fee.real_time_assessment

object
Conditionally returned

Controls the assessment of real-time fees.

Allowable Values:

A valid real_time_fee_assessment object

fees[].fee.real_time_assessment.domestic_enabled

boolean
Conditionally returned

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

Allowable Values:

true, false

fees[].fee.real_time_assessment.international_enabled

boolean
Conditionally returned

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

Allowable Values:

true, false

fees[].fee.real_time_assessment.transaction_type

string
Conditionally returned

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

Allowable Values:

authorization, pindebit.atm.withdrawal, pindebit

fees[].fee.tags

string
Conditionally returned

Descriptive metadata about the fee.

Allowable Values:

255 char max

fees[].fee.token

string
Returned

The unique identifier of the fee.

Allowable Values:

36 char max

fees[].memo

string
Conditionally returned

Additional text that describes the fee transfer.

Allowable Values:

1–99 chars

fees[].tags

string
Conditionally returned

Comma-delimited list of tags describing the fee.

Allowable Values:

255 char max

fees[].token

string
Returned

The unique identifier of the fee.

Allowable Values:

1–36 chars

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

fees[].transaction_token

string
Returned

Unique identifier of the transaction.

Allowable Values:

Format: UUID

funding

object
Returned

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

Allowable Values:

A valid funding object

funding.amount

decimal
Conditionally returned

Amount of funds loaded into the GPA.

Allowable Values:

Format: 0.00

funding.gateway_log

object
Conditionally returned

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

Allowable Values:

A valid gateway_log object

funding.gateway_log.duration

integer
Conditionally returned

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

Allowable Values:

Any integer

funding.gateway_log.message

string
Returned

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.

Allowable Values:

Approved or completed successfully, Declined by gateway, Operation timeout

funding.gateway_log.order_number

string
Returned

Customer order number, same value as transaction.token.

Allowable Values:

Existing transaction.token value

funding.gateway_log.response

object
Conditionally returned

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

Allowable Values:

A valid gateway_response object

funding.gateway_log.response.code

string
Returned

Code received from the gateway.

Allowable Values:

funding.gateway_log.response.data

object
Conditionally returned

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

Allowable Values:

A valid jit_funding object

funding.gateway_log.response.data.jit_funding

object
Returned

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

Allowable Values:

Existing jit_funding object

funding.gateway_log.response.data.jit_funding.acting_user_token

string
Conditionally returned

User who conducted the transaction.

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

Allowable Values:

36 char max

Existing user token matching the request.

funding.gateway_log.response.data.jit_funding.address_verification

object
Conditionally returned

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.

Allowable Values:

Existing address_verification object

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

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

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

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

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

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

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

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

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

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

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

object
Conditionally returned

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

Allowable Values:

A valid response object.

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

string
Conditionally returned

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

Allowable Values:

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

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

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

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

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

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

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

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

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

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

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

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

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

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

object
Conditionally returned

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

Allowable Values:

A valid response object.

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

string
Conditionally returned

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

Allowable Values:

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

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

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

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

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

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

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

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

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

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

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

funding.gateway_log.response.data.jit_funding.amount

decimal
Returned

Requested amount of funding.

Allowable Values:

0 min

funding.gateway_log.response.data.jit_funding.balances

object
Conditionally returned

Contains the GPA’s balance details.

Allowable Values:

Existing balances object

funding.gateway_log.response.data.jit_funding.business_token

string
Conditionally returned

Holder of the business account that was funded.

Allowable Values:

36 char max

Existing business_token

funding.gateway_log.response.data.jit_funding.decline_reason

string
Conditionally returned

The reason the transaction was declined.

Allowable Values:

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 strings
Conditionally returned

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.

Allowable Values:

Existing incremental authorization JIT funding tokens

funding.gateway_log.response.data.jit_funding.memo

string
Conditionally returned

Additional information that describes the JIT funding transaction.

Allowable Values:

99 char max

funding.gateway_log.response.data.jit_funding.method

string
Returned

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

Allowable Values:

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

string
Conditionally returned

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.

Allowable Values:

36 char max

funding.gateway_log.response.data.jit_funding.tags

string
Conditionally returned

Customer-defined tag for the JIT funding transaction.

Allowable Values:

255 char max

funding.gateway_log.response.data.jit_funding.token

string
Returned

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.

Allowable Values:

36 char max

funding.gateway_log.response.data.jit_funding.user_token

string
Returned

Holder of the user account that was funded.

Allowable Values:

36 char max

funding.gateway_log.timed_out

boolean
Conditionally returned

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

Allowable Values:

true, false

funding.gateway_log.transaction_id

string
Returned

Customer-defined identifier for the transaction.

Allowable Values:

255 char max

funding.source

object
Returned

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

Allowable Values:

A valid funding_source object

funding.source.active

boolean
Returned

Whether the funding source is active.

Allowable Values:

true, false

funding.source.created_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source.is_default_account

boolean
Returned

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.

Allowable Values:

true, false

funding.source.last_modified_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source.token

string
Returned

The unique identifier of the funding source.

Allowable Values:

36 char max

funding.source.type

string
Returned

The type of account.

Allowable Values:

checking, savings

funding.source_address

object
Conditionally returned

Contains information about the billing address of the funding source.

Allowable Values:

A valid funding_source_address object

funding.source_address.active

boolean
Conditionally returned

Whether the address is active.

Allowable Values:

true, false

funding.source_address.address_1

string
Returned

Street address of the funding source.

Allowable Values:

255 char max

funding.source_address.address_2

string
Conditionally returned

Additional address information for the funding source.

Allowable Values:

255 char max

funding.source_address.business_token

string
Conditionally returned

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

Allowable Values:

1–36 chars

funding.source_address.city

string
Returned

City of the funding source.

Allowable Values:

40 char max

funding.source_address.country

string
Returned

Country of the funding source.

Allowable Values:

1–40 chars

funding.source_address.created_time

datetime
Returned

Date and time when the address was created.

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source_address.first_name

string
Returned

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

Allowable Values:

40 char max

funding.source_address.is_default_address

boolean
Conditionally returned

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

Allowable Values:

true, false

funding.source_address.last_modified_time

datetime
Returned

Date and time when the address was last modified.

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source_address.last_name

string
Returned

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

Allowable Values:

40 char max

funding.source_address.phone

string
Conditionally returned

Phone number of the funding source.

Allowable Values:

255 char max

funding.source_address.postal_code

string
Returned

Postal code of the funding source.

Allowable Values:

10 char max

funding.source_address.state

string
Returned

State of the funding source.

Allowable Values:

2 char max

funding.source_address.token

string
Returned

Unique identifier of the funding_source_address object.

Allowable Values:

1–36 chars

funding.source_address.user_token

string
Conditionally returned

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

Allowable Values:

1–36 chars

funding.source_address.zip

string
Returned

United States ZIP code of the funding source.

Allowable Values:

10 char max

funding_source_address_token

string
Conditionally returned

Identifies the funding source address to use for this order.

Allowable Values:

Existing funding_source_address token

funding_source_token

string
Returned

Identifies the funding source to use for this order.

Allowable Values:

Existing funding_source token

gateway_message

string
Conditionally returned

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.

Allowable Values:

Approved or completed successfully, Declined by gateway, Operation timeout

gateway_token

integer
Conditionally returned

Unique identifier of the JIT Funding request and response.

This field is returned if it exists in the resource.

Allowable Values:

Existing gateway_token

jit_funding

object
Conditionally returned

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

Allowable Values:

Existing jit_funding object

jit_funding.acting_user_token

string
Conditionally returned

User who conducted the transaction.

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

Allowable Values:

36 char max

Existing user token matching the request.

jit_funding.address_verification

object
Conditionally returned

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.

Allowable Values:

Existing address_verification object

jit_funding.address_verification.gateway

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

jit_funding.address_verification.gateway.on_file

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

jit_funding.address_verification.gateway.on_file.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

jit_funding.address_verification.gateway.on_file.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

jit_funding.address_verification.gateway.on_file.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

jit_funding.address_verification.gateway.response

object
Conditionally returned

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

Allowable Values:

A valid response object.

jit_funding.address_verification.gateway.response.additional_information

string
Conditionally returned

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

Allowable Values:

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

jit_funding.address_verification.gateway.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

jit_funding.address_verification.issuer

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

jit_funding.address_verification.issuer.on_file

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

jit_funding.address_verification.issuer.on_file.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

jit_funding.address_verification.issuer.on_file.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

jit_funding.address_verification.issuer.on_file.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

jit_funding.address_verification.issuer.response

object
Conditionally returned

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

Allowable Values:

A valid response object.

jit_funding.address_verification.issuer.response.additional_information

string
Conditionally returned

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

Allowable Values:

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

jit_funding.address_verification.issuer.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

jit_funding.address_verification.request

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

jit_funding.address_verification.request.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

jit_funding.address_verification.request.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

jit_funding.address_verification.request.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

jit_funding.amount

decimal
Returned

Requested amount of funding.

Allowable Values:

0 min

jit_funding.balances

object
Conditionally returned

Contains the GPA’s balance details.

Allowable Values:

Existing balances object

jit_funding.business_token

string
Conditionally returned

Holder of the business account that was funded.

Allowable Values:

36 char max

Existing business_token

jit_funding.decline_reason

string
Conditionally returned

The reason the transaction was declined.

Allowable Values:

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 strings
Conditionally returned

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.

Allowable Values:

Existing incremental authorization JIT funding tokens

jit_funding.memo

string
Conditionally returned

Additional information that describes the JIT funding transaction.

Allowable Values:

99 char max

jit_funding.method

string
Returned

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

Allowable Values:

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

string
Conditionally returned

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.

Allowable Values:

36 char max

jit_funding.tags

string
Conditionally returned

Customer-defined tag for the JIT funding transaction.

Allowable Values:

255 char max

jit_funding.token

string
Returned

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.

Allowable Values:

36 char max

jit_funding.user_token

string
Returned

Holder of the user account that was funded.

Allowable Values:

36 char max

last_modified_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

memo

string
Conditionally returned

Additional descriptive text.

This field is returned if it exists in the resource.

Allowable Values:

99 char max

response

object
Returned

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

Allowable Values:

A valid response object.

response.additional_information

string
Conditionally returned

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

Allowable Values:

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

state

string
Returned

Current status of the funding transaction.

Allowable Values:

PENDING, CLEARED, COMPLETION, DECLINED, ERROR, ALL

tags

string
Conditionally returned

Comma-delimited list of tags describing the order.

This field is returned if it exists in the resource.

Allowable Values:

255 char max

token

string
Returned

The unique identifier of the GPA order.

Allowable Values:

36 char max

transaction_token

string
Returned

Unique identifier of the transaction being funded.

Allowable Values:

Format: UUID

user_token

string
Conditionally returned

The unique identifier of the user.

This field is returned if it exists in the resource.

Allowable Values:

Existing user token

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Retrieve GPA order

Action: GET
Endpoint: /gpaorders/{token}

Use this endpoint to retrieve a GPA order.

URL path parameters
Fields Description

token

string
Required

Existing GPA order token.

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

Allowable Values:

Response body
Fields Description

amount

decimal
Returned

The amount funded.

Allowable Values:

Format: 0.00

business_token

string
Conditionally returned

The unique identifier of the business.

This field is returned if it exists in the resource.

Allowable Values:

Existing business_token

created_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

currency_code

string
Returned

The three-digit ISO 4217 currency code.

Allowable Values:

A valid three-digit ISO 4217 currency code

fees

array of objects
Conditionally returned

List of fees associated with the funding transaction.

This array is returned if it exists in the resource.

Allowable Values:

Existing fee_model objects

fees[].fee

object
Returned

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

Allowable Values:

A valid fees object

fees[].fee.active

boolean
Returned

Indicates whether the fee is active.

Allowable Values:

true, false

fees[].fee.amount

decimal
Returned

The amount of the fee.

Allowable Values:

Format: 0.00

fees[].fee.created_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

fees[].fee.currency_code

string
Returned

The three-digit ISO 4217 currency code.

Allowable Values:

A valid three-digit ISO 4217 currency code

fees[].fee.last_modified_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

fees[].fee.name

string
Returned

The name of the fees object.

Allowable Values:

50 char max

fees[].fee.real_time_assessment

object
Conditionally returned

Controls the assessment of real-time fees.

Allowable Values:

A valid real_time_fee_assessment object

fees[].fee.real_time_assessment.domestic_enabled

boolean
Conditionally returned

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

Allowable Values:

true, false

fees[].fee.real_time_assessment.international_enabled

boolean
Conditionally returned

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

Allowable Values:

true, false

fees[].fee.real_time_assessment.transaction_type

string
Conditionally returned

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

Allowable Values:

authorization, pindebit.atm.withdrawal, pindebit

fees[].fee.tags

string
Conditionally returned

Descriptive metadata about the fee.

Allowable Values:

255 char max

fees[].fee.token

string
Returned

The unique identifier of the fee.

Allowable Values:

36 char max

fees[].memo

string
Conditionally returned

Additional text that describes the fee transfer.

Allowable Values:

1–99 chars

fees[].tags

string
Conditionally returned

Comma-delimited list of tags describing the fee.

Allowable Values:

255 char max

fees[].token

string
Returned

The unique identifier of the fee.

Allowable Values:

1–36 chars

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

fees[].transaction_token

string
Returned

Unique identifier of the transaction.

Allowable Values:

Format: UUID

funding

object
Returned

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

Allowable Values:

A valid funding object

funding.amount

decimal
Conditionally returned

Amount of funds loaded into the GPA.

Allowable Values:

Format: 0.00

funding.gateway_log

object
Conditionally returned

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

Allowable Values:

A valid gateway_log object

funding.gateway_log.duration

integer
Conditionally returned

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

Allowable Values:

Any integer

funding.gateway_log.message

string
Returned

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.

Allowable Values:

Approved or completed successfully, Declined by gateway, Operation timeout

funding.gateway_log.order_number

string
Returned

Customer order number, same value as transaction.token.

Allowable Values:

Existing transaction.token value

funding.gateway_log.response

object
Conditionally returned

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

Allowable Values:

A valid gateway_response object

funding.gateway_log.response.code

string
Returned

Code received from the gateway.

Allowable Values:

funding.gateway_log.response.data

object
Conditionally returned

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

Allowable Values:

A valid jit_funding object

funding.gateway_log.response.data.jit_funding

object
Returned

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

Allowable Values:

Existing jit_funding object

funding.gateway_log.response.data.jit_funding.acting_user_token

string
Conditionally returned

User who conducted the transaction.

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

Allowable Values:

36 char max

Existing user token matching the request.

funding.gateway_log.response.data.jit_funding.address_verification

object
Conditionally returned

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.

Allowable Values:

Existing address_verification object

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

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

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

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

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

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

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

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

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

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

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

object
Conditionally returned

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

Allowable Values:

A valid response object.

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

string
Conditionally returned

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

Allowable Values:

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

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

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

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

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

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

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

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

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

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

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

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

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

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

object
Conditionally returned

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

Allowable Values:

A valid response object.

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

string
Conditionally returned

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

Allowable Values:

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

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

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

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

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

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

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

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

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

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

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

funding.gateway_log.response.data.jit_funding.amount

decimal
Returned

Requested amount of funding.

Allowable Values:

0 min

funding.gateway_log.response.data.jit_funding.balances

object
Conditionally returned

Contains the GPA’s balance details.

Allowable Values:

Existing balances object

funding.gateway_log.response.data.jit_funding.business_token

string
Conditionally returned

Holder of the business account that was funded.

Allowable Values:

36 char max

Existing business_token

funding.gateway_log.response.data.jit_funding.decline_reason

string
Conditionally returned

The reason the transaction was declined.

Allowable Values:

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 strings
Conditionally returned

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.

Allowable Values:

Existing incremental authorization JIT funding tokens

funding.gateway_log.response.data.jit_funding.memo

string
Conditionally returned

Additional information that describes the JIT funding transaction.

Allowable Values:

99 char max

funding.gateway_log.response.data.jit_funding.method

string
Returned

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

Allowable Values:

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

string
Conditionally returned

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.

Allowable Values:

36 char max

funding.gateway_log.response.data.jit_funding.tags

string
Conditionally returned

Customer-defined tag for the JIT funding transaction.

Allowable Values:

255 char max

funding.gateway_log.response.data.jit_funding.token

string
Returned

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.

Allowable Values:

36 char max

funding.gateway_log.response.data.jit_funding.user_token

string
Returned

Holder of the user account that was funded.

Allowable Values:

36 char max

funding.gateway_log.timed_out

boolean
Conditionally returned

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

Allowable Values:

true, false

funding.gateway_log.transaction_id

string
Returned

Customer-defined identifier for the transaction.

Allowable Values:

255 char max

funding.source

object
Returned

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

Allowable Values:

A valid funding_source object

funding.source.active

boolean
Returned

Whether the funding source is active.

Allowable Values:

true, false

funding.source.created_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source.is_default_account

boolean
Returned

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.

Allowable Values:

true, false

funding.source.last_modified_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source.token

string
Returned

The unique identifier of the funding source.

Allowable Values:

36 char max

funding.source.type

string
Returned

The type of account.

Allowable Values:

checking, savings

funding.source_address

object
Conditionally returned

Contains information about the billing address of the funding source.

Allowable Values:

A valid funding_source_address object

funding.source_address.active

boolean
Conditionally returned

Whether the address is active.

Allowable Values:

true, false

funding.source_address.address_1

string
Returned

Street address of the funding source.

Allowable Values:

255 char max

funding.source_address.address_2

string
Conditionally returned

Additional address information for the funding source.

Allowable Values:

255 char max

funding.source_address.business_token

string
Conditionally returned

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

Allowable Values:

1–36 chars

funding.source_address.city

string
Returned

City of the funding source.

Allowable Values:

40 char max

funding.source_address.country

string
Returned

Country of the funding source.

Allowable Values:

1–40 chars

funding.source_address.created_time

datetime
Returned

Date and time when the address was created.

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source_address.first_name

string
Returned

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

Allowable Values:

40 char max

funding.source_address.is_default_address

boolean
Conditionally returned

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

Allowable Values:

true, false

funding.source_address.last_modified_time

datetime
Returned

Date and time when the address was last modified.

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source_address.last_name

string
Returned

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

Allowable Values:

40 char max

funding.source_address.phone

string
Conditionally returned

Phone number of the funding source.

Allowable Values:

255 char max

funding.source_address.postal_code

string
Returned

Postal code of the funding source.

Allowable Values:

10 char max

funding.source_address.state

string
Returned

State of the funding source.

Allowable Values:

2 char max

funding.source_address.token

string
Returned

Unique identifier of the funding_source_address object.

Allowable Values:

1–36 chars

funding.source_address.user_token

string
Conditionally returned

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

Allowable Values:

1–36 chars

funding.source_address.zip

string
Returned

United States ZIP code of the funding source.

Allowable Values:

10 char max

funding_source_address_token

string
Conditionally returned

Identifies the funding source address to use for this order.

Allowable Values:

Existing funding_source_address token

funding_source_token

string
Returned

Identifies the funding source to use for this order.

Allowable Values:

Existing funding_source token

gateway_message

string
Conditionally returned

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.

Allowable Values:

Approved or completed successfully, Declined by gateway, Operation timeout

gateway_token

integer
Conditionally returned

Unique identifier of the JIT Funding request and response.

This field is returned if it exists in the resource.

Allowable Values:

Existing gateway_token

jit_funding

object
Conditionally returned

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

Allowable Values:

Existing jit_funding object

jit_funding.acting_user_token

string
Conditionally returned

User who conducted the transaction.

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

Allowable Values:

36 char max

Existing user token matching the request.

jit_funding.address_verification

object
Conditionally returned

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.

Allowable Values:

Existing address_verification object

jit_funding.address_verification.gateway

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

jit_funding.address_verification.gateway.on_file

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

jit_funding.address_verification.gateway.on_file.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

jit_funding.address_verification.gateway.on_file.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

jit_funding.address_verification.gateway.on_file.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

jit_funding.address_verification.gateway.response

object
Conditionally returned

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

Allowable Values:

A valid response object.

jit_funding.address_verification.gateway.response.additional_information

string
Conditionally returned

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

Allowable Values:

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

jit_funding.address_verification.gateway.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

jit_funding.address_verification.issuer

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

jit_funding.address_verification.issuer.on_file

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

jit_funding.address_verification.issuer.on_file.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

jit_funding.address_verification.issuer.on_file.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

jit_funding.address_verification.issuer.on_file.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

jit_funding.address_verification.issuer.response

object
Conditionally returned

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

Allowable Values:

A valid response object.

jit_funding.address_verification.issuer.response.additional_information

string
Conditionally returned

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

Allowable Values:

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

jit_funding.address_verification.issuer.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

jit_funding.address_verification.request

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

jit_funding.address_verification.request.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

jit_funding.address_verification.request.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

jit_funding.address_verification.request.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

jit_funding.amount

decimal
Returned

Requested amount of funding.

Allowable Values:

0 min

jit_funding.balances

object
Conditionally returned

Contains the GPA’s balance details.

Allowable Values:

Existing balances object

jit_funding.business_token

string
Conditionally returned

Holder of the business account that was funded.

Allowable Values:

36 char max

Existing business_token

jit_funding.decline_reason

string
Conditionally returned

The reason the transaction was declined.

Allowable Values:

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 strings
Conditionally returned

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.

Allowable Values:

Existing incremental authorization JIT funding tokens

jit_funding.memo

string
Conditionally returned

Additional information that describes the JIT funding transaction.

Allowable Values:

99 char max

jit_funding.method

string
Returned

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

Allowable Values:

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

string
Conditionally returned

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.

Allowable Values:

36 char max

jit_funding.tags

string
Conditionally returned

Customer-defined tag for the JIT funding transaction.

Allowable Values:

255 char max

jit_funding.token

string
Returned

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.

Allowable Values:

36 char max

jit_funding.user_token

string
Returned

Holder of the user account that was funded.

Allowable Values:

36 char max

last_modified_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

memo

string
Conditionally returned

Additional descriptive text.

This field is returned if it exists in the resource.

Allowable Values:

99 char max

response

object
Returned

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

Allowable Values:

A valid response object.

response.additional_information

string
Conditionally returned

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

Allowable Values:

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

state

string
Returned

Current status of the funding transaction.

Allowable Values:

PENDING, CLEARED, COMPLETION, DECLINED, ERROR, ALL

tags

string
Conditionally returned

Comma-delimited list of tags describing the order.

This field is returned if it exists in the resource.

Allowable Values:

255 char max

token

string
Returned

The unique identifier of the GPA order.

Allowable Values:

36 char max

transaction_token

string
Returned

Unique identifier of the transaction being funded.

Allowable Values:

Format: UUID

user_token

string
Conditionally returned

The unique identifier of the user.

This field is returned if it exists in the resource.

Allowable Values:

Existing user token

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Create GPA unload

Action: POST
Endpoint: /gpaorders/unloads

Use this endpoint to unload a GPA order.

Unloading a GPA order returns funds to the funding source. A GPA unload must be tied to an original GPA order and can be used to return the amount of the original order or a lesser amount.

Request body
Fields Description

amount

decimal
Required

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

Allowable Values:

Format: 0.00

funding_source_address_token

string
Optional

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.

Allowable Values:

1–36 chars

memo

string
Optional

Additional descriptive text about the GPA unload.

Allowable Values:

99 char max

original_order_token

string
Required

Identifies the original GPA order.

Allowable Values:

1–36 chars

tags

string
Optional

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

Allowable Values:

255 char max

token

string
Optional

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.

Allowable Values:

1–36 chars

Sample request body
JSON
Copied

Is this helpful?

Yes
No
Response body
Fields Description

amount

decimal
Returned

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

Allowable Values:

Format: 0.00

created_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

funding

object
Returned

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

Allowable Values:

A valid funding object

funding.amount

decimal
Conditionally returned

Amount of funds loaded into the GPA.

Allowable Values:

Format: 0.00

funding.gateway_log

object
Conditionally returned

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

Allowable Values:

A valid gateway_log object

funding.gateway_log.duration

integer
Conditionally returned

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

Allowable Values:

Any integer

funding.gateway_log.message

string
Returned

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.

Allowable Values:

Approved or completed successfully, Declined by gateway, Operation timeout

funding.gateway_log.order_number

string
Returned

Customer order number, same value as transaction.token.

Allowable Values:

Existing transaction.token value

funding.gateway_log.response

object
Conditionally returned

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

Allowable Values:

A valid gateway_response object

funding.gateway_log.response.code

string
Returned

Code received from the gateway.

Allowable Values:

funding.gateway_log.response.data

object
Conditionally returned

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

Allowable Values:

A valid jit_funding object

funding.gateway_log.response.data.jit_funding

object
Returned

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

Allowable Values:

Existing jit_funding object

funding.gateway_log.response.data.jit_funding.acting_user_token

string
Conditionally returned

User who conducted the transaction.

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

Allowable Values:

36 char max

Existing user token matching the request.

funding.gateway_log.response.data.jit_funding.address_verification

object
Conditionally returned

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.

Allowable Values:

Existing address_verification object

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

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

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

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

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

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

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

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

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

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

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

object
Conditionally returned

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

Allowable Values:

A valid response object.

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

string
Conditionally returned

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

Allowable Values:

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

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

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

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

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

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

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

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

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

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

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

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

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

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

object
Conditionally returned

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

Allowable Values:

A valid response object.

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

string
Conditionally returned

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

Allowable Values:

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

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

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

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

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

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

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

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

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

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

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

funding.gateway_log.response.data.jit_funding.amount

decimal
Returned

Requested amount of funding.

Allowable Values:

0 min

funding.gateway_log.response.data.jit_funding.balances

object
Conditionally returned

Contains the GPA’s balance details.

Allowable Values:

Existing balances object

funding.gateway_log.response.data.jit_funding.business_token

string
Conditionally returned

Holder of the business account that was funded.

Allowable Values:

36 char max

Existing business_token

funding.gateway_log.response.data.jit_funding.decline_reason

string
Conditionally returned

The reason the transaction was declined.

Allowable Values:

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 strings
Conditionally returned

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.

Allowable Values:

Existing incremental authorization JIT funding tokens

funding.gateway_log.response.data.jit_funding.memo

string
Conditionally returned

Additional information that describes the JIT funding transaction.

Allowable Values:

99 char max

funding.gateway_log.response.data.jit_funding.method

string
Returned

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

Allowable Values:

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

string
Conditionally returned

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.

Allowable Values:

36 char max

funding.gateway_log.response.data.jit_funding.tags

string
Conditionally returned

Customer-defined tag for the JIT funding transaction.

Allowable Values:

255 char max

funding.gateway_log.response.data.jit_funding.token

string
Returned

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.

Allowable Values:

36 char max

funding.gateway_log.response.data.jit_funding.user_token

string
Returned

Holder of the user account that was funded.

Allowable Values:

36 char max

funding.gateway_log.timed_out

boolean
Conditionally returned

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

Allowable Values:

true, false

funding.gateway_log.transaction_id

string
Returned

Customer-defined identifier for the transaction.

Allowable Values:

255 char max

funding.source

object
Returned

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

Allowable Values:

A valid funding_source object

funding.source.active

boolean
Returned

Whether the funding source is active.

Allowable Values:

true, false

funding.source.created_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source.is_default_account

boolean
Returned

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.

Allowable Values:

true, false

funding.source.last_modified_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source.token

string
Returned

The unique identifier of the funding source.

Allowable Values:

36 char max

funding.source.type

string
Returned

The type of account.

Allowable Values:

checking, savings

funding.source_address

object
Conditionally returned

Contains information about the billing address of the funding source.

Allowable Values:

A valid funding_source_address object

funding.source_address.active

boolean
Conditionally returned

Whether the address is active.

Allowable Values:

true, false

funding.source_address.address_1

string
Returned

Street address of the funding source.

Allowable Values:

255 char max

funding.source_address.address_2

string
Conditionally returned

Additional address information for the funding source.

Allowable Values:

255 char max

funding.source_address.business_token

string
Conditionally returned

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

Allowable Values:

1–36 chars

funding.source_address.city

string
Returned

City of the funding source.

Allowable Values:

40 char max

funding.source_address.country

string
Returned

Country of the funding source.

Allowable Values:

1–40 chars

funding.source_address.created_time

datetime
Returned

Date and time when the address was created.

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source_address.first_name

string
Returned

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

Allowable Values:

40 char max

funding.source_address.is_default_address

boolean
Conditionally returned

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

Allowable Values:

true, false

funding.source_address.last_modified_time

datetime
Returned

Date and time when the address was last modified.

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

funding.source_address.last_name

string
Returned

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

Allowable Values:

40 char max

funding.source_address.phone

string
Conditionally returned

Phone number of the funding source.

Allowable Values:

255 char max

funding.source_address.postal_code

string
Returned

Postal code of the funding source.

Allowable Values:

10 char max

funding.source_address.state

string
Returned

State of the funding source.

Allowable Values:

2 char max

funding.source_address.token

string
Returned

Unique identifier of the funding_source_address object.

Allowable Values:

1–36 chars

funding.source_address.user_token

string
Conditionally returned

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

Allowable Values:

1–36 chars

funding.source_address.zip

string
Returned

United States ZIP code of the funding source.

Allowable Values:

10 char max

funding_source_address_token

string
Conditionally returned

Identifies the funding source used for this order.

Allowable Values:

Existing funding_source_address token.

funding_source_token

string
Returned

Identifies the funding source used for this order.

Allowable Values:

Existing funding_source token

jit_funding

object
Conditionally returned

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

Allowable Values:

Existing jit_funding object

jit_funding.acting_user_token

string
Conditionally returned

User who conducted the transaction.

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

Allowable Values:

36 char max

Existing user token matching the request.

jit_funding.address_verification

object
Conditionally returned

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.

Allowable Values:

Existing address_verification object

jit_funding.address_verification.gateway

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

jit_funding.address_verification.gateway.on_file

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

jit_funding.address_verification.gateway.on_file.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

jit_funding.address_verification.gateway.on_file.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

jit_funding.address_verification.gateway.on_file.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

jit_funding.address_verification.gateway.response

object
Conditionally returned

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

Allowable Values:

A valid response object.

jit_funding.address_verification.gateway.response.additional_information

string
Conditionally returned

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

Allowable Values:

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

jit_funding.address_verification.gateway.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

jit_funding.address_verification.issuer

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

jit_funding.address_verification.issuer.on_file

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

jit_funding.address_verification.issuer.on_file.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

jit_funding.address_verification.issuer.on_file.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

jit_funding.address_verification.issuer.on_file.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

jit_funding.address_verification.issuer.response

object
Conditionally returned

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

Allowable Values:

A valid response object.

jit_funding.address_verification.issuer.response.additional_information

string
Conditionally returned

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

Allowable Values:

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

jit_funding.address_verification.issuer.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

jit_funding.address_verification.request

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

jit_funding.address_verification.request.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

jit_funding.address_verification.request.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

jit_funding.address_verification.request.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

jit_funding.amount

decimal
Returned

Requested amount of funding.

Allowable Values:

0 min

jit_funding.balances

object
Conditionally returned

Contains the GPA’s balance details.

Allowable Values:

Existing balances object

jit_funding.business_token

string
Conditionally returned

Holder of the business account that was funded.

Allowable Values:

36 char max

Existing business_token

jit_funding.decline_reason

string
Conditionally returned

The reason the transaction was declined.

Allowable Values:

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 strings
Conditionally returned

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.

Allowable Values:

Existing incremental authorization JIT funding tokens

jit_funding.memo

string
Conditionally returned

Additional information that describes the JIT funding transaction.

Allowable Values:

99 char max

jit_funding.method

string
Returned

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

Allowable Values:

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

string
Conditionally returned

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.

Allowable Values:

36 char max

jit_funding.tags

string
Conditionally returned

Customer-defined tag for the JIT funding transaction.

Allowable Values:

255 char max

jit_funding.token

string
Returned

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.

Allowable Values:

36 char max

jit_funding.user_token

string
Returned

Holder of the user account that was funded.

Allowable Values:

36 char max

last_modified_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

memo

string
Conditionally returned

Additional descriptive text.

Allowable Values:

99 char max

original_order_token

string
Conditionally returned

Identifies the original GPA order.

Allowable Values:

Existing GPA order token

response

object
Returned

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

Allowable Values:

A valid response object.

response.additional_information

string
Conditionally returned

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

Allowable Values:

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

state

string
Returned

Current status of the GPA unload order.

Allowable Values:

PENDING, CLEARED, COMPLETION, DECLINED, ERROR, ALL

tags

string
Conditionally returned

Comma-delimited list of tags describing the order.

Allowable Values:

255 char max

token

string
Returned

The unique identifier of the GPA unload order.

Allowable Values:

Existing GPA unload order token

transaction_token

string
Returned

Unique identifier of the transaction.

Allowable Values:

Format: UUID

Sample response body
JSON
Copied

Is this helpful?

Yes
No

List GPA unloads

Action: GET
Endpoint: /gpaorders/unloads

Use this endpoint to list all GPA unloads or GPA unloads associated with a specific user or business.

This endpoint supports field filtering and pagination.

URL query parameters
Fields Description

count

integer
Optional

The number of resources to retrieve.

Allowable Values:

1-10

start_index

integer
Optional

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

fields

string
Optional

Comma-delimited list of fields to return (field_1,field_2, and so on). Leave blank to return all fields.

Allowable Values:

A comma-delimited list of fields, or blank

sort_by

string
Optional

Field on which to sort. Use any field in the resource model, or one of the system fields lastModifiedTime or createdTime. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.

Allowable Values:

lastModifiedTime, createdTime, or any field in the resource model

user_token

string
Optional

The unique identifier of the user.

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

Allowable Values:

Existing user token.

business_token

string
Optional

The unique identifier of the business.

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

Allowable Values:

Existing business token.

original_order_token

string
Optional

The unique identifier of the original GPA order.

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

Allowable Values:

Existing GPA order token.

Response body
Fields Description

count

integer
Conditionally returned

The number of resources to retrieve.

Allowable Values:

1-10

data

array of objects
Conditionally returned

An array of GPA unload order objects.

Allowable Values:

A valid data array

data[].amount

decimal
Returned

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

Allowable Values:

Format: 0.00

data[].created_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

data[].funding

object
Returned

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

Allowable Values:

A valid funding object

data[].funding.amount

decimal
Conditionally returned

Amount of funds loaded into the GPA.

Allowable Values:

Format: 0.00

data[].funding.gateway_log

object
Conditionally returned

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

Allowable Values:

A valid gateway_log object

data[].funding.gateway_log.duration

integer
Conditionally returned

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

Allowable Values:

Any integer

data[].funding.gateway_log.message

string
Returned

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.

Allowable Values:

Approved or completed successfully, Declined by gateway, Operation timeout

data[].funding.gateway_log.order_number

string
Returned

Customer order number, same value as transaction.token.

Allowable Values:

Existing transaction.token value

data[].funding.gateway_log.response

object
Conditionally returned

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

Allowable Values:

A valid gateway_response object

data[].funding.gateway_log.response.code

string
Returned

Code received from the gateway.

Allowable Values:

data[].funding.gateway_log.response.data

object
Conditionally returned

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

Allowable Values:

A valid jit_funding object

data[].funding.gateway_log.response.data.jit_funding

object
Returned

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

Allowable Values:

Existing jit_funding object

data[].funding.gateway_log.response.data.jit_funding.acting_user_token

string
Conditionally returned

User who conducted the transaction.

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

Allowable Values:

36 char max

Existing user token matching the request.

data[].funding.gateway_log.response.data.jit_funding.address_verification

object
Conditionally returned

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.

Allowable Values:

Existing address_verification object

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

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

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

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

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

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

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

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

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

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

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

object
Conditionally returned

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

Allowable Values:

A valid response object.

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

string
Conditionally returned

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

Allowable Values:

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.

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

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

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

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

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

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

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

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

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

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

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

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

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

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

object
Conditionally returned

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

Allowable Values:

A valid response object.

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

string
Conditionally returned

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

Allowable Values:

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.

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

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

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

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

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

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

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

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

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

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

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].funding.gateway_log.response.data.jit_funding.amount

decimal
Returned

Requested amount of funding.

Allowable Values:

0 min

data[].funding.gateway_log.response.data.jit_funding.balances

object
Conditionally returned

Contains the GPA’s balance details.

Allowable Values:

Existing balances object

data[].funding.gateway_log.response.data.jit_funding.business_token

string
Conditionally returned

Holder of the business account that was funded.

Allowable Values:

36 char max

Existing business_token

data[].funding.gateway_log.response.data.jit_funding.decline_reason

string
Conditionally returned

The reason the transaction was declined.

Allowable Values:

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

data[].funding.gateway_log.response.data.jit_funding.incremental_authorization_jit_funding_tokens

array of strings
Conditionally returned

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.

Allowable Values:

Existing incremental authorization JIT funding tokens

data[].funding.gateway_log.response.data.jit_funding.memo

string
Conditionally returned

Additional information that describes the JIT funding transaction.

Allowable Values:

99 char max

data[].funding.gateway_log.response.data.jit_funding.method

string
Returned

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

Allowable Values:

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

data[].funding.gateway_log.response.data.jit_funding.original_jit_funding_token

string
Conditionally returned

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.

Allowable Values:

36 char max

data[].funding.gateway_log.response.data.jit_funding.tags

string
Conditionally returned

Customer-defined tag for the JIT funding transaction.

Allowable Values:

255 char max

data[].funding.gateway_log.response.data.jit_funding.token

string
Returned

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.

Allowable Values:

36 char max

data[].funding.gateway_log.response.data.jit_funding.user_token

string
Returned

Holder of the user account that was funded.

Allowable Values:

36 char max

data[].funding.gateway_log.timed_out

boolean
Conditionally returned

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

Allowable Values:

true, false

data[].funding.gateway_log.transaction_id

string
Returned

Customer-defined identifier for the transaction.

Allowable Values:

255 char max

data[].funding.source

object
Returned

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

Allowable Values:

A valid funding_source object

data[].funding.source.active

boolean
Returned

Whether the funding source is active.

Allowable Values:

true, false

data[].funding.source.created_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

data[].funding.source.is_default_account

boolean
Returned

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.

Allowable Values:

true, false

data[].funding.source.last_modified_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

data[].funding.source.token

string
Returned

The unique identifier of the funding source.

Allowable Values:

36 char max

data[].funding.source.type

string
Returned

The type of account.

Allowable Values:

checking, savings

data[].funding.source_address

object
Conditionally returned

Contains information about the billing address of the funding source.

Allowable Values:

A valid funding_source_address object

data[].funding.source_address.active

boolean
Conditionally returned

Whether the address is active.

Allowable Values:

true, false

data[].funding.source_address.address_1

string
Returned

Street address of the funding source.

Allowable Values:

255 char max

data[].funding.source_address.address_2

string
Conditionally returned

Additional address information for the funding source.

Allowable Values:

255 char max

data[].funding.source_address.business_token

string
Conditionally returned

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

Allowable Values:

1–36 chars

data[].funding.source_address.city

string
Returned

City of the funding source.

Allowable Values:

40 char max

data[].funding.source_address.country

string
Returned

Country of the funding source.

Allowable Values:

1–40 chars

data[].funding.source_address.created_time

datetime
Returned

Date and time when the address was created.

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

data[].funding.source_address.first_name

string
Returned

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

Allowable Values:

40 char max

data[].funding.source_address.is_default_address

boolean
Conditionally returned

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

Allowable Values:

true, false

data[].funding.source_address.last_modified_time

datetime
Returned

Date and time when the address was last modified.

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

data[].funding.source_address.last_name

string
Returned

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

Allowable Values:

40 char max

data[].funding.source_address.phone

string
Conditionally returned

Phone number of the funding source.

Allowable Values:

255 char max

data[].funding.source_address.postal_code

string
Returned

Postal code of the funding source.

Allowable Values:

10 char max

data[].funding.source_address.state

string
Returned

State of the funding source.

Allowable Values:

2 char max

data[].funding.source_address.token

string
Returned

Unique identifier of the funding_source_address object.

Allowable Values:

1–36 chars

data[].funding.source_address.user_token

string
Conditionally returned

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

Allowable Values:

1–36 chars

data[].funding.source_address.zip

string
Returned

United States ZIP code of the funding source.

Allowable Values:

10 char max

data[].funding_source_address_token

string
Conditionally returned

Identifies the funding source used for this order.

Allowable Values:

Existing funding_source_address token.

data[].funding_source_token

string
Returned

Identifies the funding source used for this order.

Allowable Values:

Existing funding_source token

data[].jit_funding

object
Conditionally returned

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

Allowable Values:

Existing jit_funding object

data[].jit_funding.acting_user_token

string
Conditionally returned

User who conducted the transaction.

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

Allowable Values:

36 char max

Existing user token matching the request.

data[].jit_funding.address_verification

object
Conditionally returned

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.

Allowable Values:

Existing address_verification object

data[].jit_funding.address_verification.gateway

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

data[].jit_funding.address_verification.gateway.on_file

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

data[].jit_funding.address_verification.gateway.on_file.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].jit_funding.address_verification.gateway.on_file.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].jit_funding.address_verification.gateway.on_file.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].jit_funding.address_verification.gateway.response

object
Conditionally returned

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

Allowable Values:

A valid response object.

data[].jit_funding.address_verification.gateway.response.additional_information

string
Conditionally returned

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

Allowable Values:

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.

data[].jit_funding.address_verification.gateway.response.code

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

data[].jit_funding.address_verification.gateway.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

data[].jit_funding.address_verification.issuer

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

data[].jit_funding.address_verification.issuer.on_file

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

data[].jit_funding.address_verification.issuer.on_file.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].jit_funding.address_verification.issuer.on_file.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].jit_funding.address_verification.issuer.on_file.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].jit_funding.address_verification.issuer.response

object
Conditionally returned

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

Allowable Values:

A valid response object.

data[].jit_funding.address_verification.issuer.response.additional_information

string
Conditionally returned

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

Allowable Values:

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.

data[].jit_funding.address_verification.issuer.response.code

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

data[].jit_funding.address_verification.issuer.response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

data[].jit_funding.address_verification.request

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

data[].jit_funding.address_verification.request.postal_code

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

data[].jit_funding.address_verification.request.street_address

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

data[].jit_funding.address_verification.request.zip

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

data[].jit_funding.amount

decimal
Returned

Requested amount of funding.

Allowable Values:

0 min

data[].jit_funding.balances

object
Conditionally returned

Contains the GPA’s balance details.

Allowable Values:

Existing balances object

data[].jit_funding.business_token

string
Conditionally returned

Holder of the business account that was funded.

Allowable Values:

36 char max

Existing business_token

data[].jit_funding.decline_reason

string
Conditionally returned

The reason the transaction was declined.

Allowable Values:

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

data[].jit_funding.incremental_authorization_jit_funding_tokens

array of strings
Conditionally returned

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.

Allowable Values:

Existing incremental authorization JIT funding tokens

data[].jit_funding.memo

string
Conditionally returned

Additional information that describes the JIT funding transaction.

Allowable Values:

99 char max

data[].jit_funding.method

string
Returned

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

Allowable Values:

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

data[].jit_funding.original_jit_funding_token

string
Conditionally returned

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.

Allowable Values:

36 char max

data[].jit_funding.tags

string
Conditionally returned

Customer-defined tag for the JIT funding transaction.

Allowable Values:

255 char max

data[].jit_funding.token

string
Returned

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.

Allowable Values:

36 char max

data[].jit_funding.user_token

string
Returned

Holder of the user account that was funded.

Allowable Values:

36 char max

data[].last_modified_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

data[].memo

string
Conditionally returned

Additional descriptive text.

Allowable Values:

99 char max

data[].original_order_token

string
Conditionally returned

Identifies the original GPA order.

Allowable Values:

Existing GPA order token

data[].response

object
Returned

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

Allowable Values:

A valid response object.

data[].response.additional_information

string
Conditionally returned

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

Allowable Values:

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.

data[].response.code

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

data[].response.memo

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

data[].state

string
Returned

Current status of the GPA unload order.

Allowable Values:

PENDING, CLEARED, COMPLETION, DECLINED, ERROR, ALL

data[].tags

string
Conditionally returned

Comma-delimited list of tags describing the order.

Allowable Values:

255 char max

data[].token

string
Returned

The unique identifier of the GPA unload order.

Allowable Values:

Existing GPA unload order token

data[].transaction_token

string
Returned

Unique identifier of the transaction.

Allowable Values:

Format: UUID

end_index

integer
Conditionally returned

The sort order index of the last resource in the returned array.

Allowable Values:

Any integer

is_more

boolean
Conditionally returned

A value of true indicates that more unreturned resources exist.

Allowable Values:

true, false

start_index

integer
Conditionally returned

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Retrieve GPA unload

Action: GET
Endpoint: /gpaorders/unloads/{unload_token}

Use this endpoint to retrieve a specific GPA unload.

URL path parameters
Fields Description

unload_token

string
Required

The unique identifier of the GPA unload.

Allowable Values:

Existing GPA unload token.

Response body
Fields Description

amount

decimal
Returned

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

Allowable Values:

Format: 0.00

created_time

datetime
Returned

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

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

funding

object
Returned

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

Allowable Values:

A valid funding object

funding.amount

decimal
Conditionally returned

Amount of funds loaded into the GPA.

Allowable Values:

Format: 0.00

funding.gateway_log

object
Conditionally returned

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

Allowable Values:

A valid gateway_log object

funding.gateway_log.duration

integer
Conditionally returned

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

Allowable Values:

Any integer

funding.gateway_log.message

string
Returned

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.

Allowable Values:

Approved or completed successfully, Declined by gateway, Operation timeout

funding.gateway_log.order_number

string
Returned

Customer order number, same value as transaction.token.

Allowable Values:

Existing transaction.token value

funding.gateway_log.response

object
Conditionally returned

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

Allowable Values:

A valid gateway_response object

funding.gateway_log.response.code

string
Returned

Code received from the gateway.

Allowable Values:

funding.gateway_log.response.data

object
Conditionally returned

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

Allowable Values:

A valid jit_funding object

funding.gateway_log.response.data.jit_funding

object
Returned

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

Allowable Values:

Existing jit_funding object

funding.gateway_log.response.data.jit_funding.acting_user_token

string
Conditionally returned

User who conducted the transaction.

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

Allowable Values:

36 char max

Existing user token matching the request.

funding.gateway_log.response.data.jit_funding.address_verification

object
Conditionally returned

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.

Allowable Values:

Existing address_verification object

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

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

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

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

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

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

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

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

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

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

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

object
Conditionally returned

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

Allowable Values:

A valid response object.

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

string
Conditionally returned

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

Allowable Values:

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

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

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

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

object
Conditionally returned

Contains funding source address verification information.

Allowable Values:

A valid address_verification_source object

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

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

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

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

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

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

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

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

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

object
Conditionally returned

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

Allowable Values:

A valid response object.

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

string
Conditionally returned

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

Allowable Values:

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

string
Returned

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:

  • 0000 – passed

  • 0001 – did not pass

Allowable Values:

Four digit code

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

string
Returned

Information on the outcome of the attempted transaction type.

Allowable Values:

255 char max

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

object
Conditionally returned

Contains address verification information.

Allowable Values:

A valid avs_information object

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

string
Conditionally returned

Postal code.

Allowable Values:

10 char max

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

string
Conditionally returned

Street address provided by the cardholder.

Allowable Values:

40 char max

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

string
Conditionally returned

United States ZIP code.

Allowable Values:

10 char max

funding.gateway_log.response.data.jit_funding.amount

decimal
Returned

Requested amount of funding.

Allowable Values:

0 min

funding.gateway_log.response.data.jit_funding.balances

object
Conditionally returned

Contains the GPA’s balance details.

Allowable Values:

Existing balances object

funding.gateway_log.response.data.jit_funding.business_token

string
Conditionally returned

Holder of the business account that was funded.

Allowable Values:

36 char max

Existing business_token

funding.gateway_log.response.data.jit_funding.decline_reason

string
Conditionally returned

The reason the transaction was declined.

Allowable Values:

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 strings
Conditionally returned

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.

Allowable Values:

Existing incremental authorization JIT funding tokens

funding.gateway_log.response.data.jit_funding.memo

string
Conditionally returned

Additional information that describes the JIT funding transaction.

Allowable Values:

99 char max

funding.gateway_log.response.data.jit_funding.method

string
Returned

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

Allowable Values:

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

string
Conditionally returned

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.

Allowable Values:

36 char max

funding.gateway_log.response.data.jit_funding.tags

string
Conditionally returned

Customer-defined tag for the JIT funding transaction.

Allowable Values:

255 char max

funding.gateway_log.response.data.jit_funding.token

string
Returned

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.

Allowable Values:

36 char max

funding.gateway_log.response.data.jit_funding.user_token