GPA Orders
The /gpaorders
endpoint moves funds from a funding source into an
account holder’s general-purpose account (GPA).
GPA orders can also be used to move funds from an account holder’s funding source into your program’s fee account.
GPA orders can be funded by the account holder or your program.
Create GPA order
Copy section link
Action: POST
Endpoint: /gpaorders
Use this endpoint to create an order to fund an account holder’s GPA.
You can assess a fee while funding a GPA by using the optional fees
array to attach one or more fee resources to the GPA order.
When you create a GPA order, the GPA is first credited for the fees, then debited at funding time.
Request body
Copy section link
Fields | Description |
---|---|
amount
decimal
|
The amount to fund. Allowable Values: Format: 0.00 |
business_token
string
|
The unique identifier of the business. Pass either a Send a Allowable Values: 1–36 chars |
currency_code
string
|
The three-digit ISO 4217 currency code. Allowable Values: A valid three-digit ISO 4217 currency code |
fees
array of objects
|
List of fees associated with the funding transaction. Allowable Values: Existing |
fees[].memo
string
|
Additional text that describes the fee transfer. Allowable Values: 1–99 chars |
fees[].tags
string
|
Comma-delimited list of tags describing the fee. Allowable Values: 255 char max |
fees[].token
string
|
The unique identifier of the fee. Allowable Values: 1–36 chars Send a |
funding_source_address_token
string
|
Identifies the funding source address to use for this order.
If your funding source is an ACH account, then a funding source address is not required. If your funding source is a payment card, you must have at least one funding source address in order to create a GPA order.
Send a Allowable Values: 1–36 chars |
funding_source_token
string
|
Identifies the funding source to use for this order. You don’t have to supply a funding source token value in this call if you have a default funding source set up (verify the funding source’s Send a Allowable Values: 1–36 chars |
memo
string
|
Additional descriptive text. Allowable Values: 1–99 chars |
tags
string
|
Comma-delimited list of tags describing the order. Allowable Values: 1–255 chars |
token
string
|
The unique identifier of the GPA order. If you do not include a token, the system will generate one automatically. This token is necessary for use in other calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. Allowable Values: 1–36 chars |
user_token
string
|
The unique identifier of the user. Pass either a Send a Allowable Values: 1–36 chars |
Response body
Copy section link
Fields | Description |
---|---|
amount
decimal
|
The amount funded. Allowable Values: Format: 0.00 |
business_token
string
|
The unique identifier of the business. This field is returned if it exists in the resource. Allowable Values: Existing |
created_time
datetime
|
The date and time when the GPA order was created, in UTC.
Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
currency_code
string
|
The three-digit ISO 4217 currency code. Allowable Values: A valid three-digit ISO 4217 currency code |
fees
array of objects
|
List of fees associated with the funding transaction. This array is returned if it exists in the resource. Allowable Values: Existing |
fees[].fee
object
|
A Allowable Values: A valid |
fees[].fee.active
boolean
|
Indicates whether the fee is active. Allowable Values:
|
fees[].fee.amount
decimal
|
The amount of the fee. Allowable Values: Format: 0.00 |
fees[].fee.created_time
datetime
|
The date and time when the Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
fees[].fee.currency_code
string
|
The three-digit ISO 4217 currency code. Allowable Values: A valid three-digit ISO 4217 currency code |
fees[].fee.last_modified_time
datetime
|
The date and time when the Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
fees[].fee.name
string
|
The name of the Allowable Values: 50 char max |
fees[].fee.real_time_assessment
object
|
Controls the assessment of real-time fees. Allowable Values: A valid |
fees[].fee.real_time_assessment.domestic_enabled
boolean
|
Enables fee assessments where the origin of the transaction acquirer is inside the US. Allowable Values:
|
fees[].fee.real_time_assessment.international_enabled
boolean
|
Enables fee assessments where the origin of the transaction acquirer is outside the US. Allowable Values:
|
fees[].fee.real_time_assessment.transaction_type
string
|
Indicates the type of transactions on which the fee is assessed. Allowable Values:
|
fees[].fee.tags
string
|
Descriptive metadata about the fee. Allowable Values: 255 char max |
fees[].fee.token
string
|
The unique identifier of the fee. Allowable Values: 36 char max |
fees[].memo
string
|
Additional text that describes the fee transfer. Allowable Values: 1–99 chars |
fees[].tags
string
|
Comma-delimited list of tags describing the fee. Allowable Values: 255 char max |
fees[].token
string
|
The unique identifier of the fee. Allowable Values: 1–36 chars Send a |
fees[].transaction_token
string
|
Unique identifier of the transaction. Allowable Values: Format: UUID |
funding
object
|
Contains funding information for the transaction, including funding amount, type, and time. Allowable Values: A valid |
funding.amount
decimal
|
Amount of funds loaded into the GPA. Allowable Values: Format: 0.00 |
funding.gateway_log
object
|
Contains information from the Just-in-Time (JIT) Funding gateway in response to a funding request. Allowable Values: A valid |
funding.gateway_log.duration
integer
|
Length of time the gateway took to respond to a funding request. Allowable Values: Any integer |
funding.gateway_log.message
string
|
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:
|
funding.gateway_log.order_number
string
|
Customer order number, same value as Allowable Values: Existing |
funding.gateway_log.response
object
|
Contains information from the gateway in response to a funding request. Allowable Values: A valid |
funding.gateway_log.response.code
string
|
Code received from the gateway. Allowable Values: |
funding.gateway_log.response.data
object
|
Contains the gateway’s information about the JIT Funding transaction. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding
object
|
Contains the information about the JIT Funding load event, where funds are loaded into an account. Allowable Values: Existing |
funding.gateway_log.response.data.jit_funding.acting_user_token
string
|
User who conducted the transaction. Can be a child user configured to share its parent’s account balance. Allowable Values: 36 char max Existing user token matching the request. |
funding.gateway_log.response.data.jit_funding.address_verification
object
|
Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match. Allowable Values: Existing |
funding.gateway_log.response.data.jit_funding.address_verification.gateway
object
|
Contains funding source address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file
object
|
Contains address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
funding.gateway_log.response.data.jit_funding.address_verification.issuer
object
|
Contains funding source address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file
object
|
Contains address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
funding.gateway_log.response.data.jit_funding.address_verification.request
object
|
Contains address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.request.postal_code
string
|
Postal code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.request.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
funding.gateway_log.response.data.jit_funding.address_verification.request.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.amount
decimal
|
Requested amount of funding. Allowable Values: 0 min |
funding.gateway_log.response.data.jit_funding.balances
object
|
Contains the GPA’s balance details. Allowable Values: Existing |
funding.gateway_log.response.data.jit_funding.business_token
string
|
Holder of the business account that was funded. Allowable Values: 36 char max Existing |
funding.gateway_log.response.data.jit_funding.decline_reason
string
|
The reason the transaction was declined. Allowable Values:
|
funding.gateway_log.response.data.jit_funding.incremental_authorization_jit_funding_tokens
array of strings
|
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
|
Additional information that describes the JIT funding transaction. Allowable Values: 99 char max |
funding.gateway_log.response.data.jit_funding.method
string
|
JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method. Allowable Values:
|
funding.gateway_log.response.data.jit_funding.original_jit_funding_token
string
|
Token of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages. Allowable Values: 36 char max |
funding.gateway_log.response.data.jit_funding.tags
string
|
Customer-defined tag for the JIT funding transaction. Allowable Values: 255 char max |
funding.gateway_log.response.data.jit_funding.token
string
|
Existing JIT Funding token matching the Allowable Values: 36 char max |
funding.gateway_log.response.data.jit_funding.user_token
string
|
Holder of the user account that was funded. Allowable Values: 36 char max |
funding.gateway_log.timed_out
boolean
|
Whether the gateway sent a response ( Allowable Values:
|
funding.gateway_log.transaction_id
string
|
Customer-defined identifier for the transaction. Allowable Values: 255 char max |
funding.source
object
|
A program funding source represents a bank account from which funds are drawn for Managed Just-in-Time (JIT) Funding transactions. Allowable Values: A valid |
funding.source.active
boolean
|
Whether the funding source is active. Allowable Values:
|
funding.source.created_time
datetime
|
The date and time when the funding source was created, in UTC.
Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
funding.source.is_default_account
boolean
|
If there are multiple funding sources, this field specifies which source is used by default in funding calls. If there is only one funding source, the system ignores this field and always uses that source. Allowable Values:
|
funding.source.last_modified_time
datetime
|
The date and time when the funding source was last modified, in UTC.
Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
funding.source.token
string
|
The unique identifier of the funding source. Allowable Values: 36 char max |
funding.source.type
string
|
The type of account. Allowable Values: checking, savings |
funding.source_address
object
|
Contains information about the billing address of the funding source. Allowable Values: A valid |
funding.source_address.active
boolean
|
Whether the address is active. Allowable Values:
|
funding.source_address.address_1
string
|
Street address of the funding source. Allowable Values: 255 char max |
funding.source_address.address_2
string
|
Additional address information for the funding source. Allowable Values: 255 char max |
funding.source_address.business_token
string
|
Unique identifier of the business account holder associated with the address. Allowable Values: 1–36 chars |
funding.source_address.city
string
|
City of the funding source. Allowable Values: 40 char max |
funding.source_address.country
string
|
Country of the funding source. Allowable Values: 1–40 chars |
funding.source_address.created_time
datetime
|
Date and time when the address was created. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
funding.source_address.first_name
string
|
First name of the account holder associated with the funding source. Allowable Values: 40 char max |
funding.source_address.is_default_address
boolean
|
Whether this address is the default address used by the funding source. Allowable Values:
|
funding.source_address.last_modified_time
datetime
|
Date and time when the address was last modified. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
funding.source_address.last_name
string
|
Last name of the account holder associated with the funding source. Allowable Values: 40 char max |
funding.source_address.phone
string
|
Phone number of the funding source. Allowable Values: 255 char max |
funding.source_address.postal_code
string
|
Postal code of the funding source. Allowable Values: 10 char max |
funding.source_address.state
string
|
State of the funding source. Allowable Values: 2 char max |
funding.source_address.token
string
|
Unique identifier of the Allowable Values: 1–36 chars |
funding.source_address.user_token
string
|
Unique identifier of the user account holder associated with the address. Allowable Values: 1–36 chars |
funding.source_address.zip
string
|
United States ZIP code of the funding source. Allowable Values: 10 char max |
funding_source_address_token
string
|
Identifies the funding source address to use for this order. Allowable Values: Existing |
funding_source_token
string
|
Identifies the funding source to use for this order. Allowable Values: Existing |
gateway_message
string
|
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:
|
gateway_token
integer
|
Unique identifier of the JIT Funding request and response. This field is returned if it exists in the resource. Allowable Values: Existing |
jit_funding
object
|
Contains the information about the JIT Funding load event, where funds are loaded into an account. Allowable Values: Existing |
jit_funding.acting_user_token
string
|
User who conducted the transaction. Can be a child user configured to share its parent’s account balance. Allowable Values: 36 char max Existing user token matching the request. |
jit_funding.address_verification
object
|
Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match. Allowable Values: Existing |
jit_funding.address_verification.gateway
object
|
Contains funding source address verification information. Allowable Values: A valid |
jit_funding.address_verification.gateway.on_file
object
|
Contains address verification information. Allowable Values: A valid |
jit_funding.address_verification.gateway.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
jit_funding.address_verification.gateway.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
jit_funding.address_verification.gateway.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
jit_funding.address_verification.gateway.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
jit_funding.address_verification.gateway.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
jit_funding.address_verification.gateway.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
jit_funding.address_verification.gateway.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
jit_funding.address_verification.issuer
object
|
Contains funding source address verification information. Allowable Values: A valid |
jit_funding.address_verification.issuer.on_file
object
|
Contains address verification information. Allowable Values: A valid |
jit_funding.address_verification.issuer.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
jit_funding.address_verification.issuer.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
jit_funding.address_verification.issuer.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
jit_funding.address_verification.issuer.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
jit_funding.address_verification.issuer.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
jit_funding.address_verification.issuer.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
jit_funding.address_verification.issuer.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
jit_funding.address_verification.request
object
|
Contains address verification information. Allowable Values: A valid |
jit_funding.address_verification.request.postal_code
string
|
Postal code. Allowable Values: 10 char max |
jit_funding.address_verification.request.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
jit_funding.address_verification.request.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
jit_funding.amount
decimal
|
Requested amount of funding. Allowable Values: 0 min |
jit_funding.balances
object
|
Contains the GPA’s balance details. Allowable Values: Existing |
jit_funding.business_token
string
|
Holder of the business account that was funded. Allowable Values: 36 char max Existing |
jit_funding.decline_reason
string
|
The reason the transaction was declined. Allowable Values:
|
jit_funding.incremental_authorization_jit_funding_tokens
array of strings
|
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
|
Additional information that describes the JIT funding transaction. Allowable Values: 99 char max |
jit_funding.method
string
|
JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method. Allowable Values:
|
jit_funding.original_jit_funding_token
string
|
Token of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages. Allowable Values: 36 char max |
jit_funding.tags
string
|
Customer-defined tag for the JIT funding transaction. Allowable Values: 255 char max |
jit_funding.token
string
|
Existing JIT Funding token matching the Allowable Values: 36 char max |
jit_funding.user_token
string
|
Holder of the user account that was funded. Allowable Values: 36 char max |
last_modified_time
datetime
|
The date and time when the GPA order was last modified, in UTC.
Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
memo
string
|
Additional descriptive text. This field is returned if it exists in the resource. Allowable Values: 99 char max |
response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
state
string
|
Current status of the funding transaction. Allowable Values:
|
tags
string
|
Comma-delimited list of tags describing the order. This field is returned if it exists in the resource. Allowable Values: 255 char max |
token
string
|
The unique identifier of the GPA order. Allowable Values: 36 char max |
transaction_token
string
|
Unique identifier of the transaction being funded. Allowable Values: Format: UUID |
user_token
string
|
The unique identifier of the user. This field is returned if it exists in the resource. Allowable Values: Existing |
Retrieve GPA order
Copy section link
Action: GET
Endpoint: /gpaorders/{token}
Use this endpoint to retrieve a GPA order.
URL path parameters
Copy section link
Fields | Description |
---|---|
token
string
|
Existing GPA order token. Send a Allowable Values: |
Response body
Copy section link
Fields | Description |
---|---|
amount
decimal
|
The amount funded. Allowable Values: Format: 0.00 |
business_token
string
|
The unique identifier of the business. This field is returned if it exists in the resource. Allowable Values: Existing |
created_time
datetime
|
The date and time when the GPA order was created, in UTC.
Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
currency_code
string
|
The three-digit ISO 4217 currency code. Allowable Values: A valid three-digit ISO 4217 currency code |
fees
array of objects
|
List of fees associated with the funding transaction. This array is returned if it exists in the resource. Allowable Values: Existing |
fees[].fee
object
|
A Allowable Values: A valid |
fees[].fee.active
boolean
|
Indicates whether the fee is active. Allowable Values:
|
fees[].fee.amount
decimal
|
The amount of the fee. Allowable Values: Format: 0.00 |
fees[].fee.created_time
datetime
|
The date and time when the Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
fees[].fee.currency_code
string
|
The three-digit ISO 4217 currency code. Allowable Values: A valid three-digit ISO 4217 currency code |
fees[].fee.last_modified_time
datetime
|
The date and time when the Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
fees[].fee.name
string
|
The name of the Allowable Values: 50 char max |
fees[].fee.real_time_assessment
object
|
Controls the assessment of real-time fees. Allowable Values: A valid |
fees[].fee.real_time_assessment.domestic_enabled
boolean
|
Enables fee assessments where the origin of the transaction acquirer is inside the US. Allowable Values:
|
fees[].fee.real_time_assessment.international_enabled
boolean
|
Enables fee assessments where the origin of the transaction acquirer is outside the US. Allowable Values:
|
fees[].fee.real_time_assessment.transaction_type
string
|
Indicates the type of transactions on which the fee is assessed. Allowable Values:
|
fees[].fee.tags
string
|
Descriptive metadata about the fee. Allowable Values: 255 char max |
fees[].fee.token
string
|
The unique identifier of the fee. Allowable Values: 36 char max |
fees[].memo
string
|
Additional text that describes the fee transfer. Allowable Values: 1–99 chars |
fees[].tags
string
|
Comma-delimited list of tags describing the fee. Allowable Values: 255 char max |
fees[].token
string
|
The unique identifier of the fee. Allowable Values: 1–36 chars Send a |
fees[].transaction_token
string
|
Unique identifier of the transaction. Allowable Values: Format: UUID |
funding
object
|
Contains funding information for the transaction, including funding amount, type, and time. Allowable Values: A valid |
funding.amount
decimal
|
Amount of funds loaded into the GPA. Allowable Values: Format: 0.00 |
funding.gateway_log
object
|
Contains information from the Just-in-Time (JIT) Funding gateway in response to a funding request. Allowable Values: A valid |
funding.gateway_log.duration
integer
|
Length of time the gateway took to respond to a funding request. Allowable Values: Any integer |
funding.gateway_log.message
string
|
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:
|
funding.gateway_log.order_number
string
|
Customer order number, same value as Allowable Values: Existing |
funding.gateway_log.response
object
|
Contains information from the gateway in response to a funding request. Allowable Values: A valid |
funding.gateway_log.response.code
string
|
Code received from the gateway. Allowable Values: |
funding.gateway_log.response.data
object
|
Contains the gateway’s information about the JIT Funding transaction. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding
object
|
Contains the information about the JIT Funding load event, where funds are loaded into an account. Allowable Values: Existing |
funding.gateway_log.response.data.jit_funding.acting_user_token
string
|
User who conducted the transaction. Can be a child user configured to share its parent’s account balance. Allowable Values: 36 char max Existing user token matching the request. |
funding.gateway_log.response.data.jit_funding.address_verification
object
|
Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match. Allowable Values: Existing |
funding.gateway_log.response.data.jit_funding.address_verification.gateway
object
|
Contains funding source address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file
object
|
Contains address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
funding.gateway_log.response.data.jit_funding.address_verification.issuer
object
|
Contains funding source address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file
object
|
Contains address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
funding.gateway_log.response.data.jit_funding.address_verification.request
object
|
Contains address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.request.postal_code
string
|
Postal code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.request.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
funding.gateway_log.response.data.jit_funding.address_verification.request.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.amount
decimal
|
Requested amount of funding. Allowable Values: 0 min |
funding.gateway_log.response.data.jit_funding.balances
object
|
Contains the GPA’s balance details. Allowable Values: Existing |
funding.gateway_log.response.data.jit_funding.business_token
string
|
Holder of the business account that was funded. Allowable Values: 36 char max Existing |
funding.gateway_log.response.data.jit_funding.decline_reason
string
|
The reason the transaction was declined. Allowable Values:
|
funding.gateway_log.response.data.jit_funding.incremental_authorization_jit_funding_tokens
array of strings
|
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
|
Additional information that describes the JIT funding transaction. Allowable Values: 99 char max |
funding.gateway_log.response.data.jit_funding.method
string
|
JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method. Allowable Values:
|
funding.gateway_log.response.data.jit_funding.original_jit_funding_token
string
|
Token of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages. Allowable Values: 36 char max |
funding.gateway_log.response.data.jit_funding.tags
string
|
Customer-defined tag for the JIT funding transaction. Allowable Values: 255 char max |
funding.gateway_log.response.data.jit_funding.token
string
|
Existing JIT Funding token matching the Allowable Values: 36 char max |
funding.gateway_log.response.data.jit_funding.user_token
string
|
Holder of the user account that was funded. Allowable Values: 36 char max |
funding.gateway_log.timed_out
boolean
|
Whether the gateway sent a response ( Allowable Values:
|
funding.gateway_log.transaction_id
string
|
Customer-defined identifier for the transaction. Allowable Values: 255 char max |
funding.source
object
|
A program funding source represents a bank account from which funds are drawn for Managed Just-in-Time (JIT) Funding transactions. Allowable Values: A valid |
funding.source.active
boolean
|
Whether the funding source is active. Allowable Values:
|
funding.source.created_time
datetime
|
The date and time when the funding source was created, in UTC.
Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
funding.source.is_default_account
boolean
|
If there are multiple funding sources, this field specifies which source is used by default in funding calls. If there is only one funding source, the system ignores this field and always uses that source. Allowable Values:
|
funding.source.last_modified_time
datetime
|
The date and time when the funding source was last modified, in UTC.
Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
funding.source.token
string
|
The unique identifier of the funding source. Allowable Values: 36 char max |
funding.source.type
string
|
The type of account. Allowable Values: checking, savings |
funding.source_address
object
|
Contains information about the billing address of the funding source. Allowable Values: A valid |
funding.source_address.active
boolean
|
Whether the address is active. Allowable Values:
|
funding.source_address.address_1
string
|
Street address of the funding source. Allowable Values: 255 char max |
funding.source_address.address_2
string
|
Additional address information for the funding source. Allowable Values: 255 char max |
funding.source_address.business_token
string
|
Unique identifier of the business account holder associated with the address. Allowable Values: 1–36 chars |
funding.source_address.city
string
|
City of the funding source. Allowable Values: 40 char max |
funding.source_address.country
string
|
Country of the funding source. Allowable Values: 1–40 chars |
funding.source_address.created_time
datetime
|
Date and time when the address was created. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
funding.source_address.first_name
string
|
First name of the account holder associated with the funding source. Allowable Values: 40 char max |
funding.source_address.is_default_address
boolean
|
Whether this address is the default address used by the funding source. Allowable Values:
|
funding.source_address.last_modified_time
datetime
|
Date and time when the address was last modified. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
funding.source_address.last_name
string
|
Last name of the account holder associated with the funding source. Allowable Values: 40 char max |
funding.source_address.phone
string
|
Phone number of the funding source. Allowable Values: 255 char max |
funding.source_address.postal_code
string
|
Postal code of the funding source. Allowable Values: 10 char max |
funding.source_address.state
string
|
State of the funding source. Allowable Values: 2 char max |
funding.source_address.token
string
|
Unique identifier of the Allowable Values: 1–36 chars |
funding.source_address.user_token
string
|
Unique identifier of the user account holder associated with the address. Allowable Values: 1–36 chars |
funding.source_address.zip
string
|
United States ZIP code of the funding source. Allowable Values: 10 char max |
funding_source_address_token
string
|
Identifies the funding source address to use for this order. Allowable Values: Existing |
funding_source_token
string
|
Identifies the funding source to use for this order. Allowable Values: Existing |
gateway_message
string
|
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:
|
gateway_token
integer
|
Unique identifier of the JIT Funding request and response. This field is returned if it exists in the resource. Allowable Values: Existing |
jit_funding
object
|
Contains the information about the JIT Funding load event, where funds are loaded into an account. Allowable Values: Existing |
jit_funding.acting_user_token
string
|
User who conducted the transaction. Can be a child user configured to share its parent’s account balance. Allowable Values: 36 char max Existing user token matching the request. |
jit_funding.address_verification
object
|
Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match. Allowable Values: Existing |
jit_funding.address_verification.gateway
object
|
Contains funding source address verification information. Allowable Values: A valid |
jit_funding.address_verification.gateway.on_file
object
|
Contains address verification information. Allowable Values: A valid |
jit_funding.address_verification.gateway.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
jit_funding.address_verification.gateway.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
jit_funding.address_verification.gateway.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
jit_funding.address_verification.gateway.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
jit_funding.address_verification.gateway.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
jit_funding.address_verification.gateway.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
jit_funding.address_verification.gateway.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
jit_funding.address_verification.issuer
object
|
Contains funding source address verification information. Allowable Values: A valid |
jit_funding.address_verification.issuer.on_file
object
|
Contains address verification information. Allowable Values: A valid |
jit_funding.address_verification.issuer.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
jit_funding.address_verification.issuer.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
jit_funding.address_verification.issuer.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
jit_funding.address_verification.issuer.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
jit_funding.address_verification.issuer.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
jit_funding.address_verification.issuer.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
jit_funding.address_verification.issuer.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
jit_funding.address_verification.request
object
|
Contains address verification information. Allowable Values: A valid |
jit_funding.address_verification.request.postal_code
string
|
Postal code. Allowable Values: 10 char max |
jit_funding.address_verification.request.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
jit_funding.address_verification.request.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
jit_funding.amount
decimal
|
Requested amount of funding. Allowable Values: 0 min |
jit_funding.balances
object
|
Contains the GPA’s balance details. Allowable Values: Existing |
jit_funding.business_token
string
|
Holder of the business account that was funded. Allowable Values: 36 char max Existing |
jit_funding.decline_reason
string
|
The reason the transaction was declined. Allowable Values:
|
jit_funding.incremental_authorization_jit_funding_tokens
array of strings
|
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
|
Additional information that describes the JIT funding transaction. Allowable Values: 99 char max |
jit_funding.method
string
|
JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method. Allowable Values:
|
jit_funding.original_jit_funding_token
string
|
Token of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages. Allowable Values: 36 char max |
jit_funding.tags
string
|
Customer-defined tag for the JIT funding transaction. Allowable Values: 255 char max |
jit_funding.token
string
|
Existing JIT Funding token matching the Allowable Values: 36 char max |
jit_funding.user_token
string
|
Holder of the user account that was funded. Allowable Values: 36 char max |
last_modified_time
datetime
|
The date and time when the GPA order was last modified, in UTC.
Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
memo
string
|
Additional descriptive text. This field is returned if it exists in the resource. Allowable Values: 99 char max |
response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
state
string
|
Current status of the funding transaction. Allowable Values:
|
tags
string
|
Comma-delimited list of tags describing the order. This field is returned if it exists in the resource. Allowable Values: 255 char max |
token
string
|
The unique identifier of the GPA order. Allowable Values: 36 char max |
transaction_token
string
|
Unique identifier of the transaction being funded. Allowable Values: Format: UUID |
user_token
string
|
The unique identifier of the user. This field is returned if it exists in the resource. Allowable Values: Existing |
Create GPA unload
Copy section link
Action: POST
Endpoint: /gpaorders/unloads
Use this endpoint to unload a GPA order.
Unloading a GPA order returns funds to the funding source. A GPA unload must be tied to an original GPA order and can be used to return the amount of the original order or a lesser amount.
Request body
Copy section link
Fields | Description |
---|---|
amount
decimal
|
The amount of funds to unload (i.e., to return to the funding source). Allowable Values: Format: 0.00 |
funding_source_address_token
string
|
Identifies the funding source to use for this GPA unload order. Send a Allowable Values: 1–36 chars |
memo
string
|
Additional descriptive text about the GPA unload. Allowable Values: 99 char max |
original_order_token
string
|
Identifies the original GPA order. Allowable Values: 1–36 chars |
tags
string
|
Comma-delimited list of tags describing the GPA unload order. Allowable Values: 255 char max |
token
string
|
The unique identifier of the GPA unload order. If you do not include a token, the system will generate one automatically. This token is necessary for use in other calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated. Allowable Values: 1–36 chars |
Response body
Copy section link
Fields | Description |
---|---|
amount
decimal
|
The amount of funds unloaded (returned to funding source). Allowable Values: Format: 0.00 |
created_time
datetime
|
Date and time when the GPA unload order was created, in UTC. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
funding
object
|
Contains funding information for the transaction, including funding amount, type, and time. Allowable Values: A valid |
funding.amount
decimal
|
Amount of funds loaded into the GPA. Allowable Values: Format: 0.00 |
funding.gateway_log
object
|
Contains information from the Just-in-Time (JIT) Funding gateway in response to a funding request. Allowable Values: A valid |
funding.gateway_log.duration
integer
|
Length of time the gateway took to respond to a funding request. Allowable Values: Any integer |
funding.gateway_log.message
string
|
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:
|
funding.gateway_log.order_number
string
|
Customer order number, same value as Allowable Values: Existing |
funding.gateway_log.response
object
|
Contains information from the gateway in response to a funding request. Allowable Values: A valid |
funding.gateway_log.response.code
string
|
Code received from the gateway. Allowable Values: |
funding.gateway_log.response.data
object
|
Contains the gateway’s information about the JIT Funding transaction. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding
object
|
Contains the information about the JIT Funding load event, where funds are loaded into an account. Allowable Values: Existing |
funding.gateway_log.response.data.jit_funding.acting_user_token
string
|
User who conducted the transaction. Can be a child user configured to share its parent’s account balance. Allowable Values: 36 char max Existing user token matching the request. |
funding.gateway_log.response.data.jit_funding.address_verification
object
|
Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match. Allowable Values: Existing |
funding.gateway_log.response.data.jit_funding.address_verification.gateway
object
|
Contains funding source address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file
object
|
Contains address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
funding.gateway_log.response.data.jit_funding.address_verification.issuer
object
|
Contains funding source address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file
object
|
Contains address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
funding.gateway_log.response.data.jit_funding.address_verification.request
object
|
Contains address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.request.postal_code
string
|
Postal code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.request.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
funding.gateway_log.response.data.jit_funding.address_verification.request.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.amount
decimal
|
Requested amount of funding. Allowable Values: 0 min |
funding.gateway_log.response.data.jit_funding.balances
object
|
Contains the GPA’s balance details. Allowable Values: Existing |
funding.gateway_log.response.data.jit_funding.business_token
string
|
Holder of the business account that was funded. Allowable Values: 36 char max Existing |
funding.gateway_log.response.data.jit_funding.decline_reason
string
|
The reason the transaction was declined. Allowable Values:
|
funding.gateway_log.response.data.jit_funding.incremental_authorization_jit_funding_tokens
array of strings
|
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
|
Additional information that describes the JIT funding transaction. Allowable Values: 99 char max |
funding.gateway_log.response.data.jit_funding.method
string
|
JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method. Allowable Values:
|
funding.gateway_log.response.data.jit_funding.original_jit_funding_token
string
|
Token of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages. Allowable Values: 36 char max |
funding.gateway_log.response.data.jit_funding.tags
string
|
Customer-defined tag for the JIT funding transaction. Allowable Values: 255 char max |
funding.gateway_log.response.data.jit_funding.token
string
|
Existing JIT Funding token matching the Allowable Values: 36 char max |
funding.gateway_log.response.data.jit_funding.user_token
string
|
Holder of the user account that was funded. Allowable Values: 36 char max |
funding.gateway_log.timed_out
boolean
|
Whether the gateway sent a response ( Allowable Values:
|
funding.gateway_log.transaction_id
string
|
Customer-defined identifier for the transaction. Allowable Values: 255 char max |
funding.source
object
|
A program funding source represents a bank account from which funds are drawn for Managed Just-in-Time (JIT) Funding transactions. Allowable Values: A valid |
funding.source.active
boolean
|
Whether the funding source is active. Allowable Values:
|
funding.source.created_time
datetime
|
The date and time when the funding source was created, in UTC.
Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
funding.source.is_default_account
boolean
|
If there are multiple funding sources, this field specifies which source is used by default in funding calls. If there is only one funding source, the system ignores this field and always uses that source. Allowable Values:
|
funding.source.last_modified_time
datetime
|
The date and time when the funding source was last modified, in UTC.
Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
funding.source.token
string
|
The unique identifier of the funding source. Allowable Values: 36 char max |
funding.source.type
string
|
The type of account. Allowable Values: checking, savings |
funding.source_address
object
|
Contains information about the billing address of the funding source. Allowable Values: A valid |
funding.source_address.active
boolean
|
Whether the address is active. Allowable Values:
|
funding.source_address.address_1
string
|
Street address of the funding source. Allowable Values: 255 char max |
funding.source_address.address_2
string
|
Additional address information for the funding source. Allowable Values: 255 char max |
funding.source_address.business_token
string
|
Unique identifier of the business account holder associated with the address. Allowable Values: 1–36 chars |
funding.source_address.city
string
|
City of the funding source. Allowable Values: 40 char max |
funding.source_address.country
string
|
Country of the funding source. Allowable Values: 1–40 chars |
funding.source_address.created_time
datetime
|
Date and time when the address was created. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
funding.source_address.first_name
string
|
First name of the account holder associated with the funding source. Allowable Values: 40 char max |
funding.source_address.is_default_address
boolean
|
Whether this address is the default address used by the funding source. Allowable Values:
|
funding.source_address.last_modified_time
datetime
|
Date and time when the address was last modified. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
funding.source_address.last_name
string
|
Last name of the account holder associated with the funding source. Allowable Values: 40 char max |
funding.source_address.phone
string
|
Phone number of the funding source. Allowable Values: 255 char max |
funding.source_address.postal_code
string
|
Postal code of the funding source. Allowable Values: 10 char max |
funding.source_address.state
string
|
State of the funding source. Allowable Values: 2 char max |
funding.source_address.token
string
|
Unique identifier of the Allowable Values: 1–36 chars |
funding.source_address.user_token
string
|
Unique identifier of the user account holder associated with the address. Allowable Values: 1–36 chars |
funding.source_address.zip
string
|
United States ZIP code of the funding source. Allowable Values: 10 char max |
funding_source_address_token
string
|
Identifies the funding source used for this order. Allowable Values: Existing |
funding_source_token
string
|
Identifies the funding source used for this order. Allowable Values: Existing |
jit_funding
object
|
Contains the information about the JIT Funding load event, where funds are loaded into an account. Allowable Values: Existing |
jit_funding.acting_user_token
string
|
User who conducted the transaction. Can be a child user configured to share its parent’s account balance. Allowable Values: 36 char max Existing user token matching the request. |
jit_funding.address_verification
object
|
Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match. Allowable Values: Existing |
jit_funding.address_verification.gateway
object
|
Contains funding source address verification information. Allowable Values: A valid |
jit_funding.address_verification.gateway.on_file
object
|
Contains address verification information. Allowable Values: A valid |
jit_funding.address_verification.gateway.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
jit_funding.address_verification.gateway.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
jit_funding.address_verification.gateway.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
jit_funding.address_verification.gateway.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
jit_funding.address_verification.gateway.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
jit_funding.address_verification.gateway.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
jit_funding.address_verification.gateway.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
jit_funding.address_verification.issuer
object
|
Contains funding source address verification information. Allowable Values: A valid |
jit_funding.address_verification.issuer.on_file
object
|
Contains address verification information. Allowable Values: A valid |
jit_funding.address_verification.issuer.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
jit_funding.address_verification.issuer.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
jit_funding.address_verification.issuer.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
jit_funding.address_verification.issuer.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
jit_funding.address_verification.issuer.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
jit_funding.address_verification.issuer.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
jit_funding.address_verification.issuer.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
jit_funding.address_verification.request
object
|
Contains address verification information. Allowable Values: A valid |
jit_funding.address_verification.request.postal_code
string
|
Postal code. Allowable Values: 10 char max |
jit_funding.address_verification.request.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
jit_funding.address_verification.request.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
jit_funding.amount
decimal
|
Requested amount of funding. Allowable Values: 0 min |
jit_funding.balances
object
|
Contains the GPA’s balance details. Allowable Values: Existing |
jit_funding.business_token
string
|
Holder of the business account that was funded. Allowable Values: 36 char max Existing |
jit_funding.decline_reason
string
|
The reason the transaction was declined. Allowable Values:
|
jit_funding.incremental_authorization_jit_funding_tokens
array of strings
|
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
|
Additional information that describes the JIT funding transaction. Allowable Values: 99 char max |
jit_funding.method
string
|
JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method. Allowable Values:
|
jit_funding.original_jit_funding_token
string
|
Token of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages. Allowable Values: 36 char max |
jit_funding.tags
string
|
Customer-defined tag for the JIT funding transaction. Allowable Values: 255 char max |
jit_funding.token
string
|
Existing JIT Funding token matching the Allowable Values: 36 char max |
jit_funding.user_token
string
|
Holder of the user account that was funded. Allowable Values: 36 char max |
last_modified_time
datetime
|
Date and time when the GPA unload order was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
memo
string
|
Additional descriptive text. Allowable Values: 99 char max |
original_order_token
string
|
Identifies the original GPA order. Allowable Values: Existing GPA order token |
response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
state
string
|
Current status of the GPA unload order. Allowable Values:
|
tags
string
|
Comma-delimited list of tags describing the order. Allowable Values: 255 char max |
token
string
|
The unique identifier of the GPA unload order. Allowable Values: Existing GPA unload order token |
transaction_token
string
|
Unique identifier of the transaction. Allowable Values: Format: UUID |
List GPA unloads
Copy section link
Action: GET
Endpoint: /gpaorders/unloads
Use this endpoint to list all GPA unloads or GPA unloads associated with a specific user or business.
This endpoint supports field filtering and pagination.
URL query parameters
Copy section link
Fields | Description |
---|---|
count
integer
|
The number of resources to retrieve. Allowable Values: 1-10 |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
fields
string
|
Comma-delimited list of fields to return ( Allowable Values: A comma-delimited list of fields, or blank |
sort_by
string
|
Field on which to sort.
Use any field in the resource model, or one of the system fields Allowable Values:
|
user_token
string
|
The unique identifier of the user. Send a Allowable Values: Existing user token. |
business_token
string
|
The unique identifier of the business. Send a Allowable Values: Existing business token. |
original_order_token
string
|
The unique identifier of the original GPA order. Send a Allowable Values: Existing GPA order token. |
Response body
Copy section link
Fields | Description |
---|---|
count
integer
|
The number of resources to retrieve. Allowable Values: 1-10 |
data
array of objects
|
An array of GPA unload order objects. Allowable Values: A valid |
data[].amount
decimal
|
The amount of funds unloaded (returned to funding source). Allowable Values: Format: 0.00 |
data[].created_time
datetime
|
Date and time when the GPA unload order was created, in UTC. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
data[].funding
object
|
Contains funding information for the transaction, including funding amount, type, and time. Allowable Values: A valid |
data[].funding.amount
decimal
|
Amount of funds loaded into the GPA. Allowable Values: Format: 0.00 |
data[].funding.gateway_log
object
|
Contains information from the Just-in-Time (JIT) Funding gateway in response to a funding request. Allowable Values: A valid |
data[].funding.gateway_log.duration
integer
|
Length of time the gateway took to respond to a funding request. Allowable Values: Any integer |
data[].funding.gateway_log.message
string
|
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:
|
data[].funding.gateway_log.order_number
string
|
Customer order number, same value as Allowable Values: Existing |
data[].funding.gateway_log.response
object
|
Contains information from the gateway in response to a funding request. Allowable Values: A valid |
data[].funding.gateway_log.response.code
string
|
Code received from the gateway. Allowable Values: |
data[].funding.gateway_log.response.data
object
|
Contains the gateway’s information about the JIT Funding transaction. Allowable Values: A valid |
data[].funding.gateway_log.response.data.jit_funding
object
|
Contains the information about the JIT Funding load event, where funds are loaded into an account. Allowable Values: Existing |
data[].funding.gateway_log.response.data.jit_funding.acting_user_token
string
|
User who conducted the transaction. Can be a child user configured to share its parent’s account balance. Allowable Values: 36 char max Existing user token matching the request. |
data[].funding.gateway_log.response.data.jit_funding.address_verification
object
|
Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match. Allowable Values: Existing |
data[].funding.gateway_log.response.data.jit_funding.address_verification.gateway
object
|
Contains funding source address verification information. Allowable Values: A valid |
data[].funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file
object
|
Contains address verification information. Allowable Values: A valid |
data[].funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
data[].funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
data[].funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
data[].funding.gateway_log.response.data.jit_funding.address_verification.gateway.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
data[].funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
data[].funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
data[].funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
data[].funding.gateway_log.response.data.jit_funding.address_verification.issuer
object
|
Contains funding source address verification information. Allowable Values: A valid |
data[].funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file
object
|
Contains address verification information. Allowable Values: A valid |
data[].funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
data[].funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
data[].funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
data[].funding.gateway_log.response.data.jit_funding.address_verification.issuer.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
data[].funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
data[].funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
data[].funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
data[].funding.gateway_log.response.data.jit_funding.address_verification.request
object
|
Contains address verification information. Allowable Values: A valid |
data[].funding.gateway_log.response.data.jit_funding.address_verification.request.postal_code
string
|
Postal code. Allowable Values: 10 char max |
data[].funding.gateway_log.response.data.jit_funding.address_verification.request.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
data[].funding.gateway_log.response.data.jit_funding.address_verification.request.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
data[].funding.gateway_log.response.data.jit_funding.amount
decimal
|
Requested amount of funding. Allowable Values: 0 min |
data[].funding.gateway_log.response.data.jit_funding.balances
object
|
Contains the GPA’s balance details. Allowable Values: Existing |
data[].funding.gateway_log.response.data.jit_funding.business_token
string
|
Holder of the business account that was funded. Allowable Values: 36 char max Existing |
data[].funding.gateway_log.response.data.jit_funding.decline_reason
string
|
The reason the transaction was declined. Allowable Values:
|
data[].funding.gateway_log.response.data.jit_funding.incremental_authorization_jit_funding_tokens
array of strings
|
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
|
Additional information that describes the JIT funding transaction. Allowable Values: 99 char max |
data[].funding.gateway_log.response.data.jit_funding.method
string
|
JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method. Allowable Values:
|
data[].funding.gateway_log.response.data.jit_funding.original_jit_funding_token
string
|
Token of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages. Allowable Values: 36 char max |
data[].funding.gateway_log.response.data.jit_funding.tags
string
|
Customer-defined tag for the JIT funding transaction. Allowable Values: 255 char max |
data[].funding.gateway_log.response.data.jit_funding.token
string
|
Existing JIT Funding token matching the Allowable Values: 36 char max |
data[].funding.gateway_log.response.data.jit_funding.user_token
string
|
Holder of the user account that was funded. Allowable Values: 36 char max |
data[].funding.gateway_log.timed_out
boolean
|
Whether the gateway sent a response ( Allowable Values:
|
data[].funding.gateway_log.transaction_id
string
|
Customer-defined identifier for the transaction. Allowable Values: 255 char max |
data[].funding.source
object
|
A program funding source represents a bank account from which funds are drawn for Managed Just-in-Time (JIT) Funding transactions. Allowable Values: A valid |
data[].funding.source.active
boolean
|
Whether the funding source is active. Allowable Values:
|
data[].funding.source.created_time
datetime
|
The date and time when the funding source was created, in UTC.
Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
data[].funding.source.is_default_account
boolean
|
If there are multiple funding sources, this field specifies which source is used by default in funding calls. If there is only one funding source, the system ignores this field and always uses that source. Allowable Values:
|
data[].funding.source.last_modified_time
datetime
|
The date and time when the funding source was last modified, in UTC.
Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
data[].funding.source.token
string
|
The unique identifier of the funding source. Allowable Values: 36 char max |
data[].funding.source.type
string
|
The type of account. Allowable Values: checking, savings |
data[].funding.source_address
object
|
Contains information about the billing address of the funding source. Allowable Values: A valid |
data[].funding.source_address.active
boolean
|
Whether the address is active. Allowable Values:
|
data[].funding.source_address.address_1
string
|
Street address of the funding source. Allowable Values: 255 char max |
data[].funding.source_address.address_2
string
|
Additional address information for the funding source. Allowable Values: 255 char max |
data[].funding.source_address.business_token
string
|
Unique identifier of the business account holder associated with the address. Allowable Values: 1–36 chars |
data[].funding.source_address.city
string
|
City of the funding source. Allowable Values: 40 char max |
data[].funding.source_address.country
string
|
Country of the funding source. Allowable Values: 1–40 chars |
data[].funding.source_address.created_time
datetime
|
Date and time when the address was created. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
data[].funding.source_address.first_name
string
|
First name of the account holder associated with the funding source. Allowable Values: 40 char max |
data[].funding.source_address.is_default_address
boolean
|
Whether this address is the default address used by the funding source. Allowable Values:
|
data[].funding.source_address.last_modified_time
datetime
|
Date and time when the address was last modified. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
data[].funding.source_address.last_name
string
|
Last name of the account holder associated with the funding source. Allowable Values: 40 char max |
data[].funding.source_address.phone
string
|
Phone number of the funding source. Allowable Values: 255 char max |
data[].funding.source_address.postal_code
string
|
Postal code of the funding source. Allowable Values: 10 char max |
data[].funding.source_address.state
string
|
State of the funding source. Allowable Values: 2 char max |
data[].funding.source_address.token
string
|
Unique identifier of the Allowable Values: 1–36 chars |
data[].funding.source_address.user_token
string
|
Unique identifier of the user account holder associated with the address. Allowable Values: 1–36 chars |
data[].funding.source_address.zip
string
|
United States ZIP code of the funding source. Allowable Values: 10 char max |
data[].funding_source_address_token
string
|
Identifies the funding source used for this order. Allowable Values: Existing |
data[].funding_source_token
string
|
Identifies the funding source used for this order. Allowable Values: Existing |
data[].jit_funding
object
|
Contains the information about the JIT Funding load event, where funds are loaded into an account. Allowable Values: Existing |
data[].jit_funding.acting_user_token
string
|
User who conducted the transaction. Can be a child user configured to share its parent’s account balance. Allowable Values: 36 char max Existing user token matching the request. |
data[].jit_funding.address_verification
object
|
Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match. Allowable Values: Existing |
data[].jit_funding.address_verification.gateway
object
|
Contains funding source address verification information. Allowable Values: A valid |
data[].jit_funding.address_verification.gateway.on_file
object
|
Contains address verification information. Allowable Values: A valid |
data[].jit_funding.address_verification.gateway.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
data[].jit_funding.address_verification.gateway.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
data[].jit_funding.address_verification.gateway.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
data[].jit_funding.address_verification.gateway.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
data[].jit_funding.address_verification.gateway.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
data[].jit_funding.address_verification.gateway.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
data[].jit_funding.address_verification.gateway.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
data[].jit_funding.address_verification.issuer
object
|
Contains funding source address verification information. Allowable Values: A valid |
data[].jit_funding.address_verification.issuer.on_file
object
|
Contains address verification information. Allowable Values: A valid |
data[].jit_funding.address_verification.issuer.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
data[].jit_funding.address_verification.issuer.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
data[].jit_funding.address_verification.issuer.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
data[].jit_funding.address_verification.issuer.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
data[].jit_funding.address_verification.issuer.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
data[].jit_funding.address_verification.issuer.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
data[].jit_funding.address_verification.issuer.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
data[].jit_funding.address_verification.request
object
|
Contains address verification information. Allowable Values: A valid |
data[].jit_funding.address_verification.request.postal_code
string
|
Postal code. Allowable Values: 10 char max |
data[].jit_funding.address_verification.request.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
data[].jit_funding.address_verification.request.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
data[].jit_funding.amount
decimal
|
Requested amount of funding. Allowable Values: 0 min |
data[].jit_funding.balances
object
|
Contains the GPA’s balance details. Allowable Values: Existing |
data[].jit_funding.business_token
string
|
Holder of the business account that was funded. Allowable Values: 36 char max Existing |
data[].jit_funding.decline_reason
string
|
The reason the transaction was declined. Allowable Values:
|
data[].jit_funding.incremental_authorization_jit_funding_tokens
array of strings
|
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
|
Additional information that describes the JIT funding transaction. Allowable Values: 99 char max |
data[].jit_funding.method
string
|
JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method. Allowable Values:
|
data[].jit_funding.original_jit_funding_token
string
|
Token of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages. Allowable Values: 36 char max |
data[].jit_funding.tags
string
|
Customer-defined tag for the JIT funding transaction. Allowable Values: 255 char max |
data[].jit_funding.token
string
|
Existing JIT Funding token matching the Allowable Values: 36 char max |
data[].jit_funding.user_token
string
|
Holder of the user account that was funded. Allowable Values: 36 char max |
data[].last_modified_time
datetime
|
Date and time when the GPA unload order was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
data[].memo
string
|
Additional descriptive text. Allowable Values: 99 char max |
data[].original_order_token
string
|
Identifies the original GPA order. Allowable Values: Existing GPA order token |
data[].response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
data[].response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
data[].response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
data[].response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
data[].state
string
|
Current status of the GPA unload order. Allowable Values:
|
data[].tags
string
|
Comma-delimited list of tags describing the order. Allowable Values: 255 char max |
data[].token
string
|
The unique identifier of the GPA unload order. Allowable Values: Existing GPA unload order token |
data[].transaction_token
string
|
Unique identifier of the transaction. Allowable Values: Format: UUID |
end_index
integer
|
The sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
Retrieve GPA unload
Copy section link
Action: GET
Endpoint: /gpaorders/unloads/{unload_token}
Use this endpoint to retrieve a specific GPA unload.
URL path parameters
Copy section link
Fields | Description |
---|---|
unload_token
string
|
The unique identifier of the GPA unload. Allowable Values: Existing GPA unload token. |
Response body
Copy section link
Fields | Description |
---|---|
amount
decimal
|
The amount of funds unloaded (returned to funding source). Allowable Values: Format: 0.00 |
created_time
datetime
|
Date and time when the GPA unload order was created, in UTC. Allowable Values: Format: yyyy-MM-ddTHH:mm:ssZ |
funding
object
|
Contains funding information for the transaction, including funding amount, type, and time. Allowable Values: A valid |
funding.amount
decimal
|
Amount of funds loaded into the GPA. Allowable Values: Format: 0.00 |
funding.gateway_log
object
|
Contains information from the Just-in-Time (JIT) Funding gateway in response to a funding request. Allowable Values: A valid |
funding.gateway_log.duration
integer
|
Length of time the gateway took to respond to a funding request. Allowable Values: Any integer |
funding.gateway_log.message
string
|
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:
|
funding.gateway_log.order_number
string
|
Customer order number, same value as Allowable Values: Existing |
funding.gateway_log.response
object
|
Contains information from the gateway in response to a funding request. Allowable Values: A valid |
funding.gateway_log.response.code
string
|
Code received from the gateway. Allowable Values: |
funding.gateway_log.response.data
object
|
Contains the gateway’s information about the JIT Funding transaction. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding
object
|
Contains the information about the JIT Funding load event, where funds are loaded into an account. Allowable Values: Existing |
funding.gateway_log.response.data.jit_funding.acting_user_token
string
|
User who conducted the transaction. Can be a child user configured to share its parent’s account balance. Allowable Values: 36 char max Existing user token matching the request. |
funding.gateway_log.response.data.jit_funding.address_verification
object
|
Contains address verification data consisting of address data entered by the cardholder, address data held by the Marqeta platform, and an assertion by the Marqeta platform as to whether the two sets of data match. Allowable Values: Existing |
funding.gateway_log.response.data.jit_funding.address_verification.gateway
object
|
Contains funding source address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file
object
|
Contains address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
funding.gateway_log.response.data.jit_funding.address_verification.gateway.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
funding.gateway_log.response.data.jit_funding.address_verification.issuer
object
|
Contains funding source address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file
object
|
Contains address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.postal_code
string
|
Postal code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.on_file.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.response
object
|
Contains the Marqeta platform’s assertion as to whether its address verification data matches that provided by the cardholder. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.additional_information
string
|
Information about the relevant velocity control for the transaction, if applicable. Allowable Values: The Marqeta recommends that you name your velocity controls in a clearly descriptive way so that you can easily understand why a transaction was declined.
In the example given previously, the velocity control name |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.code
string
|
Four-digit code corresponding with the outcome of the attempted transaction type.
Allowable Values: Four digit code |
funding.gateway_log.response.data.jit_funding.address_verification.issuer.response.memo
string
|
Information on the outcome of the attempted transaction type. Allowable Values: 255 char max |
funding.gateway_log.response.data.jit_funding.address_verification.request
object
|
Contains address verification information. Allowable Values: A valid |
funding.gateway_log.response.data.jit_funding.address_verification.request.postal_code
string
|
Postal code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.address_verification.request.street_address
string
|
Street address provided by the cardholder. Allowable Values: 40 char max |
funding.gateway_log.response.data.jit_funding.address_verification.request.zip
string
|
United States ZIP code. Allowable Values: 10 char max |
funding.gateway_log.response.data.jit_funding.amount
decimal
|
Requested amount of funding. Allowable Values: 0 min |
funding.gateway_log.response.data.jit_funding.balances
object
|
Contains the GPA’s balance details. Allowable Values: Existing |
funding.gateway_log.response.data.jit_funding.business_token
string
|
Holder of the business account that was funded. Allowable Values: 36 char max Existing |
funding.gateway_log.response.data.jit_funding.decline_reason
string
|
The reason the transaction was declined. Allowable Values:
|
funding.gateway_log.response.data.jit_funding.incremental_authorization_jit_funding_tokens
array of strings
|
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
|
Additional information that describes the JIT funding transaction. Allowable Values: 99 char max |
funding.gateway_log.response.data.jit_funding.method
string
|
JIT Funding response type. See The jit_funding object for the purpose, funding event type, and description of each method. Allowable Values:
|
funding.gateway_log.response.data.jit_funding.original_jit_funding_token
string
|
Token of the first associated JIT Funding message. Useful for correlating related JIT Funding messages (that is, those associated with the same GPA order). Not included in the first of any set of related messages. Allowable Values: 36 char max |
funding.gateway_log.response.data.jit_funding.tags
string
|
Customer-defined tag for the JIT funding transaction. Allowable Values: 255 char max |
funding.gateway_log.response.data.jit_funding.token
string
|
Existing JIT Funding token matching the Allowable Values: 36 char max |
funding.gateway_log.response.data.jit_funding.user_token |