Program Gateway Funding Sources
Use the /fundingsources/programgateway endpoint to create a program gateway funding source.
A program gateway funding source represents a bank account from which funds are drawn for Gateway Just-in-Time (JIT) Funding transactions. For more information about JIT Funding, see About Just-in-Time Funding.
In a sandbox environment, you can create a program gateway funding source that simulates funds for use in test transactions. In a production environment, you must work with a Marqeta representative to define the bank account from which the program gateway funding source draws funds.
Note
If you are using a third-party service to collect user funds, Marqeta and the issuing bank require specific reporting to ensure compliance with applicable rules and regulations. Contact Marqeta for more information.
Create program gateway source
Copy section link
Action: POST
Endpoint: /fundingsources/programgateway
Creates a program gateway funding source. A program gateway funding source is a transaction relay that, when configured, allows you to approve or decline transactions in real time.
Request body
Copy section link
| Fields | Description |
|---|---|
active
boolean
|
Indicates whether the program gateway funding source is active. Allowable Values:
Default value: |
basic_auth_password
string
|
Password for authenticating your environment. Allowable Values: 20–100 chars
|
basic_auth_username
string
|
Username for authenticating your environment. Allowable Values: 1–50 chars |
custom_header
object
|
Additional custom information included in the HTTP header. For example, this might contain security information, along with Basic Authentication, when making a JIT Funding request. Custom headers also appear in the associated webhook’s notifications. Allowable Values: Up to three name-value pairs: 500 char max per name, 500 char max per value |
name
string
|
The name of the program gateway funding source. Allowable Values: 1–50 chars |
timeout_millis
integer
|
Total timeout in milliseconds for gateway processing. Allowable Values: 1000–3000 Default value: |
token
string
|
The unique identifier of the program gateway funding source. If you do not include a token, the system will generate one automatically. As this token is necessary for use in other calls, we recommend that you define a simple and easy to remember string rather than letting the system generate a token for you. This value cannot be updated. Allowable Values: 1–36 chars |
url
string
|
The URL of the gateway endpoint hosted in your environment, to which Allowable Values: 250 char max Must be HTTPS |
use_mtls
boolean
|
Specifies whether or not to use mutual transport layer security (mTLS) authentication for the funding request. Allowable Values:
Default value: |
Response body
Copy section link
| Fields | Description |
|---|---|
account
string
|
The bank account number. Allowable Values: 36 char max |
active
boolean
|
Indicates whether the program gateway funding source is active. This field is returned if it exists in the resource. Allowable Values:
|
basic_auth_password
string
|
Password for authenticating your environment. Allowable Values: Existing |
basic_auth_username
string
|
Username for authenticating your environment. Allowable Values: Existing |
created_time
datetime
|
The date and time when the resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
custom_header
object
|
Additional custom information included in the HTTP header. Allowable Values: Up to three name-value pairs: 500 char max per name, 500 char max per value |
last_modified_time
datetime
|
The date and time when the resource was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
name
string
|
The name of the program gateway funding source. Allowable Values: 1–50 chars |
timeout_millis
integer
|
Total timeout in milliseconds for gateway processing. Allowable Values: 1000-3000 |
token
string
|
The unique identifier of the program gateway funding source. Allowable Values: 1–36 chars |
url
string
|
The URL of the gateway endpoint hosted in your environment, to which Allowable Values: Existing URL |
use_mtls
boolean
|
Specifies whether or not to use mutual transport layer security (mTLS) authentication for the funding request. Allowable Values:
|
version
string
|
The program gateway funding source object version. Allowable Values: 255 char max |
Update program gateway source custom headers
Copy section link
Action: PUT
Endpoint: /fundingsources/programgateway/customheaders/{token}
Adds or updates custom HTTP headers for a specific program gateway funding source.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the program gateway funding source. Allowable Values: Existing program gateway funding source token |
Request body
Copy section link
| Fields | Description |
|---|---|
custom_header
object
|
Additional custom information included in the HTTP header. For example, this might contain security information, along with Basic Authentication, when making a JIT Funding request. Custom headers also appear in the associated webhook’s notifications. Allowable Values: Up to three name-value pairs: 500 char max per name, 500 char max per value |
Response body
Copy section link
| Fields | Description |
|---|---|
account
string
|
The bank account number. Allowable Values: 36 char max |
active
boolean
|
Indicates whether the program gateway funding source is active. This field is returned if it exists in the resource. Allowable Values:
|
basic_auth_password
string
|
Password for authenticating your environment. Allowable Values: Existing |
basic_auth_username
string
|
Username for authenticating your environment. Allowable Values: Existing |
created_time
datetime
|
The date and time when the resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
custom_header
object
|
Additional custom information included in the HTTP header. Allowable Values: Up to three name-value pairs: 500 char max per name, 500 char max per value |
last_modified_time
datetime
|
The date and time when the resource was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
name
string
|
The name of the program gateway funding source. Allowable Values: 1–50 chars |
timeout_millis
integer
|
Total timeout in milliseconds for gateway processing. Allowable Values: 1000-3000 |
token
string
|
The unique identifier of the program gateway funding source. Allowable Values: 1–36 chars |
url
string
|
The URL of the gateway endpoint hosted in your environment, to which Allowable Values: Existing URL |
use_mtls
boolean
|
Specifies whether or not to use mutual transport layer security (mTLS) authentication for the funding request. Allowable Values:
|
version
string
|
The program gateway funding source object version. Allowable Values: 255 char max |
Retrieve program gateway source
Copy section link
Action: GET
Endpoint: /fundingsources/programgateway/{token}
Retrieves a specific program gateway funding source.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the program gateway funding source. Allowable Values: Existing program gateway funding source token |
Response body
Copy section link
| Fields | Description |
|---|---|
account
string
|
The bank account number. Allowable Values: 36 char max |
active
boolean
|
Indicates whether the program gateway funding source is active. This field is returned if it exists in the resource. Allowable Values:
|
basic_auth_password
string
|
Password for authenticating your environment. Allowable Values: Existing |
basic_auth_username
string
|
Username for authenticating your environment. Allowable Values: Existing |
created_time
datetime
|
The date and time when the resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
custom_header
object
|
Additional custom information included in the HTTP header. Allowable Values: Up to three name-value pairs: 500 char max per name, 500 char max per value |
last_modified_time
datetime
|
The date and time when the resource was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
name
string
|
The name of the program gateway funding source. Allowable Values: 1–50 chars |
timeout_millis
integer
|
Total timeout in milliseconds for gateway processing. Allowable Values: 1000-3000 |
token
string
|
The unique identifier of the program gateway funding source. Allowable Values: 1–36 chars |
url
string
|
The URL of the gateway endpoint hosted in your environment, to which Allowable Values: Existing URL |
use_mtls
boolean
|
Specifies whether or not to use mutual transport layer security (mTLS) authentication for the funding request. Allowable Values:
|
version
string
|
The program gateway funding source object version. Allowable Values: 255 char max |
Update program gateway source
Copy section link
Action: PUT
Endpoint: /fundingsources/programgateway/{token}
Updates a program gateway funding source. Only the values of parameters specified in the request are modified; all others are left unchanged.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the program gateway funding source. Allowable Values: Existing program gateway funding source token |
Request body
Copy section link
| Fields | Description |
|---|---|
active
boolean
|
Indicates whether the program gateway funding source is active. Allowable Values:
Default value: |
basic_auth_password
string
|
Password for authenticating your environment. Allowable Values: 20–100 chars
|
basic_auth_username
string
|
Username for authenticating your environment. Allowable Values: 1–50 chars |
custom_header
object
|
Additional custom information included in the HTTP header. For example, this might contain security information, along with Basic Authentication, when making a JIT Funding request. Custom headers also appear in the associated webhook’s notifications. Allowable Values: Up to three name-value pairs: 500 char max per name, 500 char max per value |
name
string
|
The name of the program gateway funding source. Allowable Values: 1–50 chars |
timeout_millis
integer
|
Total timeout in milliseconds for gateway processing. Allowable Values: 1000–3000 Default value: |
url
string
|
The URL of the gateway endpoint hosted in your environment, to which Allowable Values: 250 char max Must be HTTPS |
use_mtls
boolean
|
Specifies whether or not to use mutual transport layer security (mTLS) authentication for the funding request. Allowable Values:
Default value: |
Response body
Copy section link
| Fields | Description |
|---|---|
account
string
|
The bank account number. Allowable Values: 36 char max |
active
boolean
|
Indicates whether the program gateway funding source is active. This field is returned if it exists in the resource. Allowable Values:
|
basic_auth_password
string
|
Password for authenticating your environment. Allowable Values: Existing |
basic_auth_username
string
|
Username for authenticating your environment. Allowable Values: Existing |
created_time
datetime
|
The date and time when the resource was created, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
custom_header
object
|
Additional custom information included in the HTTP header. Allowable Values: Up to three name-value pairs: 500 char max per name, 500 char max per value |
last_modified_time
datetime
|
The date and time when the resource was last modified, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
name
string
|
The name of the program gateway funding source. Allowable Values: 1–50 chars |
timeout_millis
integer
|
Total timeout in milliseconds for gateway processing. Allowable Values: 1000-3000 |
token
string
|
The unique identifier of the program gateway funding source. Allowable Values: 1–36 chars |
url
string
|
The URL of the gateway endpoint hosted in your environment, to which Allowable Values: Existing URL |
use_mtls
boolean
|
Specifies whether or not to use mutual transport layer security (mTLS) authentication for the funding request. Allowable Values:
|
version
string
|
The program gateway funding source object version. Allowable Values: 255 char max |