Skip to main content
Hidden
Note
This feature is currently in limited-availability alpha and subject to change. To learn more about the alpha program for this feature, contact your Marqeta representative.
Bill Pay user endpoints.

​
Enroll User in Bill Pay

Action: POST
Endpoint: /users Enroll a user in Bill Pay by passing the user’s Marqeta token in a request to this endpoint.

​
Request body

FieldsDescription
user_token

string

Required		The unique identifier of the user resource.

Allowable Values:

​
Sample request body

JSON
{
  "user_token": "user-token"
}

​
Response body

FieldsDescription
user_token

string

Conditionally returned		The unique identifier of the user resource.

Allowable Values:
status

string

Conditionally returned		Status of the user in the Bill Pay service.

Allowable Values:

ACTIVE, INACTIVE, SUSPENDED
created_time

string

Conditionally returned		Date and time when the user originally enrolled in Bill Pay.

Allowable Values:
last_modified_time

string

Conditionally returned		Last time the user was modified within Bill Pay.

Allowable Values:

​
Sample response body

JSON
{
  "user_token": "user-token",
  "status": "ACTIVE",
  "created_time": "2019-08-24T14:15:22Z",
  "last_modified_time": "2019-08-24T14:15:22Z"
}

​
Get User

Action: GET
Endpoint: /users/{user_token} Get a user who has enrolled in Bill Pay.

​
URL path parameters

FieldsDescription
user_token

string

Required		Unique identifier of the user resource.

Allowable Values:

36 char max

​
Response body

FieldsDescription
user_token

string

Conditionally returned		The unique identifier of the user resource.

Allowable Values:
status

string

Conditionally returned		Status of the user in the Bill Pay service.

Allowable Values:

ACTIVE, INACTIVE, SUSPENDED
created_time

string

Conditionally returned		Date and time when the user originally enrolled in Bill Pay.

Allowable Values:
last_modified_time

string

Conditionally returned		Last time the user was modified within Bill Pay.

Allowable Values:

​
Sample response body

JSON
{
  "user_token": "user-token",
  "status": "ACTIVE",
  "created_time": "2019-08-24T14:15:22Z",
  "last_modified_time": "2019-08-24T14:15:22Z"
}

Related topics

Introduction to Bill PayBill PaymentsBillersPayeesPayments