/
15 minute read
March 24, 2022

Program Gateway Funding Sources

Hidden

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

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
Fields Description

active

boolean
Optional

Indicates whether the program gateway funding source is active.

Allowable Values:

true, false

Default value:
false

basic_auth_password

string
Required

Password for authenticating your environment.

Allowable Values:

20–100 chars

  • Must contain at least one numeral

  • Must contain at least one lowercase letter

  • Must contain at least one uppercase letter

  • Must contain at least one of these symbols: @ # $ % ! ^ & * ( ) \ _ + ~ ` - = [ ] { } , ; : ' " , . / < > ?

basic_auth_username

string
Required

Username for authenticating your environment.

Allowable Values:

1–50 chars

custom_header

object
Optional

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
Required

The name of the program gateway funding source.

Allowable Values:

1–50 chars

timeout_millis

integer
Optional

Total timeout in milliseconds for gateway processing.

Allowable Values:

1000–7000

Default value:
3000

token

string
Optional

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
Required

The URL of the gateway endpoint hosted in your environment, to which POST requests are submitted by the Marqeta platform.

Allowable Values:

250 char max

Must be HTTPS

use_mtls

boolean
Optional

Specifies whether or not to use mutual transport layer security (mTLS) authentication for the funding request.

Allowable Values:

true, false

Default value:
false

Sample request body
JSON
Copied

Is this helpful?

Yes
No
Response body
Fields Description

account

string
Returned

The bank account number.

Allowable Values:

36 char max

active

boolean
Conditionally returned

Indicates whether the program gateway funding source is active. This field is returned if it exists in the resource.

Allowable Values:

true, false

basic_auth_password

string
Returned

Password for authenticating your environment.

Allowable Values:

Existing basic_auth password

basic_auth_username

string
Returned

Username for authenticating your environment.

Allowable Values:

Existing basic_auth username

created_time

datetime
Returned

The date and time when the resource was created, in UTC. 2022-02-26T20:03:05Z, for example.

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

custom_header

object
Returned

Custom headers to be passed along with the request.

Allowable Values:

Existing custom headers

last_modified_time

datetime
Returned

The date and time when the resource was last modified, in UTC. 2022-02-26T20:03:05Z, for example.

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

name

string
Returned

The name of the program gateway funding source.

Allowable Values:

1–50 chars

timeout_millis

integer
Returned

Total timeout in milliseconds for gateway processing.

Allowable Values:

1000-7000

token

string
Returned

The unique identifier of the program gateway funding source.

Allowable Values:

1–36 chars

url

string
Returned

The URL of the gateway endpoint hosted in your environment, to which POST requests are submitted by the Marqeta platform.

Allowable Values:

Existing URL

use_mtls

boolean
Returned

Specifies whether or not to use mutual transport layer security (mTLS) authentication for the funding request.

Allowable Values:

true, false

version

string
Returned

The program gateway funding source object version.

Allowable Values:

255 char max

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Update program gateway source custom headers

Action: PUT
Endpoint: /fundingsources/programgateway/customheaders/{token}

Adds or updates custom HTTP headers for a specific program gateway funding source.

URL path parameters
Fields Description

token

string
Required

The unique identifier of the program gateway funding source.

Allowable Values:

Existing program gateway funding source token

Request body
Fields Description

custom_header

object
Optional

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

Sample request body
JSON
Copied

Is this helpful?

Yes
No
Response body
Fields Description

account

string
Returned

The bank account number.

Allowable Values:

36 char max

active

boolean
Conditionally returned

Indicates whether the program gateway funding source is active. This field is returned if it exists in the resource.

Allowable Values:

true, false

basic_auth_password

string
Returned

Password for authenticating your environment.

Allowable Values:

Existing basic_auth password

basic_auth_username

string
Returned

Username for authenticating your environment.

Allowable Values:

Existing basic_auth username

created_time

datetime
Returned

The date and time when the resource was created, in UTC. 2022-02-26T20:03:05Z, for example.

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

custom_header

object
Returned

Custom headers to be passed along with the request.

Allowable Values:

Existing custom headers

last_modified_time

datetime
Returned

The date and time when the resource was last modified, in UTC. 2022-02-26T20:03:05Z, for example.

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

name

string
Returned

The name of the program gateway funding source.

Allowable Values:

1–50 chars

timeout_millis

integer
Returned

Total timeout in milliseconds for gateway processing.

Allowable Values:

1000-7000

token

string
Returned

The unique identifier of the program gateway funding source.

Allowable Values:

1–36 chars

url

string
Returned

The URL of the gateway endpoint hosted in your environment, to which POST requests are submitted by the Marqeta platform.

Allowable Values:

Existing URL

use_mtls

boolean
Returned

Specifies whether or not to use mutual transport layer security (mTLS) authentication for the funding request.

Allowable Values:

true, false

version

string
Returned

The program gateway funding source object version.

Allowable Values:

255 char max

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Retrieve program gateway source

