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
Copy section link
Action: POST
Endpoint: /credit/paymentsources
Create a payment source from which to make payments.
Request body
Copy section link
Fields | Description |
---|---|
token
string
|
Unique identifier of the payment source. Allowable Values: 36 char max |
user_token
string
|
Unique identifier of the user making the payment. Allowable Values: Existing user token |
account_token
string
|
Unique identifier of the credit account receiving the payment. Allowable Values: 36 char max Existing credit account token |
source_type
string
|
Type of payment source. Allowable Values:
|
name
string
|
Name of the individual or business who owns the payment source. Allowable Values: |
account_number
string
|
Account number of the payment source. Allowable Values: |
routing_number
string
|
Routing number of the payment source. Allowable Values: |
owner
string
|
Type of payment source owner. Allowable Values:
|
verification_override
boolean
|
Whether to override the verification process. Allowable Values: |
verification_notes
string
|
Additional information on the verification. Allowable Values: |
Response body
Copy section link
Fields | Description |
---|---|
token
string
|
Unique identifier of the payment source. Allowable Values: 36 char max |
account_token
string
|
Unique identifier of the credit account receiving the payment. Allowable Values: 36 char max Existing credit account token |
user_token
string
|
Unique identifier of the user making the payment. Allowable Values: Existing user token |
created_time
datetime
|
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
|
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
|
Type of payment source. Allowable Values:
|
name
string
|
Name of the individual or business who owns the payment source. Allowable Values: |
owner
string
|
Type of payment source owner. Allowable Values:
|
verification_status
string
|
Status of the verification for the payment source. Allowable Values:
|
verification_notes
string
|
Additional information on the verification (for example, an external verification identifier that’s outside the Marqeta platform). Allowable Values: |
account_number
string
|
Last four digits of the payment source account number. NOTE:
This field is a duplicate of Allowable Values: 4 char max |
account_suffix
string
|
Last four digits of the payment source account number. Allowable Values: 4 char max |
routing_number
string
|
Routing number of the payment source. Allowable Values: |
status
string
|
Current status of the payment source. Allowable Values:
|
List payment sources
Copy section link
Action: GET
Endpoint: /credit/paymentsources
Retrieve an array of payment sources.
This endpoint supports sorting and pagination.
URL query parameters
Copy section link
Fields | Description |
---|---|
account_token
string
|
The unique identifier of the credit account associated with the payment source. Allowable Values: |
user_token
string
|
The unique identifier of the user associated with the payment source. Allowable Values: |
count
integer
|
The number of resources to retrieve. Allowable Values: 1–100 |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: 0 min |
sort_by
string
|
Field on which to sort.
Prefix the field name with a hyphen ( NOTE:
You must sort using system field names such as Allowable Values:
|
Response body
Copy section link
Fields | Description |
---|---|
count
integer
|
The number of resources returned. Allowable Values: |
start_index
integer
|
The sort order index of the first resource in the returned array. Allowable Values: Any integer |
end_index
integer
|
The sort order index of the last resource in the returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of Allowable Values:
|
data
array of objects
|
List of payment sources. Allowable Values: |
data[].token
string
|
Unique identifier of the payment source. Allowable Values: 36 char max |
data[].account_token
string
|
Unique identifier of the credit account receiving the payment. Allowable Values: 36 char max Existing credit account token |
data[].user_token
string
|
Unique identifier of the user making the payment. Allowable Values: Existing user token |
data[].created_time
datetime
|
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
|
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
|
Type of payment source. Allowable Values:
|
data[].name
string
|
Name of the individual or business who owns the payment source. Allowable Values: |
data[].owner
string
|
Type of payment source owner. Allowable Values:
|
data[].verification_status
string
|
Status of the verification for the payment source. Allowable Values:
|
data[].verification_notes
string
|
Additional information on the verification (for example, an external verification identifier that’s outside the Marqeta platform). Allowable Values: |
data[].account_number
string
|
Last four digits of the payment source account number. NOTE:
This field is a duplicate of Allowable Values: 4 char max |
data[].account_suffix
string
|
Last four digits of the payment source account number. Allowable Values: 4 char max |
data[].routing_number
string
|
Routing number of the payment source. Allowable Values: |
data[].status
string
|
Current status of the payment source. Allowable Values:
|
Retrieve payment source
Copy section link
Action: GET
Endpoint: /credit/paymentsources/{token}
Retrieve a payment source.
URL path parameters
Copy section link
Fields | Description |
---|---|
token
string
|
The unique identifier of the payment source to retrieve. Send a Allowable Values: |
Response body
Copy section link
Fields | Description |
---|---|
token
string
|
Unique identifier of the payment source. Allowable Values: 36 char max |
account_token
string
|
Unique identifier of the credit account receiving the payment. Allowable Values: 36 char max Existing credit account token |
user_token
string
|
Unique identifier of the user making the payment. Allowable Values: Existing user token |
created_time
datetime
|
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
|
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
|
Type of payment source. Allowable Values:
|
name
string
|
Name of the individual or business who owns the payment source. Allowable Values: |
owner
string
|
Type of payment source owner. Allowable Values:
|
verification_status
string
|
Status of the verification for the payment source. Allowable Values:
|
verification_notes
string
|
Additional information on the verification (for example, an external verification identifier that’s outside the Marqeta platform). Allowable Values: |
account_number
string
|
Last four digits of the payment source account number. NOTE:
This field is a duplicate of Allowable Values: 4 char max |
account_suffix
string
|
Last four digits of the payment source account number. Allowable Values: 4 char max |
routing_number
string
|
Routing number of the payment source. Allowable Values: |
status
string
|
Current status of the payment source. Allowable Values:
|
Update payment source
Copy section link
Action: PUT
Endpoint: /credit/paymentsources/{token}
Update details of a payment source.
URL path parameters
Copy section link
Fields | Description |
---|---|
token
string
|
The unique identifier of the payment source to retrieve. Send a Allowable Values: |
Request body
Copy section link
Fields | Description |
---|---|
status
string
|
Current status of the payment source. Allowable Values:
|
Response body
Copy section link
Fields | Description |
---|---|
token
string
|
Unique identifier of the payment source. Allowable Values: 36 char max |
account_token
string
|
Unique identifier of the credit account receiving the payment. Allowable Values: 36 char max Existing credit account token |
user_token
string
|
Unique identifier of the user making the payment. Allowable Values: Existing user token |
created_time
datetime
|
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
|
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
|
Type of payment source. Allowable Values:
|
name
string
|
Name of the individual or business who owns the payment source. Allowable Values: |
owner
string
|
Type of payment source owner. Allowable Values:
|
verification_status
string
|
Status of the verification for the payment source. Allowable Values:
|
verification_notes
string
|
Additional information on the verification (for example, an external verification identifier that’s outside the Marqeta platform). Allowable Values: |
account_number
string
|
Last four digits of the payment source account number. NOTE:
This field is a duplicate of Allowable Values: 4 char max |
account_suffix
string
|
Last four digits of the payment source account number. Allowable Values: 4 char max |
routing_number
string
|
Routing number of the payment source. Allowable Values: |
status
string
|
Current status of the payment source. Allowable Values:
|