PUT///
Update an existing Credit Program Gateway.
You may want to update a Program Gateway if you are switching it to active or inactive, updating the URL, username, or password, and more.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | Unique identifier of the Program Gateway to update. Allowable Values: Existing Program Gateway token |
Request body
| Fields | Description |
|---|---|
| token string Optional | Unique identifier of the Program Gateway. Allowable Values: 36 char max |
| name string Optional | Name of the Program Gateway. Allowable Values: 255 char max |
| url string Optional | URL of the Program Gateway endpoint hosted in your environment and configured to receive authorization requests made by the Marqeta platform. Must be HTTPS. Allowable Values: 250 char max |
| basic_auth_username string Optional | Basic Authentication username for authenticating your environment. Allowable Values: 50 char max |
| basic_auth_password string Optional | Basic Authentication password for authenticating your environment. Allowable Values: 20–50 chars |
| timeout_millis integer Optional | Total timeout for Program Gateway calls, in milliseconds. Allowable Values: 2000 max |
| active boolean Optional | Indicates whether the Program Gateway is active. Allowable Values: true, false |
| mtls boolean Optional | Indicates whether the Program Gateway uses mutual Transport Layer Security (mTLS). Allowable Values: true, false |
| 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 Program Gateway 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 Example: json JSON lines wrap { "custom_header": { "customer_header_key_1": "customer_header_value_1", "customer_header_key_2": "customer_header_value_2", "customer_header_key_3": "customer_header_value_3" } } |
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the Program Gateway. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the Program Gateway. Allowable Values: 255 char max |
| url string Conditionally returned | URL of the Program Gateway endpoint hosted in your environment and configured to receive authorization requests made by the Marqeta platform. Allowable Values: 250 char max |
| basic_auth_username string Conditionally returned | Basic Authentication username for authenticating your environment. Allowable Values: 50 char max |
| basic_auth_password string Conditionally returned | Basic Authentication password for authenticating your environment. Allowable Values: 20–50 chars |
| timeout_millis integer Conditionally returned | Total timeout for Program Gateway calls, in milliseconds. Allowable Values: 2000 max |
| active boolean Conditionally returned | Indicates whether the Program Gateway is active. Allowable Values: true, false |
| custom_header object Conditionally returned | 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 |
| mtls boolean Conditionally returned | Indicates whether the Program Gateway uses mutual Transport Layer Security (mTLS). Allowable Values: true, false |
| created_time datetime Conditionally returned | Date and time when the Program Gateway was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| updated_time datetime Conditionally returned | Date and time when the Program Gateway was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |