/
10 minute read
August 10, 2022

Payment Sources

The Marqeta platform’s payment sources feature enables you to manage an external payment source that a credit account holder can use to make payments toward their account balance.

Create payment source

Action: POST
Endpoint: /credit/paymentsources

Create a payment source from which to make payments.

Request body
Fields Description

token

string
Optional

Unique identifier of the payment source.

Allowable Values:

36 char max

user_token

string
Required

Unique identifier of the user making the payment.

Allowable Values:

Existing user token

account_token

string
Required

Unique identifier of the credit account receiving the payment.

Allowable Values:

36 char max

Existing credit account token

source_type

string
Required

Type of payment source.

Allowable Values:

CHECKING, SAVINGS, OTHER

name

string
Required

Name of the individual or business who owns the payment source.

Allowable Values:

account_number

string
Required

Account number of the payment source.

Allowable Values:

routing_number

string
Required

Routing number of the payment source.

Allowable Values:

owner

string
Optional

Type of payment source owner.

Allowable Values:

INDIVIDUAL, BUSINESS

verification_override

boolean
Required

Whether to override the verification process.

Allowable Values:

verification_notes

string
Optional

Additional information on the verification.

Allowable Values:

Sample request body
JSON
Copied

Is this helpful?

Yes
No
Response body
Fields Description

token

string
Conditionally returned

Unique identifier of the payment source.

Allowable Values:

36 char max

account_token

string
Conditionally returned

Unique identifier of the credit account receiving the payment.

Allowable Values:

36 char max

Existing credit account token

user_token

string
Conditionally returned

Unique identifier of the user making the payment.

Allowable Values:

Existing user token

created_time

datetime
Conditionally returned

Date and time when the payment source was created on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

last_modified_time

datetime
Conditionally returned

Date and time when the payment source was last updated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

source_type

string
Conditionally returned

Type of payment source.

Allowable Values:

CHECKING, SAVINGS, OTHER

name

string
Conditionally returned

Name of the individual or business who owns the payment source.

Allowable Values:

owner

string
Conditionally returned

Type of payment source owner.

Allowable Values:

INDIVIDUAL, BUSINESS

verification_status

string
Conditionally returned

Status of the verification for the payment source.

Allowable Values:

ACH_VERIFIED, PENDING

verification_notes

string
Conditionally returned

Additional information on the verification (for example, an external verification identifier that’s outside the Marqeta platform).

Allowable Values:

account_number

string
Conditionally returned

Last four digits of the payment source account number.

NOTE: This field is a duplicate of account_suffix and will be removed in a future release.

Allowable Values:

4 char max

account_suffix

string
Conditionally returned

Last four digits of the payment source account number.

Allowable Values:

4 char max

routing_number

string
Conditionally returned

Routing number of the payment source.

Allowable Values:

status

string
Conditionally returned

Current status of the payment source.

Allowable Values:

ACTIVE, PENDING, INACTIVE

Sample response body
JSON
Copied

Is this helpful?

Yes
No

List payment sources

Action: GET
Endpoint: /credit/paymentsources

Retrieve an array of payment sources.

This endpoint supports sorting and pagination.

URL query parameters
Fields Description

account_token

string
Optional

The unique identifier of the credit account associated with the payment source.

Allowable Values:

user_token

string
Optional

The unique identifier of the user associated with the payment source.

Allowable Values:

count

integer
Optional

The number of resources to retrieve.

Allowable Values:

1–100

start_index

integer
Optional

The sort order index of the first resource in the returned array.

Allowable Values:

0 min

sort_by

string
Optional

Field on which to sort. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.

NOTE: You must sort using system field names such as lastModifiedTime, and not by the field names appearing in response bodies such as last_modified_time.

Allowable Values:

lastModifiedTime, -lastModifiedTime

Response body
Fields Description

count

integer
Returned

The number of resources returned.

Allowable Values:

start_index

integer
Returned

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

end_index

integer
Returned

The sort order index of the last resource in the returned array.

Allowable Values:

Any integer

is_more

boolean
Returned

A value of true indicates that more unreturned resources exist.

Allowable Values:

true, false

data

array of objects
Returned

List of payment sources.

Allowable Values:

data[].token

string
Conditionally returned

Unique identifier of the payment source.

Allowable Values:

36 char max

data[].account_token

string
Conditionally returned

Unique identifier of the credit account receiving the payment.

Allowable Values:

36 char max

Existing credit account token

data[].user_token

string
Conditionally returned

Unique identifier of the user making the payment.

Allowable Values:

Existing user token

data[].created_time

datetime
Conditionally returned

Date and time when the payment source was created on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

data[].last_modified_time

datetime
Conditionally returned

Date and time when the payment source was last updated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

data[].source_type

string
Conditionally returned

Type of payment source.

Allowable Values:

CHECKING, SAVINGS, OTHER

data[].name

string
Conditionally returned

Name of the individual or business who owns the payment source.

Allowable Values:

data[].owner

string
Conditionally returned

Type of payment source owner.

Allowable Values:

