/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:POSTEndpoint:
/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 | Amount to fund. Allowable Values: decimal Format: 0.00 |
| business_token string Optional | 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 | Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
| fees array of objects Optional | List of fees associated with the funding transaction. Allowable Values: Valid array of one or more fees objects |
| fees[].memo string Optional | Additional text describing the fee. Allowable Values: 1–255 chars |
| fees[].overrideAmount decimal Optional | Dynamic fee amount that overrides the fee.amount field value.Allowable Values: decimal Format: 0.00 |
| fees[].tags string Optional | Descriptive metadata about the fee. Allowable Values: 255 char max |
| fees[].token string Required | Unique identifier of the fee. Allowable Values: 1–36 chars |
| funding_source_address_token string Optional | Unique identifier of 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/ to retrieve addresses for a specific user.Allowable Values: 1–36 chars |
| funding_source_token string Required | Unique identifier of the funding source to use for this order. You do not 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/ to retrieve funding source tokens for a user or to /fundingsources/business/ 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 GPA order. Allowable Values: 1–255 chars |
| token string Optional | 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 | 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 |
| source_load_type string Optional | Unique identifier of how the funding source is loaded. This field is only available for specific card programs. For more information, contact your Marqeta representative. Allowable Values: ach, otc, debitcard, promotion, earnedwageaccess |
Sample request body
JSON
Response body
| Fields | Description |
|---|---|
| amount decimal Returned | Amount funded. Allowable Values: decimal Format: 0.00 |
| business_token string Conditionally returned | Unique identifier of the business. This field is returned if it exists in the resource. Allowable Values: Existing business_token |
| created_time datetime Returned | Date and time when the GPA order was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| currency_code string Returned | Three-digit ISO 4217 currency code. Allowable Values: 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: Valid array of one or more fees objects |
| fees[].fee object Returned | Contains details about the fee. Allowable Values: amount, created_time, currency_code, last_modified_time, name, tags, token |
| fees[].fee.amount decimal Returned | Amount of the fee. Allowable Values: decimal Format: 0.00 |
| fees[].fee.created_time datetime Returned | Date and time when the fees object was created, in UTC.Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| fees[].fee.currency_code string Returned | Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
| fees[].fee.last_modified_time datetime Returned | Date and time when the fees object was last modified, in UTC.Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| fees[].fee.name string Returned | Name of the fee. Allowable Values: 50 char max |
| fees[].fee.tags string Conditionally returned | Descriptive metadata about the fee. Allowable Values: 255 char max |
| fees[].fee.token string Returned | Unique identifier of the fees object.Allowable Values: Existing fees object token |
| fees[].memo string Conditionally returned | Additional text describing the fee. Allowable Values: 1–255 chars |
| fees[].overrideAmount decimal Conditionally returned | Dynamic fee amount that overrides the fee.amount field value.Allowable Values: decimal Format: 0.00 |
| fees[].tags string Conditionally returned | Descriptive metadata about the fee. Allowable Values: 255 char max |
| fees[].token string Returned | Unique identifier of the fee. Allowable Values: 1–36 chars |
| fees[].transaction_token string Returned | Unique identifier of the fee transaction. Allowable Values: 36 char max |
| funding object Returned | Contains funding information for the transaction, including funding amount, type, and time. Allowable Values: amount, gateway_log, source, source_address |
| funding.amount decimal Conditionally returned | Amount of funds loaded into the GPA. Allowable Values: decimal Format: 0.00 |
| funding.gateway_log object Conditionally returned | Contains information from the JIT Funding gateway in response to a funding request. Allowable Values: duration, message, order_number, response, timed_out, transaction_id |
| funding.gateway_log.duration integer Conditionally returned | Length of time in milliseconds that 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: code, data |
| funding.gateway_log.response.code string Returned | Code received from the gateway. Allowable Values: 255 char max |
| funding.gateway_log.response.data object Conditionally returned | Contains the gateway’s information about the JIT Funding transaction. Allowable Values: jit_funding |
| funding.gateway_log.response.data.jit_funding object Returned | Contains information about the JIT Funding load event, in which funds are loaded into an account. This object is returned if your program uses JIT Funding. Allowable Values: acting_user_token, address_verification, amount, balances, business_token, decline_reason, incremental_authorization_jit_funding_tokens, memo, method, original_jit_funding_token, tags, token, user_token |
| 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 |
| funding.gateway_log.response.data.jit_funding.address_verification object Conditionally returned | Contains address verification data used to make JIT Funding decisions. Allowable Values: gateway, issuer, request |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway 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: on_file, response |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.street_address string Conditionally returned | Street name and number of the address. 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 of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer 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: on_file, response |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.street_address string Conditionally returned | Street name and number of the address. 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 of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.request object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| funding.gateway_log.response.data.jit_funding.address_verification.request.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.request.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.request.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.jit_account_name_verification object Conditionally returned | Contains account name verification data used to make JIT Funding decisions from one of the following objects: - The gateway object, which contains account name verification data from your JIT Funding gateway.- The issuer object, which contains account name verification data from the Marqeta platform.- The request object, which contains account name verification data as it appears in a JIT Funding request.Allowable Values: gateway, issuer, request |
| funding.gateway_log.response.data.jit_funding.jit_account_name_verification.gateway object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| funding.gateway_log.response.data.jit_funding.jit_account_name_verification.issuer object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| funding.gateway_log.response.data.jit_funding.jit_account_name_verification.request object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| funding.gateway_log.response.data.jit_funding.amount decimal Returned | Requested amount of funding. Allowable Values: 0 min Format: 0.00 |
| funding.gateway_log.response.data.jit_funding.balances object Conditionally returned | Contains the GPA’s balance details. Allowable Values: available_balance, balances, cached_balance, credit_balance, currency_code, impacted_amount, last_updated_time, ledger_balance, pending_credits |
| 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 |
| funding.gateway_log.response.data.jit_funding.decline_reason string Conditionally returned | Reason why the transaction was declined. Allowable Values: AMOUNT_LIMIT_EXCEEDED, BLOCKED_BY_CARDHOLDER, BLOCKED_BY_ISSUER, BLOCKED_MERCHANT_BY_CARDHOLDER, CARD_NOT_ACTIVE, CARDHOLDER_NOT_ACTIVE, CLOSED_ACCOUNT, DUPLICATE_TRANSACTION, EXPIRED_CARD, INSUFFICIENT_FUNDS, INVALID_AMOUNT, INVALID_CARD, INVALID_MERCHANT, NO_CHECKING_ACCOUNT, NO_CREDIT_ACCOUNT, NO_SAVINGS_ACCOUNT, REVOCATION_ALL_AUTHORIZATION_ORDER, REVOCATION_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, SOFT_DECLINE_PIN_REQUIRED, STOP_PAYMENT, SUSPECTED_FRAUD, TRANSACTION_COUNT_LIMIT_EXCEEDED, TRANSACTION_NOT_PERMITTED |
| 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.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth_plus_capture, pgfs.auth_plus_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal |
| funding.gateway_log.response.data.jit_funding.original_jit_funding_token string Conditionally returned | Unique identifier 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 tags related to 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 GPA order.NOTE: 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.response.data.flex object Conditionally returned | Contains information about a Flexible Credential transaction. Allowable Values: action, eligible, eligible_products, secondary_credential_identifier, selected_product |
| funding.gateway_log.response.data.flex.action string Conditionally returned | Indicates whether the Flexible Credential transaction object is actionable (inquiry) or merely informative (advice).Allowable Values: inquiry, advice |
| funding.gateway_log.response.data.flex.eligible string Conditionally returned | Indicates whether or not the transaction is eligible for Flexible Credential transactions. Allowable Values: true, false |
| funding.gateway_log.response.data.flex.eligible_products array of strings Conditionally returned | Specifies which of the payment instrument’s credentials is eligible for this transaction: - A value of DEBIT indicates the primary credential.- A value of LOAN indicates the secondary credential.Allowable Values: DEBIT, LOAN |
| funding.gateway_log.response.data.flex.secondary_credential_identifier string Conditionally returned | Identifies the secondary credential used in the transaction, if applicable. Allowable Values: 255 char max |
| funding.gateway_log.response.data.flex.selected_product string Conditionally returned | Indicates the eligible product that was used in the transaction. Allowable Values: DEBIT, LOAN |
| 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 | Contains funding source information for the transaction, including the funding type and time. Allowable Values: active, created_time, is_default_account, last_modified_time, token, type |
| funding.source.active boolean Returned | Whether the funding source is active. Allowable Values: true, false |
| funding.source.created_time datetime Returned | Date and time when the funding source was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| funding.source.is_default_account boolean Returned | Whether the GPA order unload’s funding source is the default funding account. Allowable Values: true, false |
| funding.source.last_modified_time datetime Returned | Date and time when the funding source was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| funding.source.token string Returned | Unique identifier of the funding source. Allowable Values: Format: UUID |
| funding.source.type string Returned | Funding type of the funding source. Allowable Values: ach, paymentcard |
| funding.source_address object Conditionally returned | Contains information about the billing address of the funding source. Allowable Values: active, address_1, address_2, business_token, city, country, created_time, first_name, is_default_address, last_modified_time, last_name, phone, postal_code, state, token, user_token, zip |
| 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. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| funding.source_address.business_token string Conditionally returned | Unique identifier of the business account holder associated with the address. This field is returned if it exists in the resource. 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, in UTC. Allowable Values: datetime 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, in UTC. This field is returned if it exists in the resource. Allowable Values: datetime 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. This field is returned if it exists in the resource. 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 | Two-character state, provincial, or territorial abbreviation. For the complete list, see Valid state, provincial, territorial, and federal abbreviations. 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. This field is returned if it exists in the resource. 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 | Unique identifier of the funding source address to use for this order. Allowable Values: Existing funding_source_address token |
| funding_source_token string Returned | Unique identifier of 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 information about the JIT Funding load event, in which funds are loaded into an account. This object is returned if your program uses JIT Funding. Allowable Values: acting_user_token, address_verification, amount, balances, business_token, decline_reason, incremental_authorization_jit_funding_tokens, memo, method, original_jit_funding_token, tags, token, user_token |
| 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 |
| jit_funding.address_verification object Conditionally returned | Contains address verification data used to make JIT Funding decisions. Allowable Values: gateway, issuer, request |
| jit_funding.address_verification.gateway 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: on_file, response |
| jit_funding.address_verification.gateway.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| jit_funding.address_verification.gateway.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.gateway.on_file.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| jit_funding.address_verification.gateway.on_file.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.gateway.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| jit_funding.address_verification.gateway.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| jit_funding.address_verification.gateway.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| jit_funding.address_verification.gateway.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| jit_funding.address_verification.issuer 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: on_file, response |
| jit_funding.address_verification.issuer.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| jit_funding.address_verification.issuer.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.issuer.on_file.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| jit_funding.address_verification.issuer.on_file.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.issuer.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| jit_funding.address_verification.issuer.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| jit_funding.address_verification.issuer.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| jit_funding.address_verification.issuer.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| jit_funding.address_verification.request object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| jit_funding.address_verification.request.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.request.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| jit_funding.address_verification.request.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| jit_funding.jit_account_name_verification object Conditionally returned | Contains account name verification data used to make JIT Funding decisions from one of the following objects: - The gateway object, which contains account name verification data from your JIT Funding gateway.- The issuer object, which contains account name verification data from the Marqeta platform.- The request object, which contains account name verification data as it appears in a JIT Funding request.Allowable Values: gateway, issuer, request |
| jit_funding.jit_account_name_verification.gateway object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| jit_funding.jit_account_name_verification.issuer object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| jit_funding.jit_account_name_verification.request object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| jit_funding.amount decimal Returned | Requested amount of funding. Allowable Values: 0 min Format: 0.00 |
| jit_funding.balances object Conditionally returned | Contains the GPA’s balance details. Allowable Values: available_balance, balances, cached_balance, credit_balance, currency_code, impacted_amount, last_updated_time, ledger_balance, pending_credits |
| jit_funding.business_token string Conditionally returned | Holder of the business account that was funded. Allowable Values: 36 char max |
| jit_funding.decline_reason string Conditionally returned | Reason why the transaction was declined. Allowable Values: AMOUNT_LIMIT_EXCEEDED, BLOCKED_BY_CARDHOLDER, BLOCKED_BY_ISSUER, BLOCKED_MERCHANT_BY_CARDHOLDER, CARD_NOT_ACTIVE, CARDHOLDER_NOT_ACTIVE, CLOSED_ACCOUNT, DUPLICATE_TRANSACTION, EXPIRED_CARD, INSUFFICIENT_FUNDS, INVALID_AMOUNT, INVALID_CARD, INVALID_MERCHANT, NO_CHECKING_ACCOUNT, NO_CREDIT_ACCOUNT, NO_SAVINGS_ACCOUNT, REVOCATION_ALL_AUTHORIZATION_ORDER, REVOCATION_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, SOFT_DECLINE_PIN_REQUIRED, STOP_PAYMENT, SUSPECTED_FRAUD, TRANSACTION_COUNT_LIMIT_EXCEEDED, TRANSACTION_NOT_PERMITTED |
| 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.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth_plus_capture, pgfs.auth_plus_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal |
| jit_funding.original_jit_funding_token string Conditionally returned | Unique identifier 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 tags related to 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 GPA order.NOTE: 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 order was last modified, in UTC. Allowable Values: datetime 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 | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| state string Returned | Current status of the funding transaction. Allowable Values: PENDING, CLEARED, COMPLETION, DECLINED, ERROR, REVERSED |
| tags string Conditionally returned | Comma-delimited list of tags describing the GPA order. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| token string Returned | 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 | Unique identifier of the user resource. This field is returned if it exists in the resource. Allowable Values: Existing user resource token |
Sample response body
JSON
Retrieve GPA order
Action:GETEndpoint:
/gpaorders/{token}
Use this endpoint to retrieve a GPA order.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the 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 |
|---|---|
| amount decimal Returned | Amount funded. Allowable Values: decimal Format: 0.00 |
| business_token string Conditionally returned | Unique identifier of the business. This field is returned if it exists in the resource. Allowable Values: Existing business_token |
| created_time datetime Returned | Date and time when the GPA order was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| currency_code string Returned | Three-digit ISO 4217 currency code. Allowable Values: 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: Valid array of one or more fees objects |
| fees[].fee object Returned | Contains details about the fee. Allowable Values: amount, created_time, currency_code, last_modified_time, name, tags, token |
| fees[].fee.amount decimal Returned | Amount of the fee. Allowable Values: decimal Format: 0.00 |
| fees[].fee.created_time datetime Returned | Date and time when the fees object was created, in UTC.Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| fees[].fee.currency_code string Returned | Three-digit ISO 4217 currency code. Allowable Values: Valid three-digit ISO 4217 currency code |
| fees[].fee.last_modified_time datetime Returned | Date and time when the fees object was last modified, in UTC.Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| fees[].fee.name string Returned | Name of the fee. Allowable Values: 50 char max |
| fees[].fee.tags string Conditionally returned | Descriptive metadata about the fee. Allowable Values: 255 char max |
| fees[].fee.token string Returned | Unique identifier of the fees object.Allowable Values: Existing fees object token |
| fees[].memo string Conditionally returned | Additional text describing the fee. Allowable Values: 1–255 chars |
| fees[].overrideAmount decimal Conditionally returned | Dynamic fee amount that overrides the fee.amount field value.Allowable Values: decimal Format: 0.00 |
| fees[].tags string Conditionally returned | Descriptive metadata about the fee. Allowable Values: 255 char max |
| fees[].token string Returned | Unique identifier of the fee. Allowable Values: 1–36 chars |
| fees[].transaction_token string Returned | Unique identifier of the fee transaction. Allowable Values: 36 char max |
| funding object Returned | Contains funding information for the transaction, including funding amount, type, and time. Allowable Values: amount, gateway_log, source, source_address |
| funding.amount decimal Conditionally returned | Amount of funds loaded into the GPA. Allowable Values: decimal Format: 0.00 |
| funding.gateway_log object Conditionally returned | Contains information from the JIT Funding gateway in response to a funding request. Allowable Values: duration, message, order_number, response, timed_out, transaction_id |
| funding.gateway_log.duration integer Conditionally returned | Length of time in milliseconds that 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: code, data |
| funding.gateway_log.response.code string Returned | Code received from the gateway. Allowable Values: 255 char max |
| funding.gateway_log.response.data object Conditionally returned | Contains the gateway’s information about the JIT Funding transaction. Allowable Values: jit_funding |
| funding.gateway_log.response.data.jit_funding object Returned | Contains information about the JIT Funding load event, in which funds are loaded into an account. This object is returned if your program uses JIT Funding. Allowable Values: acting_user_token, address_verification, amount, balances, business_token, decline_reason, incremental_authorization_jit_funding_tokens, memo, method, original_jit_funding_token, tags, token, user_token |
| 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 |
| funding.gateway_log.response.data.jit_funding.address_verification object Conditionally returned | Contains address verification data used to make JIT Funding decisions. Allowable Values: gateway, issuer, request |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway 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: on_file, response |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.street_address string Conditionally returned | Street name and number of the address. 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 of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer 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: on_file, response |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.street_address string Conditionally returned | Street name and number of the address. 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 of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.request object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| funding.gateway_log.response.data.jit_funding.address_verification.request.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.request.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.request.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.jit_account_name_verification object Conditionally returned | Contains account name verification data used to make JIT Funding decisions from one of the following objects: - The gateway object, which contains account name verification data from your JIT Funding gateway.- The issuer object, which contains account name verification data from the Marqeta platform.- The request object, which contains account name verification data as it appears in a JIT Funding request.Allowable Values: gateway, issuer, request |
| funding.gateway_log.response.data.jit_funding.jit_account_name_verification.gateway object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| funding.gateway_log.response.data.jit_funding.jit_account_name_verification.issuer object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| funding.gateway_log.response.data.jit_funding.jit_account_name_verification.request object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| funding.gateway_log.response.data.jit_funding.amount decimal Returned | Requested amount of funding. Allowable Values: 0 min Format: 0.00 |
| funding.gateway_log.response.data.jit_funding.balances object Conditionally returned | Contains the GPA’s balance details. Allowable Values: available_balance, balances, cached_balance, credit_balance, currency_code, impacted_amount, last_updated_time, ledger_balance, pending_credits |
| 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 |
| funding.gateway_log.response.data.jit_funding.decline_reason string Conditionally returned | Reason why the transaction was declined. Allowable Values: AMOUNT_LIMIT_EXCEEDED, BLOCKED_BY_CARDHOLDER, BLOCKED_BY_ISSUER, BLOCKED_MERCHANT_BY_CARDHOLDER, CARD_NOT_ACTIVE, CARDHOLDER_NOT_ACTIVE, CLOSED_ACCOUNT, DUPLICATE_TRANSACTION, EXPIRED_CARD, INSUFFICIENT_FUNDS, INVALID_AMOUNT, INVALID_CARD, INVALID_MERCHANT, NO_CHECKING_ACCOUNT, NO_CREDIT_ACCOUNT, NO_SAVINGS_ACCOUNT, REVOCATION_ALL_AUTHORIZATION_ORDER, REVOCATION_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, SOFT_DECLINE_PIN_REQUIRED, STOP_PAYMENT, SUSPECTED_FRAUD, TRANSACTION_COUNT_LIMIT_EXCEEDED, TRANSACTION_NOT_PERMITTED |
| 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.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth_plus_capture, pgfs.auth_plus_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal |
| funding.gateway_log.response.data.jit_funding.original_jit_funding_token string Conditionally returned | Unique identifier 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 tags related to 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 GPA order.NOTE: 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.response.data.flex object Conditionally returned | Contains information about a Flexible Credential transaction. Allowable Values: action, eligible, eligible_products, secondary_credential_identifier, selected_product |
| funding.gateway_log.response.data.flex.action string Conditionally returned | Indicates whether the Flexible Credential transaction object is actionable (inquiry) or merely informative (advice).Allowable Values: inquiry, advice |
| funding.gateway_log.response.data.flex.eligible string Conditionally returned | Indicates whether or not the transaction is eligible for Flexible Credential transactions. Allowable Values: true, false |
| funding.gateway_log.response.data.flex.eligible_products array of strings Conditionally returned | Specifies which of the payment instrument’s credentials is eligible for this transaction: - A value of DEBIT indicates the primary credential.- A value of LOAN indicates the secondary credential.Allowable Values: DEBIT, LOAN |
| funding.gateway_log.response.data.flex.secondary_credential_identifier string Conditionally returned | Identifies the secondary credential used in the transaction, if applicable. Allowable Values: 255 char max |
| funding.gateway_log.response.data.flex.selected_product string Conditionally returned | Indicates the eligible product that was used in the transaction. Allowable Values: DEBIT, LOAN |
| 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 | Contains funding source information for the transaction, including the funding type and time. Allowable Values: active, created_time, is_default_account, last_modified_time, token, type |
| funding.source.active boolean Returned | Whether the funding source is active. Allowable Values: true, false |
| funding.source.created_time datetime Returned | Date and time when the funding source was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| funding.source.is_default_account boolean Returned | Whether the GPA order unload’s funding source is the default funding account. Allowable Values: true, false |
| funding.source.last_modified_time datetime Returned | Date and time when the funding source was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| funding.source.token string Returned | Unique identifier of the funding source. Allowable Values: Format: UUID |
| funding.source.type string Returned | Funding type of the funding source. Allowable Values: ach, paymentcard |
| funding.source_address object Conditionally returned | Contains information about the billing address of the funding source. Allowable Values: active, address_1, address_2, business_token, city, country, created_time, first_name, is_default_address, last_modified_time, last_name, phone, postal_code, state, token, user_token, zip |
| 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. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| funding.source_address.business_token string Conditionally returned | Unique identifier of the business account holder associated with the address. This field is returned if it exists in the resource. 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, in UTC. Allowable Values: datetime 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, in UTC. This field is returned if it exists in the resource. Allowable Values: datetime 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. This field is returned if it exists in the resource. 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 | Two-character state, provincial, or territorial abbreviation. For the complete list, see Valid state, provincial, territorial, and federal abbreviations. 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. This field is returned if it exists in the resource. 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 | Unique identifier of the funding source address to use for this order. Allowable Values: Existing funding_source_address token |
| funding_source_token string Returned | Unique identifier of 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 information about the JIT Funding load event, in which funds are loaded into an account. This object is returned if your program uses JIT Funding. Allowable Values: acting_user_token, address_verification, amount, balances, business_token, decline_reason, incremental_authorization_jit_funding_tokens, memo, method, original_jit_funding_token, tags, token, user_token |
| 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 |
| jit_funding.address_verification object Conditionally returned | Contains address verification data used to make JIT Funding decisions. Allowable Values: gateway, issuer, request |
| jit_funding.address_verification.gateway 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: on_file, response |
| jit_funding.address_verification.gateway.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| jit_funding.address_verification.gateway.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.gateway.on_file.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| jit_funding.address_verification.gateway.on_file.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.gateway.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| jit_funding.address_verification.gateway.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| jit_funding.address_verification.gateway.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| jit_funding.address_verification.gateway.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| jit_funding.address_verification.issuer 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: on_file, response |
| jit_funding.address_verification.issuer.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| jit_funding.address_verification.issuer.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.issuer.on_file.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| jit_funding.address_verification.issuer.on_file.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.issuer.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| jit_funding.address_verification.issuer.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| jit_funding.address_verification.issuer.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| jit_funding.address_verification.issuer.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| jit_funding.address_verification.request object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| jit_funding.address_verification.request.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.request.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| jit_funding.address_verification.request.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| jit_funding.jit_account_name_verification object Conditionally returned | Contains account name verification data used to make JIT Funding decisions from one of the following objects: - The gateway object, which contains account name verification data from your JIT Funding gateway.- The issuer object, which contains account name verification data from the Marqeta platform.- The request object, which contains account name verification data as it appears in a JIT Funding request.Allowable Values: gateway, issuer, request |
| jit_funding.jit_account_name_verification.gateway object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| jit_funding.jit_account_name_verification.issuer object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| jit_funding.jit_account_name_verification.request object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| jit_funding.amount decimal Returned | Requested amount of funding. Allowable Values: 0 min Format: 0.00 |
| jit_funding.balances object Conditionally returned | Contains the GPA’s balance details. Allowable Values: available_balance, balances, cached_balance, credit_balance, currency_code, impacted_amount, last_updated_time, ledger_balance, pending_credits |
| jit_funding.business_token string Conditionally returned | Holder of the business account that was funded. Allowable Values: 36 char max |
| jit_funding.decline_reason string Conditionally returned | Reason why the transaction was declined. Allowable Values: AMOUNT_LIMIT_EXCEEDED, BLOCKED_BY_CARDHOLDER, BLOCKED_BY_ISSUER, BLOCKED_MERCHANT_BY_CARDHOLDER, CARD_NOT_ACTIVE, CARDHOLDER_NOT_ACTIVE, CLOSED_ACCOUNT, DUPLICATE_TRANSACTION, EXPIRED_CARD, INSUFFICIENT_FUNDS, INVALID_AMOUNT, INVALID_CARD, INVALID_MERCHANT, NO_CHECKING_ACCOUNT, NO_CREDIT_ACCOUNT, NO_SAVINGS_ACCOUNT, REVOCATION_ALL_AUTHORIZATION_ORDER, REVOCATION_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, SOFT_DECLINE_PIN_REQUIRED, STOP_PAYMENT, SUSPECTED_FRAUD, TRANSACTION_COUNT_LIMIT_EXCEEDED, TRANSACTION_NOT_PERMITTED |
| 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.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth_plus_capture, pgfs.auth_plus_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal |
| jit_funding.original_jit_funding_token string Conditionally returned | Unique identifier 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 tags related to 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 GPA order.NOTE: 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 order was last modified, in UTC. Allowable Values: datetime 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 | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| state string Returned | Current status of the funding transaction. Allowable Values: PENDING, CLEARED, COMPLETION, DECLINED, ERROR, REVERSED |
| tags string Conditionally returned | Comma-delimited list of tags describing the GPA order. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| token string Returned | 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 | Unique identifier of the user resource. This field is returned if it exists in the resource. Allowable Values: Existing user resource token |
Sample response body
JSON
Create GPA unload
Action:POSTEndpoint:
/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 | Amount of funds to return to the funding source. Allowable Values: decimal Format: 0.00 |
| funding_source_address_token string Optional | Unique identifier of the funding source to use for this GPA unload order. Send a GET request to /fundingsources/addresses/user/ 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 | Unique identifier of 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 | 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
Response body
| Fields | Description |
|---|---|
| amount decimal Returned | Amount of funds returned to the funding source. Allowable Values: decimal Format: 0.00 |
| created_time datetime Returned | Date and time when the GPA unload order was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| funding object Returned | Contains funding information for the transaction, including funding amount, type, and time. Allowable Values: amount, gateway_log, source, source_address |
| funding.amount decimal Conditionally returned | Amount of funds loaded into the GPA. Allowable Values: decimal Format: 0.00 |
| funding.gateway_log object Conditionally returned | Contains information from the JIT Funding gateway in response to a funding request. Allowable Values: duration, message, order_number, response, timed_out, transaction_id |
| funding.gateway_log.duration integer Conditionally returned | Length of time in milliseconds that 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: code, data |
| funding.gateway_log.response.code string Returned | Code received from the gateway. Allowable Values: 255 char max |
| funding.gateway_log.response.data object Conditionally returned | Contains the gateway’s information about the JIT Funding transaction. Allowable Values: jit_funding |
| funding.gateway_log.response.data.jit_funding object Returned | Contains information about the JIT Funding load event, in which funds are loaded into an account. This object is returned if your program uses JIT Funding. Allowable Values: acting_user_token, address_verification, amount, balances, business_token, decline_reason, incremental_authorization_jit_funding_tokens, memo, method, original_jit_funding_token, tags, token, user_token |
| 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 |
| funding.gateway_log.response.data.jit_funding.address_verification object Conditionally returned | Contains address verification data used to make JIT Funding decisions. Allowable Values: gateway, issuer, request |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway 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: on_file, response |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.street_address string Conditionally returned | Street name and number of the address. 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 of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer 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: on_file, response |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.street_address string Conditionally returned | Street name and number of the address. 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 of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.request object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| funding.gateway_log.response.data.jit_funding.address_verification.request.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.request.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.request.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.jit_account_name_verification object Conditionally returned | Contains account name verification data used to make JIT Funding decisions from one of the following objects: - The gateway object, which contains account name verification data from your JIT Funding gateway.- The issuer object, which contains account name verification data from the Marqeta platform.- The request object, which contains account name verification data as it appears in a JIT Funding request.Allowable Values: gateway, issuer, request |
| funding.gateway_log.response.data.jit_funding.jit_account_name_verification.gateway object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| funding.gateway_log.response.data.jit_funding.jit_account_name_verification.issuer object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| funding.gateway_log.response.data.jit_funding.jit_account_name_verification.request object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| funding.gateway_log.response.data.jit_funding.amount decimal Returned | Requested amount of funding. Allowable Values: 0 min Format: 0.00 |
| funding.gateway_log.response.data.jit_funding.balances object Conditionally returned | Contains the GPA’s balance details. Allowable Values: available_balance, balances, cached_balance, credit_balance, currency_code, impacted_amount, last_updated_time, ledger_balance, pending_credits |
| 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 |
| funding.gateway_log.response.data.jit_funding.decline_reason string Conditionally returned | Reason why the transaction was declined. Allowable Values: AMOUNT_LIMIT_EXCEEDED, BLOCKED_BY_CARDHOLDER, BLOCKED_BY_ISSUER, BLOCKED_MERCHANT_BY_CARDHOLDER, CARD_NOT_ACTIVE, CARDHOLDER_NOT_ACTIVE, CLOSED_ACCOUNT, DUPLICATE_TRANSACTION, EXPIRED_CARD, INSUFFICIENT_FUNDS, INVALID_AMOUNT, INVALID_CARD, INVALID_MERCHANT, NO_CHECKING_ACCOUNT, NO_CREDIT_ACCOUNT, NO_SAVINGS_ACCOUNT, REVOCATION_ALL_AUTHORIZATION_ORDER, REVOCATION_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, SOFT_DECLINE_PIN_REQUIRED, STOP_PAYMENT, SUSPECTED_FRAUD, TRANSACTION_COUNT_LIMIT_EXCEEDED, TRANSACTION_NOT_PERMITTED |
| 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.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth_plus_capture, pgfs.auth_plus_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal |
| funding.gateway_log.response.data.jit_funding.original_jit_funding_token string Conditionally returned | Unique identifier 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 tags related to 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 GPA order.NOTE: 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.response.data.flex object Conditionally returned | Contains information about a Flexible Credential transaction. Allowable Values: action, eligible, eligible_products, secondary_credential_identifier, selected_product |
| funding.gateway_log.response.data.flex.action string Conditionally returned | Indicates whether the Flexible Credential transaction object is actionable (inquiry) or merely informative (advice).Allowable Values: inquiry, advice |
| funding.gateway_log.response.data.flex.eligible string Conditionally returned | Indicates whether or not the transaction is eligible for Flexible Credential transactions. Allowable Values: true, false |
| funding.gateway_log.response.data.flex.eligible_products array of strings Conditionally returned | Specifies which of the payment instrument’s credentials is eligible for this transaction: - A value of DEBIT indicates the primary credential.- A value of LOAN indicates the secondary credential.Allowable Values: DEBIT, LOAN |
| funding.gateway_log.response.data.flex.secondary_credential_identifier string Conditionally returned | Identifies the secondary credential used in the transaction, if applicable. Allowable Values: 255 char max |
| funding.gateway_log.response.data.flex.selected_product string Conditionally returned | Indicates the eligible product that was used in the transaction. Allowable Values: DEBIT, LOAN |
| 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 | Contains funding source information for the transaction, including the funding type and time. Allowable Values: active, created_time, is_default_account, last_modified_time, token, type |
| funding.source.active boolean Returned | Whether the funding source is active. Allowable Values: true, false |
| funding.source.created_time datetime Returned | Date and time when the funding source was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| funding.source.is_default_account boolean Returned | Whether the GPA order unload’s funding source is the default funding account. Allowable Values: true, false |
| funding.source.last_modified_time datetime Returned | Date and time when the funding source was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| funding.source.token string Returned | Unique identifier of the funding source. Allowable Values: Format: UUID |
| funding.source.type string Returned | Funding type of the funding source. Allowable Values: ach, paymentcard |
| funding.source_address object Conditionally returned | Contains information about the billing address of the funding source. Allowable Values: active, address_1, address_2, business_token, city, country, created_time, first_name, is_default_address, last_modified_time, last_name, phone, postal_code, state, token, user_token, zip |
| 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. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| funding.source_address.business_token string Conditionally returned | Unique identifier of the business account holder associated with the address. This field is returned if it exists in the resource. 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, in UTC. Allowable Values: datetime 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, in UTC. This field is returned if it exists in the resource. Allowable Values: datetime 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. This field is returned if it exists in the resource. 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 | Two-character state, provincial, or territorial abbreviation. For the complete list, see Valid state, provincial, territorial, and federal abbreviations. 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. This field is returned if it exists in the resource. 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 information about the JIT Funding load event, in which funds are loaded into an account. This object is returned if your program uses JIT Funding. Allowable Values: acting_user_token, address_verification, amount, balances, business_token, decline_reason, incremental_authorization_jit_funding_tokens, memo, method, original_jit_funding_token, tags, token, user_token |
| 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 |
| jit_funding.address_verification object Conditionally returned | Contains address verification data used to make JIT Funding decisions. Allowable Values: gateway, issuer, request |
| jit_funding.address_verification.gateway 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: on_file, response |
| jit_funding.address_verification.gateway.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| jit_funding.address_verification.gateway.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.gateway.on_file.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| jit_funding.address_verification.gateway.on_file.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.gateway.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| jit_funding.address_verification.gateway.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| jit_funding.address_verification.gateway.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| jit_funding.address_verification.gateway.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| jit_funding.address_verification.issuer 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: on_file, response |
| jit_funding.address_verification.issuer.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| jit_funding.address_verification.issuer.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.issuer.on_file.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| jit_funding.address_verification.issuer.on_file.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.issuer.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| jit_funding.address_verification.issuer.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| jit_funding.address_verification.issuer.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| jit_funding.address_verification.issuer.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| jit_funding.address_verification.request object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| jit_funding.address_verification.request.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.request.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| jit_funding.address_verification.request.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| jit_funding.jit_account_name_verification object Conditionally returned | Contains account name verification data used to make JIT Funding decisions from one of the following objects: - The gateway object, which contains account name verification data from your JIT Funding gateway.- The issuer object, which contains account name verification data from the Marqeta platform.- The request object, which contains account name verification data as it appears in a JIT Funding request.Allowable Values: gateway, issuer, request |
| jit_funding.jit_account_name_verification.gateway object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| jit_funding.jit_account_name_verification.issuer object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| jit_funding.jit_account_name_verification.request object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| jit_funding.amount decimal Returned | Requested amount of funding. Allowable Values: 0 min Format: 0.00 |
| jit_funding.balances object Conditionally returned | Contains the GPA’s balance details. Allowable Values: available_balance, balances, cached_balance, credit_balance, currency_code, impacted_amount, last_updated_time, ledger_balance, pending_credits |
| jit_funding.business_token string Conditionally returned | Holder of the business account that was funded. Allowable Values: 36 char max |
| jit_funding.decline_reason string Conditionally returned | Reason why the transaction was declined. Allowable Values: AMOUNT_LIMIT_EXCEEDED, BLOCKED_BY_CARDHOLDER, BLOCKED_BY_ISSUER, BLOCKED_MERCHANT_BY_CARDHOLDER, CARD_NOT_ACTIVE, CARDHOLDER_NOT_ACTIVE, CLOSED_ACCOUNT, DUPLICATE_TRANSACTION, EXPIRED_CARD, INSUFFICIENT_FUNDS, INVALID_AMOUNT, INVALID_CARD, INVALID_MERCHANT, NO_CHECKING_ACCOUNT, NO_CREDIT_ACCOUNT, NO_SAVINGS_ACCOUNT, REVOCATION_ALL_AUTHORIZATION_ORDER, REVOCATION_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, SOFT_DECLINE_PIN_REQUIRED, STOP_PAYMENT, SUSPECTED_FRAUD, TRANSACTION_COUNT_LIMIT_EXCEEDED, TRANSACTION_NOT_PERMITTED |
| 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.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth_plus_capture, pgfs.auth_plus_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal |
| jit_funding.original_jit_funding_token string Conditionally returned | Unique identifier 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 tags related to 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 GPA order.NOTE: 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: datetime 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 | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| state string Returned | Current status of the GPA unload order. Allowable Values: PENDING, CLEARED, COMPLETION, DECLINED, ERROR, REVERSED |
| tags string Conditionally returned | Comma-delimited list of tags describing the GPA order. Allowable Values: 255 char max |
| token string Returned | 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
List GPA unloads
Action:GETEndpoint:
/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 | Number of resources to retrieve. Allowable Values: 1-10 Default value: 5 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: Any integer Default value: 0 |
| 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: 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: createdTime, lastModifiedTime, or any field in the resource modelDefault value: -lastModifiedTime |
| user_token string Optional | Unique identifier of the user resource. Send a GET request to /users to retrieve user tokens.Allowable Values: Existing user resource token |
| business_token string Optional | Unique identifier of the business resource. Send a GET request to /businesses to retrieve business tokens.Allowable Values: Existing business resource token |
| original_order_token string Optional | 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 | Number of resources to retrieve. This field is returned if there are resources in your returned array. Allowable Values: 1-10 |
| data array of objects Conditionally returned | Array of GPA unload order objects. Objects are returned as appropriate to your query. Allowable Values: Valid array of one or more GPA unload order objects |
| data[].amount decimal Returned | Amount of funds returned to the funding source. Allowable Values: decimal Format: 0.00 |
| data[].created_time datetime Returned | Date and time when the GPA unload order was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| data[].funding object Returned | Contains funding information for the transaction, including funding amount, type, and time. Allowable Values: amount, gateway_log, source, source_address |
| data[].funding.amount decimal Conditionally returned | Amount of funds loaded into the GPA. Allowable Values: decimal Format: 0.00 |
| data[].funding.gateway_log object Conditionally returned | Contains information from the JIT Funding gateway in response to a funding request. Allowable Values: duration, message, order_number, response, timed_out, transaction_id |
| data[].funding.gateway_log.duration integer Conditionally returned | Length of time in milliseconds that 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: code, data |
| data[].funding.gateway_log.response.code string Returned | Code received from the gateway. Allowable Values: 255 char max |
| data[].funding.gateway_log.response.data object Conditionally returned | Contains the gateway’s information about the JIT Funding transaction. Allowable Values: jit_funding |
| data[].funding.gateway_log.response.data.jit_funding object Returned | Contains information about the JIT Funding load event, in which funds are loaded into an account. This object is returned if your program uses JIT Funding. Allowable Values: acting_user_token, address_verification, amount, balances, business_token, decline_reason, incremental_authorization_jit_funding_tokens, memo, method, original_jit_funding_token, tags, token, user_token |
| 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 |
| data[].funding.gateway_log.response.data.jit_funding.address_verification object Conditionally returned | Contains address verification data used to make JIT Funding decisions. Allowable Values: gateway, issuer, request |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.gateway 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: on_file, response |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.street_address string Conditionally returned | Street name and number of the address. 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 of the address. Allowable Values: 10 char max |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.gateway.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.issuer 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: on_file, response |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.street_address string Conditionally returned | Street name and number of the address. 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 of the address. Allowable Values: 10 char max |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.issuer.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.memo string Returned | Additional text that describes the response. 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: postal_code, street_address, zip |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.request.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.request.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| data[].funding.gateway_log.response.data.jit_funding.address_verification.request.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| data[].funding.gateway_log.response.data.jit_funding.jit_account_name_verification object Conditionally returned | Contains account name verification data used to make JIT Funding decisions from one of the following objects: - The gateway object, which contains account name verification data from your JIT Funding gateway.- The issuer object, which contains account name verification data from the Marqeta platform.- The request object, which contains account name verification data as it appears in a JIT Funding request.Allowable Values: gateway, issuer, request |
| data[].funding.gateway_log.response.data.jit_funding.jit_account_name_verification.gateway object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| data[].funding.gateway_log.response.data.jit_funding.jit_account_name_verification.issuer object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| data[].funding.gateway_log.response.data.jit_funding.jit_account_name_verification.request object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| data[].funding.gateway_log.response.data.jit_funding.amount decimal Returned | Requested amount of funding. Allowable Values: 0 min Format: 0.00 |
| data[].funding.gateway_log.response.data.jit_funding.balances object Conditionally returned | Contains the GPA’s balance details. Allowable Values: available_balance, balances, cached_balance, credit_balance, currency_code, impacted_amount, last_updated_time, ledger_balance, pending_credits |
| 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 |
| data[].funding.gateway_log.response.data.jit_funding.decline_reason string Conditionally returned | Reason why the transaction was declined. Allowable Values: AMOUNT_LIMIT_EXCEEDED, BLOCKED_BY_CARDHOLDER, BLOCKED_BY_ISSUER, BLOCKED_MERCHANT_BY_CARDHOLDER, CARD_NOT_ACTIVE, CARDHOLDER_NOT_ACTIVE, CLOSED_ACCOUNT, DUPLICATE_TRANSACTION, EXPIRED_CARD, INSUFFICIENT_FUNDS, INVALID_AMOUNT, INVALID_CARD, INVALID_MERCHANT, NO_CHECKING_ACCOUNT, NO_CREDIT_ACCOUNT, NO_SAVINGS_ACCOUNT, REVOCATION_ALL_AUTHORIZATION_ORDER, REVOCATION_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, SOFT_DECLINE_PIN_REQUIRED, STOP_PAYMENT, SUSPECTED_FRAUD, TRANSACTION_COUNT_LIMIT_EXCEEDED, TRANSACTION_NOT_PERMITTED |
| 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.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth_plus_capture, pgfs.auth_plus_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal |
| data[].funding.gateway_log.response.data.jit_funding.original_jit_funding_token string Conditionally returned | Unique identifier 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 tags related to 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 GPA order.NOTE: 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.response.data.flex object Conditionally returned | Contains information about a Flexible Credential transaction. Allowable Values: action, eligible, eligible_products, secondary_credential_identifier, selected_product |
| data[].funding.gateway_log.response.data.flex.action string Conditionally returned | Indicates whether the Flexible Credential transaction object is actionable (inquiry) or merely informative (advice).Allowable Values: inquiry, advice |
| data[].funding.gateway_log.response.data.flex.eligible string Conditionally returned | Indicates whether or not the transaction is eligible for Flexible Credential transactions. Allowable Values: true, false |
| data[].funding.gateway_log.response.data.flex.eligible_products array of strings Conditionally returned | Specifies which of the payment instrument’s credentials is eligible for this transaction: - A value of DEBIT indicates the primary credential.- A value of LOAN indicates the secondary credential.Allowable Values: DEBIT, LOAN |
| data[].funding.gateway_log.response.data.flex.secondary_credential_identifier string Conditionally returned | Identifies the secondary credential used in the transaction, if applicable. Allowable Values: 255 char max |
| data[].funding.gateway_log.response.data.flex.selected_product string Conditionally returned | Indicates the eligible product that was used in the transaction. Allowable Values: DEBIT, LOAN |
| 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 | Contains funding source information for the transaction, including the funding type and time. Allowable Values: active, created_time, is_default_account, last_modified_time, token, type |
| data[].funding.source.active boolean Returned | Whether the funding source is active. Allowable Values: true, false |
| data[].funding.source.created_time datetime Returned | Date and time when the funding source was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| data[].funding.source.is_default_account boolean Returned | Whether the GPA order unload’s funding source is the default funding account. Allowable Values: true, false |
| data[].funding.source.last_modified_time datetime Returned | Date and time when the funding source was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| data[].funding.source.token string Returned | Unique identifier of the funding source. Allowable Values: Format: UUID |
| data[].funding.source.type string Returned | Funding type of the funding source. Allowable Values: ach, paymentcard |
| data[].funding.source_address object Conditionally returned | Contains information about the billing address of the funding source. Allowable Values: active, address_1, address_2, business_token, city, country, created_time, first_name, is_default_address, last_modified_time, last_name, phone, postal_code, state, token, user_token, zip |
| 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. This field is returned if it exists in the resource. 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. This field is returned if it exists in the resource. 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, in UTC. Allowable Values: datetime 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, in UTC. This field is returned if it exists in the resource. Allowable Values: datetime 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. This field is returned if it exists in the resource. 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 | Two-character state, provincial, or territorial abbreviation. For the complete list, see Valid state, provincial, territorial, and federal abbreviations. 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. This field is returned if it exists in the resource. 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 information about the JIT Funding load event, in which funds are loaded into an account. This object is returned if your program uses JIT Funding. Allowable Values: acting_user_token, address_verification, amount, balances, business_token, decline_reason, incremental_authorization_jit_funding_tokens, memo, method, original_jit_funding_token, tags, token, user_token |
| 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 |
| data[].jit_funding.address_verification object Conditionally returned | Contains address verification data used to make JIT Funding decisions. Allowable Values: gateway, issuer, request |
| data[].jit_funding.address_verification.gateway 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: on_file, response |
| data[].jit_funding.address_verification.gateway.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| data[].jit_funding.address_verification.gateway.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| data[].jit_funding.address_verification.gateway.on_file.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| data[].jit_funding.address_verification.gateway.on_file.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| data[].jit_funding.address_verification.gateway.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| data[].jit_funding.address_verification.gateway.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| data[].jit_funding.address_verification.gateway.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| data[].jit_funding.address_verification.gateway.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| data[].jit_funding.address_verification.issuer 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: on_file, response |
| data[].jit_funding.address_verification.issuer.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| data[].jit_funding.address_verification.issuer.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| data[].jit_funding.address_verification.issuer.on_file.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| data[].jit_funding.address_verification.issuer.on_file.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| data[].jit_funding.address_verification.issuer.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| data[].jit_funding.address_verification.issuer.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| data[].jit_funding.address_verification.issuer.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| data[].jit_funding.address_verification.issuer.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| data[].jit_funding.address_verification.request object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| data[].jit_funding.address_verification.request.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| data[].jit_funding.address_verification.request.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| data[].jit_funding.address_verification.request.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| data[].jit_funding.jit_account_name_verification object Conditionally returned | Contains account name verification data used to make JIT Funding decisions from one of the following objects: - The gateway object, which contains account name verification data from your JIT Funding gateway.- The issuer object, which contains account name verification data from the Marqeta platform.- The request object, which contains account name verification data as it appears in a JIT Funding request.Allowable Values: gateway, issuer, request |
| data[].jit_funding.jit_account_name_verification.gateway object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| data[].jit_funding.jit_account_name_verification.issuer object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| data[].jit_funding.jit_account_name_verification.request object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| data[].jit_funding.amount decimal Returned | Requested amount of funding. Allowable Values: 0 min Format: 0.00 |
| data[].jit_funding.balances object Conditionally returned | Contains the GPA’s balance details. Allowable Values: available_balance, balances, cached_balance, credit_balance, currency_code, impacted_amount, last_updated_time, ledger_balance, pending_credits |
| data[].jit_funding.business_token string Conditionally returned | Holder of the business account that was funded. Allowable Values: 36 char max |
| data[].jit_funding.decline_reason string Conditionally returned | Reason why the transaction was declined. Allowable Values: AMOUNT_LIMIT_EXCEEDED, BLOCKED_BY_CARDHOLDER, BLOCKED_BY_ISSUER, BLOCKED_MERCHANT_BY_CARDHOLDER, CARD_NOT_ACTIVE, CARDHOLDER_NOT_ACTIVE, CLOSED_ACCOUNT, DUPLICATE_TRANSACTION, EXPIRED_CARD, INSUFFICIENT_FUNDS, INVALID_AMOUNT, INVALID_CARD, INVALID_MERCHANT, NO_CHECKING_ACCOUNT, NO_CREDIT_ACCOUNT, NO_SAVINGS_ACCOUNT, REVOCATION_ALL_AUTHORIZATION_ORDER, REVOCATION_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, SOFT_DECLINE_PIN_REQUIRED, STOP_PAYMENT, SUSPECTED_FRAUD, TRANSACTION_COUNT_LIMIT_EXCEEDED, TRANSACTION_NOT_PERMITTED |
| 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.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth_plus_capture, pgfs.auth_plus_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal |
| data[].jit_funding.original_jit_funding_token string Conditionally returned | Unique identifier 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 tags related to 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 GPA order.NOTE: 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: datetime 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 | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| data[].response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| data[].response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| data[].response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| data[].state string Returned | Current status of the GPA unload order. Allowable Values: PENDING, CLEARED, COMPLETION, DECLINED, ERROR, REVERSED |
| data[].tags string Conditionally returned | Comma-delimited list of tags describing the GPA order. Allowable Values: 255 char max |
| data[].token string Returned | 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 | Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
| is_more boolean Conditionally returned | A value of true indicates that more unreturned resources exist. A value of false indicates that no more unreturned resources exist.This field is returned if there are resources in your returned array. Allowable Values: true, false |
| start_index integer Conditionally returned | Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
Sample response body
JSON
Retrieve GPA unload
Action:GETEndpoint:
/gpaorders/unloads/{unload_token}
Use this endpoint to retrieve a specific GPA unload.
URL path parameters
| Fields | Description |
|---|---|
| unload_token string Required | Unique identifier of the GPA unload. Allowable Values: Existing GPA unload token |
Response body
| Fields | Description |
|---|---|
| amount decimal Returned | Amount of funds returned to the funding source. Allowable Values: decimal Format: 0.00 |
| created_time datetime Returned | Date and time when the GPA unload order was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| funding object Returned | Contains funding information for the transaction, including funding amount, type, and time. Allowable Values: amount, gateway_log, source, source_address |
| funding.amount decimal Conditionally returned | Amount of funds loaded into the GPA. Allowable Values: decimal Format: 0.00 |
| funding.gateway_log object Conditionally returned | Contains information from the JIT Funding gateway in response to a funding request. Allowable Values: duration, message, order_number, response, timed_out, transaction_id |
| funding.gateway_log.duration integer Conditionally returned | Length of time in milliseconds that 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: code, data |
| funding.gateway_log.response.code string Returned | Code received from the gateway. Allowable Values: 255 char max |
| funding.gateway_log.response.data object Conditionally returned | Contains the gateway’s information about the JIT Funding transaction. Allowable Values: jit_funding |
| funding.gateway_log.response.data.jit_funding object Returned | Contains information about the JIT Funding load event, in which funds are loaded into an account. This object is returned if your program uses JIT Funding. Allowable Values: acting_user_token, address_verification, amount, balances, business_token, decline_reason, incremental_authorization_jit_funding_tokens, memo, method, original_jit_funding_token, tags, token, user_token |
| 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 |
| funding.gateway_log.response.data.jit_funding.address_verification object Conditionally returned | Contains address verification data used to make JIT Funding decisions. Allowable Values: gateway, issuer, request |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway 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: on_file, response |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.street_address string Conditionally returned | Street name and number of the address. 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 of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer 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: on_file, response |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.street_address string Conditionally returned | Street name and number of the address. 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 of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.request object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| funding.gateway_log.response.data.jit_funding.address_verification.request.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.request.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| funding.gateway_log.response.data.jit_funding.address_verification.request.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| funding.gateway_log.response.data.jit_funding.jit_account_name_verification object Conditionally returned | Contains account name verification data used to make JIT Funding decisions from one of the following objects: - The gateway object, which contains account name verification data from your JIT Funding gateway.- The issuer object, which contains account name verification data from the Marqeta platform.- The request object, which contains account name verification data as it appears in a JIT Funding request.Allowable Values: gateway, issuer, request |
| funding.gateway_log.response.data.jit_funding.jit_account_name_verification.gateway object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| funding.gateway_log.response.data.jit_funding.jit_account_name_verification.issuer object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| funding.gateway_log.response.data.jit_funding.jit_account_name_verification.request object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| funding.gateway_log.response.data.jit_funding.amount decimal Returned | Requested amount of funding. Allowable Values: 0 min Format: 0.00 |
| funding.gateway_log.response.data.jit_funding.balances object Conditionally returned | Contains the GPA’s balance details. Allowable Values: available_balance, balances, cached_balance, credit_balance, currency_code, impacted_amount, last_updated_time, ledger_balance, pending_credits |
| 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 |
| funding.gateway_log.response.data.jit_funding.decline_reason string Conditionally returned | Reason why the transaction was declined. Allowable Values: AMOUNT_LIMIT_EXCEEDED, BLOCKED_BY_CARDHOLDER, BLOCKED_BY_ISSUER, BLOCKED_MERCHANT_BY_CARDHOLDER, CARD_NOT_ACTIVE, CARDHOLDER_NOT_ACTIVE, CLOSED_ACCOUNT, DUPLICATE_TRANSACTION, EXPIRED_CARD, INSUFFICIENT_FUNDS, INVALID_AMOUNT, INVALID_CARD, INVALID_MERCHANT, NO_CHECKING_ACCOUNT, NO_CREDIT_ACCOUNT, NO_SAVINGS_ACCOUNT, REVOCATION_ALL_AUTHORIZATION_ORDER, REVOCATION_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, SOFT_DECLINE_PIN_REQUIRED, STOP_PAYMENT, SUSPECTED_FRAUD, TRANSACTION_COUNT_LIMIT_EXCEEDED, TRANSACTION_NOT_PERMITTED |
| 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.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth_plus_capture, pgfs.auth_plus_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal |
| funding.gateway_log.response.data.jit_funding.original_jit_funding_token string Conditionally returned | Unique identifier 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 tags related to 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 GPA order.NOTE: 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.response.data.flex object Conditionally returned | Contains information about a Flexible Credential transaction. Allowable Values: action, eligible, eligible_products, secondary_credential_identifier, selected_product |
| funding.gateway_log.response.data.flex.action string Conditionally returned | Indicates whether the Flexible Credential transaction object is actionable (inquiry) or merely informative (advice).Allowable Values: inquiry, advice |
| funding.gateway_log.response.data.flex.eligible string Conditionally returned | Indicates whether or not the transaction is eligible for Flexible Credential transactions. Allowable Values: true, false |
| funding.gateway_log.response.data.flex.eligible_products array of strings Conditionally returned | Specifies which of the payment instrument’s credentials is eligible for this transaction: - A value of DEBIT indicates the primary credential.- A value of LOAN indicates the secondary credential.Allowable Values: DEBIT, LOAN |
| funding.gateway_log.response.data.flex.secondary_credential_identifier string Conditionally returned | Identifies the secondary credential used in the transaction, if applicable. Allowable Values: 255 char max |
| funding.gateway_log.response.data.flex.selected_product string Conditionally returned | Indicates the eligible product that was used in the transaction. Allowable Values: DEBIT, LOAN |
| 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 | Contains funding source information for the transaction, including the funding type and time. Allowable Values: active, created_time, is_default_account, last_modified_time, token, type |
| funding.source.active boolean Returned | Whether the funding source is active. Allowable Values: true, false |
| funding.source.created_time datetime Returned | Date and time when the funding source was created, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| funding.source.is_default_account boolean Returned | Whether the GPA order unload’s funding source is the default funding account. Allowable Values: true, false |
| funding.source.last_modified_time datetime Returned | Date and time when the funding source was last modified, in UTC. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| funding.source.token string Returned | Unique identifier of the funding source. Allowable Values: Format: UUID |
| funding.source.type string Returned | Funding type of the funding source. Allowable Values: ach, paymentcard |
| funding.source_address object Conditionally returned | Contains information about the billing address of the funding source. Allowable Values: active, address_1, address_2, business_token, city, country, created_time, first_name, is_default_address, last_modified_time, last_name, phone, postal_code, state, token, user_token, zip |
| 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. This field is returned if it exists in the resource. Allowable Values: 255 char max |
| funding.source_address.business_token string Conditionally returned | Unique identifier of the business account holder associated with the address. This field is returned if it exists in the resource. 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, in UTC. Allowable Values: datetime 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, in UTC. This field is returned if it exists in the resource. Allowable Values: datetime 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. This field is returned if it exists in the resource. 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 | Two-character state, provincial, or territorial abbreviation. For the complete list, see Valid state, provincial, territorial, and federal abbreviations. 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. This field is returned if it exists in the resource. 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 information about the JIT Funding load event, in which funds are loaded into an account. This object is returned if your program uses JIT Funding. Allowable Values: acting_user_token, address_verification, amount, balances, business_token, decline_reason, incremental_authorization_jit_funding_tokens, memo, method, original_jit_funding_token, tags, token, user_token |
| 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 |
| jit_funding.address_verification object Conditionally returned | Contains address verification data used to make JIT Funding decisions. Allowable Values: gateway, issuer, request |
| jit_funding.address_verification.gateway 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: on_file, response |
| jit_funding.address_verification.gateway.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| jit_funding.address_verification.gateway.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.gateway.on_file.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| jit_funding.address_verification.gateway.on_file.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.gateway.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| jit_funding.address_verification.gateway.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| jit_funding.address_verification.gateway.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| jit_funding.address_verification.gateway.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| jit_funding.address_verification.issuer 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: on_file, response |
| jit_funding.address_verification.issuer.on_file object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| jit_funding.address_verification.issuer.on_file.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.issuer.on_file.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| jit_funding.address_verification.issuer.on_file.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.issuer.response object Conditionally returned | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| jit_funding.address_verification.issuer.response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| jit_funding.address_verification.issuer.response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| jit_funding.address_verification.issuer.response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| jit_funding.address_verification.request object Conditionally returned | Contains address verification information. Allowable Values: postal_code, street_address, zip |
| jit_funding.address_verification.request.postal_code string Conditionally returned | Postal code of the address. Allowable Values: 10 char max |
| jit_funding.address_verification.request.street_address string Conditionally returned | Street name and number of the address. Allowable Values: 40 char max |
| jit_funding.address_verification.request.zip string Conditionally returned | United States ZIP code of the address. Allowable Values: 10 char max |
| jit_funding.jit_account_name_verification object Conditionally returned | Contains account name verification data used to make JIT Funding decisions from one of the following objects: - The gateway object, which contains account name verification data from your JIT Funding gateway.- The issuer object, which contains account name verification data from the Marqeta platform.- The request object, which contains account name verification data as it appears in a JIT Funding request.Allowable Values: gateway, issuer, request |
| jit_funding.jit_account_name_verification.gateway object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| jit_funding.jit_account_name_verification.issuer object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| jit_funding.jit_account_name_verification.request object Conditionally returned | Contains account name verification data used to make JIT Funding decisions. Allowable Values: first_name, last_name, middle_name |
| jit_funding.amount decimal Returned | Requested amount of funding. Allowable Values: 0 min Format: 0.00 |
| jit_funding.balances object Conditionally returned | Contains the GPA’s balance details. Allowable Values: available_balance, balances, cached_balance, credit_balance, currency_code, impacted_amount, last_updated_time, ledger_balance, pending_credits |
| jit_funding.business_token string Conditionally returned | Holder of the business account that was funded. Allowable Values: 36 char max |
| jit_funding.decline_reason string Conditionally returned | Reason why the transaction was declined. Allowable Values: AMOUNT_LIMIT_EXCEEDED, BLOCKED_BY_CARDHOLDER, BLOCKED_BY_ISSUER, BLOCKED_MERCHANT_BY_CARDHOLDER, CARD_NOT_ACTIVE, CARDHOLDER_NOT_ACTIVE, CLOSED_ACCOUNT, DUPLICATE_TRANSACTION, EXPIRED_CARD, INSUFFICIENT_FUNDS, INVALID_AMOUNT, INVALID_CARD, INVALID_MERCHANT, NO_CHECKING_ACCOUNT, NO_CREDIT_ACCOUNT, NO_SAVINGS_ACCOUNT, REVOCATION_ALL_AUTHORIZATION_ORDER, REVOCATION_AUTHORIZATION_ORDER, SOFT_DECLINE_AUTHENTICATION_REQUIRED, SOFT_DECLINE_PIN_REQUIRED, STOP_PAYMENT, SUSPECTED_FRAUD, TRANSACTION_COUNT_LIMIT_EXCEEDED, TRANSACTION_NOT_PERMITTED |
| 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.adjustment.credit, pgfs.adjustment.debit, pgfs.authorization, pgfs.authorization.account_verification, pgfs.authorization.capture, pgfs.authorization.capture.chargeback, pgfs.authorization.capture.chargeback.reversal, pgfs.authorization.incremental, pgfs.authorization.reversal, pgfs.authorization.standin, pgfs.auth_plus_capture, pgfs.auth_plus_capture.standin, pgfs.balanceinquiry, pgfs.billpayment, pgfs.billpayment.capture, pgfs.billpayment.reversal, pgfs.directdeposit.credit, pgfs.directdeposit.credit.reversal, pgfs.directdeposit.debit, pgfs.directdeposit.debit.reversal, pgfs.dispute.credit, pgfs.dispute.debit, pgfs.force_capture, pgfs.network.load, pgfs.original.credit.authorization, pgfs.original.credit.auth_plus_capture, pgfs.pindebit.chargeback, pgfs.pindebit.chargeback.reversal, pgfs.product.inquiry, pgfs.refund, pgfs.refund.authorization, pgfs.refund.authorization.reversal |
| jit_funding.original_jit_funding_token string Conditionally returned | Unique identifier 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 tags related to 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 GPA order.NOTE: 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: datetime 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 | Response codes and memos for account name verification, address verification, card security verification, and transactions. Allowable Values: additional_information, code, memo |
| response.additional_information string Conditionally returned | Additional information about the transaction, such as velocity control details. This field is returned in transaction response objects only. It is not returned in address verification or card security verification response objects. Allowable Values: 255 char max |
| response.code string Returned | Four-digit response code for address verification, card security code verification, or transactions. For account name verification, the four digits correspond with assertions that the first, middle, last, and full name of the cardholder on the Marqeta platform match the data provided by the cardholder. - 0 indicates no validation was performed- 1 indicates the match was unsuccessful (not matched)- 2 indicates the match was partial- 3 indicates the match was exactFor example: Code / First Name / Middle Name / Last Name / Full Name 0000 / Not validated / Not validated / Not validated / Not validated1111 / Not matched / Not matched / Not matched / Not matched3333 / Exact match / Exact match / Exact match / Exact match1232 / Not matched / Partial match / Exact match / Partial matchFor address verification responses, the code is an assertion by the Marqeta platform as to whether its address verification data matches that provided by the cardholder: Code / Address / Postal Code 0000 / Match / Match0001 / Match / Not matched0100 / Not matched / Match0101 / Not matched / Not matched0200 / Data not present / Match0201 / Data not present / Not matched0002 / Match / Data not present0102 / Not matched / Data not present0303 / Not validated / Not validatedFor card security verification, the code indicates whether the verification check passed and can have these possible values: - 0000 – Passed- 0001 – Did not passFor a transaction, the code describes the outcome of the attempted transaction. For the full list of transaction codes, see Transaction response codes. Allowable Values: Four-digit code |
| response.memo string Returned | Additional text that describes the response. Allowable Values: 255 char max |
| state string Returned | Current status of the GPA unload order. Allowable Values: PENDING, CLEARED, COMPLETION, DECLINED, ERROR, REVERSED |
| tags string Conditionally returned | Comma-delimited list of tags describing the GPA order. Allowable Values: 255 char max |
| token string Returned | 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