Action: GET
Endpoint: /fundingsources/programgateway/{token}

Retrieves a specific program gateway funding source.

URL path parameters
Fields Description

token

string
Required

The unique identifier of the program gateway funding source.

Allowable Values:

Existing program gateway funding source token

Response body
Fields Description

account

string
Returned

The bank account number.

Allowable Values:

36 char max

active

boolean
Conditionally returned

Indicates whether the program gateway funding source is active. This field is returned if it exists in the resource.

Allowable Values:

true, false

basic_auth_password

string
Returned

Password for authenticating your environment.

Allowable Values:

Existing basic_auth password

basic_auth_username

string
Returned

Username for authenticating your environment.

Allowable Values:

Existing basic_auth username

created_time

datetime
Returned

The date and time when the resource was created, in UTC. 2022-02-26T20:03:05Z, for example.

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

custom_header

object
Returned

Custom headers to be passed along with the request.

Allowable Values:

Existing custom headers

last_modified_time

datetime
Returned

The date and time when the resource was last modified, in UTC. 2022-02-26T20:03:05Z, for example.

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

name

string
Returned

The name of the program gateway funding source.

Allowable Values:

1–50 chars

timeout_millis

integer
Returned

Total timeout in milliseconds for gateway processing.

Allowable Values:

1000–7000

token

string
Returned

The unique identifier of the program gateway funding source.

Allowable Values:

1–36 chars

url

string
Returned

The URL of the gateway endpoint hosted in your environment, to which POST requests are submitted by the Marqeta platform.

Allowable Values:

Existing URL

use_mtls

boolean
Returned

Specifies whether or not to use mutual transport layer security (mTLS) authentication for the funding request.

Allowable Values:

true, false

version

string
Returned

The program gateway funding source object version.

Allowable Values:

255 char max

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Update program gateway source

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
Fields Description

token

string
Required

The unique identifier of the program gateway funding source.

Allowable Values:

Existing program gateway funding source token

Request body
Fields Description

active

boolean
Optional

Indicates whether the program gateway funding source is active.

Allowable Values:

true, false

Default value:
false

basic_auth_password

string
Required

Password for authenticating your environment.

Allowable Values:

20–100 chars

  • Must contain at least one numeral

  • Must contain at least one lowercase letter

  • Must contain at least one uppercase letter

  • Must contain at least one of these symbols: @ # $ % ! ^ & * ( ) \ _ + ~ ` - = [ ] { } , ; : ' " , . / < > ?

basic_auth_username

string
Required

Username for authenticating your environment.

Allowable Values:

1–50 chars

custom_header

object
Optional

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
Optional

The name of the program gateway funding source.

Allowable Values:

1–50 chars

timeout_millis

integer
Optional

Total timeout in milliseconds for gateway processing.

Allowable Values:

1000–7000

Default value:
3000

url

string
Required

The URL of the gateway endpoint hosted in your environment, to which POST requests are submitted by the Marqeta platform.

Allowable Values:

250 char max

Must be HTTPS

use_mtls

boolean
Optional

Specifies whether or not to use mutual transport layer security (mTLS) authentication for the funding request.

Allowable Values:

true, false

Default value:
false

Sample request body
JSON
Copied

Is this helpful?

Yes
No
Response body
Fields Description

account

string
Returned

The bank account number.

Allowable Values:

36 char max

active

boolean
Conditionally returned

Indicates whether the program gateway funding source is active. This field is returned if it exists in the resource.

Allowable Values:

true, false

basic_auth_password

string
Returned

Password for authenticating your environment.

Allowable Values:

Existing basic_auth password

basic_auth_username

string
Returned

Username for authenticating your environment.

Allowable Values:

Existing basic_auth username

created_time

datetime
Returned

The date and time when the resource was created, in UTC. 2022-02-26T20:03:05Z, for example.

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

custom_header

object
Returned

Custom headers to be passed along with the request.

Allowable Values:

Existing custom headers

last_modified_time

datetime
Returned

The date and time when the resource was last modified, in UTC. 2022-02-26T20:03:05Z, for example.

Allowable Values:

Format: yyyy-MM-ddTHH:mm:ssZ

name

string
Returned

The name of the program gateway funding source.

Allowable Values:

1–50 chars

timeout_millis

integer
Returned

Total timeout in milliseconds for gateway processing.

Allowable Values:

1000-7000

token

string
Returned

The unique identifier of the program gateway funding source.

Allowable Values:

1–36 chars

url

string
Returned

The URL of the gateway endpoint hosted in your environment, to which POST requests are submitted by the Marqeta platform.

Allowable Values:

Existing URL

use_mtls

boolean
Returned

Specifies whether or not to use mutual transport layer security (mTLS) authentication for the funding request.

Allowable Values:

true, false

version

string
Returned

The program gateway funding source object version.

Allowable Values:

255 char max

Sample response body
JSON
Copied

Is this helpful?

Yes
No
Join our developer newsletter