INDIVIDUAL, BUSINESS

data[].verification_status

string
Conditionally returned

Status of the verification for the payment source.

Allowable Values:

ACH_VERIFIED, PENDING

data[].verification_notes

string
Conditionally returned

Additional information on the verification (for example, an external verification identifier that’s outside the Marqeta platform).

Allowable Values:

data[].account_number

string
Conditionally returned

Last four digits of the payment source account number.

NOTE: This field is a duplicate of account_suffix and will be removed in a future release.

Allowable Values:

4 char max

data[].account_suffix

string
Conditionally returned

Last four digits of the payment source account number.

Allowable Values:

4 char max

data[].routing_number

string
Conditionally returned

Routing number of the payment source.

Allowable Values:

data[].status

string
Conditionally returned

Current status of the payment source.

Allowable Values:

ACTIVE, PENDING, INACTIVE

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Retrieve payment source

Action: GET
Endpoint: /credit/paymentsources/{token}

Retrieve a payment source.

URL path parameters
Fields Description

token

string
Required

The unique identifier of the payment source to retrieve.

Send a GET request to /credit/paymentsources to retrieve existing payment source tokens.

Allowable Values:

Response body
Fields Description

token

string
Conditionally returned

Unique identifier of the payment source.

Allowable Values:

36 char max

account_token

string
Conditionally returned

Unique identifier of the credit account receiving the payment.

Allowable Values:

36 char max

Existing credit account token

user_token

string
Conditionally returned

Unique identifier of the user making the payment.

Allowable Values:

Existing user token

created_time

datetime
Conditionally returned

Date and time when the payment source was created on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

last_modified_time

datetime
Conditionally returned

Date and time when the payment source was last updated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

source_type

string
Conditionally returned

Type of payment source.

Allowable Values:

CHECKING, SAVINGS, OTHER

name

string
Conditionally returned

Name of the individual or business who owns the payment source.

Allowable Values:

owner

string
Conditionally returned

Type of payment source owner.

Allowable Values:

INDIVIDUAL, BUSINESS

verification_status

string
Conditionally returned

Status of the verification for the payment source.

Allowable Values:

ACH_VERIFIED, PENDING

verification_notes

string
Conditionally returned

Additional information on the verification (for example, an external verification identifier that’s outside the Marqeta platform).

Allowable Values:

account_number

string
Conditionally returned

Last four digits of the payment source account number.

NOTE: This field is a duplicate of account_suffix and will be removed in a future release.

Allowable Values:

4 char max

account_suffix

string
Conditionally returned

Last four digits of the payment source account number.

Allowable Values:

4 char max

routing_number

string
Conditionally returned

Routing number of the payment source.

Allowable Values:

status

string
Conditionally returned

Current status of the payment source.

Allowable Values:

ACTIVE, PENDING, INACTIVE

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Update payment source

Action: PUT
Endpoint: /credit/paymentsources/{token}

Update details of a payment source.

URL path parameters
Fields Description

token

string
Required

The unique identifier of the payment source to retrieve.

Send a GET request to /credit/paymentsources to retrieve existing payment source tokens.

Allowable Values:

Request body
Fields Description

status

string
Required

Current status of the payment source.

Allowable Values:

ACTIVE, PENDING, INACTIVE

Sample request body
JSON
Copied

Is this helpful?

Yes
No
Response body
Fields Description

token

string
Conditionally returned

Unique identifier of the payment source.

Allowable Values:

36 char max

account_token

string
Conditionally returned

Unique identifier of the credit account receiving the payment.

Allowable Values:

36 char max

Existing credit account token

user_token

string
Conditionally returned

Unique identifier of the user making the payment.

Allowable Values:

Existing user token

created_time

datetime
Conditionally returned

Date and time when the payment source was created on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

last_modified_time

datetime
Conditionally returned

Date and time when the payment source was last updated on the Marqeta platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

source_type

string
Conditionally returned

Type of payment source.

Allowable Values:

CHECKING, SAVINGS, OTHER

name

string
Conditionally returned

Name of the individual or business who owns the payment source.

Allowable Values:

owner

string
Conditionally returned

Type of payment source owner.

Allowable Values:

INDIVIDUAL, BUSINESS

verification_status

string
Conditionally returned

Status of the verification for the payment source.

Allowable Values:

ACH_VERIFIED, PENDING

verification_notes

string
Conditionally returned

Additional information on the verification (for example, an external verification identifier that’s outside the Marqeta platform).

Allowable Values:

account_number

string
Conditionally returned

Last four digits of the payment source account number.

NOTE: This field is a duplicate of account_suffix and will be removed in a future release.

Allowable Values:

4 char max

account_suffix

string
Conditionally returned

Last four digits of the payment source account number.

Allowable Values:

4 char max

routing_number

string
Conditionally returned

Routing number of the payment source.

Allowable Values:

status

string
Conditionally returned

Current status of the payment source.

Allowable Values:

ACTIVE, PENDING, INACTIVE

Sample response body
JSON
Copied

Is this helpful?

Yes
No
Join our developer newsletter