ACH Receiving

The Marqeta platform’s ACH Receiving feature (referred to herein as direct deposit) enables third parties to credit or debit the general purpose account (GPA) of a Marqeta account holder.

Retrieve direct deposit record

Action: GET
Endpoint: /directdeposits/{token} Retrieves a direct deposit record. Include the token path parameter to indicate the direct deposit record to retrieve. A direct deposit record stores the details corresponding to a single direct deposit action, such as the type (debit or credit), amount, and associated dates and times.

URL path parameters

Fields	Description
token string Required	Unique identifier of the direct deposit record to retrieve. Allowable Values: Existing direct deposit record token

Response body

Fields	Description
amount decimal Conditionally returned	Amount being debited or credited. Allowable Values: number Format: 0.00
business_token string Conditionally returned	Unique identifier of the business associated with the direct deposit record. Allowable Values: Existing business token
company_discretionary_data string Conditionally returned	Company-specific data provided by the direct deposit originator. Allowable Values: 20 char max
company_entry_description string Conditionally returned	Description of the purpose of the direct deposit. Allowable Values: 10 char max
company_identification string Conditionally returned	Alphanumeric code that identifies the direct deposit originator. Allowable Values: 10 char max
company_name string Conditionally returned	Name of the direct deposit originator. Allowable Values: 16 char max
created_time datetime Conditionally returned	Date and time when the direct deposit record was created. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ
direct_deposit_account_token string Conditionally returned	Unique identifier of the affected deposit account. Allowable Values: 36 char max
individual_identification_number string Conditionally returned	Accounting number by which the recipient is known to the direct deposit originator. Allowable Values: 15 or 22 char max, depending on the value of `standard_entry_class_code`
individual_name string Conditionally returned	Identity of the direct deposit recipient. Allowable Values: 22 char max
last_modified_time datetime Conditionally returned	Date and time when the direct deposit record was last updated. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ
settlement_date datetime Conditionally returned	Date and time when the credit or debit is applied. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ
standard_entry_class_code string Conditionally returned	Three-letter code identifying the type of entry. Allowable Values: `ACK`, `ADV`, `ARC`, `ATX`, `BOC`, `CCD`, `CIE`, `COR`, `CTX`, `DNE`, `ENR`, `IAT`, `MTE`, `POP`, `POS`, `PPD`, `RCK`, `SHR`, `TEL`, `TRC`, `TRX`, `WEB`, `XCK`
state string Conditionally returned	Current status of the direct deposit record. Allowable Values: `PENDING`, `APPLIED`, `REVERSED`, `REJECTED`
state_reason string Conditionally returned	Explanation of why the direct deposit record is in the current state. Allowable Values: 255 char max
state_reason_code string Conditionally returned	Standardized code describing the reason for the current state. Allowable Values: See ACHR return reason codes for the full list of supported codes and the grace period associated with each.
token string Conditionally returned	Unique identifier of the direct deposit record. Allowable Values: 36 char max
type string Conditionally returned	Whether funds are being debited from or credited to the account. Allowable Values: `CREDIT`, `DEBIT`
user_token string Conditionally returned	Unique identifier of the user or business associated with the direct deposit record. Allowable Values: Existing user token
trace_number string Conditionally returned	15-digit number used to track inbound and outbound ACH transfers. Allowable Values: 15 char max
early_direct_deposit string Conditionally returned	Boolean value that indicates whether this is a qualifying early pay transaction. If the early pay feature is not enabled for this program, this value will always be `false`. Allowable Values: `true`, `false`
originator_status_code string Conditionally returned	Numeric value that identifies the originator of the direct deposit record: - 1: Originator is not a US federal government entity. - 2: Originator is a US federal government entity, such as the IRS. Allowable Values: 1, 2

List direct deposit records

Action: GET
Endpoint: /directdeposits Return a list of direct deposits.

URL query parameters

Fields	Description
count integer Optional	Number of direct deposits to retrieve. Allowable Values: 100 max
user_token string Optional	Unique identifier of the user. Pass either a `user_token` or a `business_token`, not both. Send a `GET` request to `/users` to retrieve user tokens. Allowable Values: 1–36 chars
business_token string Optional	Unique identifier of the business. Pass either a `user_token` or a `business_token`, not both. Send a `GET` request to `/businesses` to retrieve business tokens. Allowable Values: 1–36 chars
direct_deposit_state string Optional	Direct deposit state. Allowable Values: `PENDING`, `REVERSED`, `APPLIED`, `REJECTED`
start_settlement_date string Optional	Beginning of the settlement date range from which to return direct deposit records. Allowable Values: string Format: yyyy-mm-dd
end_settlement_date string Optional	End of the settlement date range from which to return direct deposit records. Allowable Values: string Format: yyyy-mm-dd
start_index integer Optional	Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer
sort_by string Optional	Fields by which to sort. Use any fields in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix a field name with a hyphen ( `-` ) to sort in descending order. Omit the hyphen to sort in ascending order. Allowable Values: `createdTime`, `lastModifiedTime`, `settlementDate`

Response body

Fields	Description
count integer Conditionally returned	Number of direct deposit transitions to retrieve. Allowable Values: 100 max
data array of objects Conditionally returned	List of direct deposits. Allowable Values: 100 max
data[].amount decimal Conditionally returned	Amount being debited or credited. Allowable Values: number Format: 0.00
data[].business_token string Conditionally returned	Unique identifier of the business associated with the direct deposit record. Allowable Values: Existing business token
data[].company_discretionary_data string Conditionally returned	Company-specific data provided by the direct deposit originator. Allowable Values: 20 char max
data[].company_entry_description string Conditionally returned	Description of the purpose of the direct deposit. Allowable Values: 10 char max
data[].company_identification string Conditionally returned	Alphanumeric code that identifies the direct deposit originator. Allowable Values: 10 char max
data[].company_name string Conditionally returned	Name of the direct deposit originator. Allowable Values: 16 char max
data[].created_time datetime Conditionally returned	Date and time when the direct deposit record was created. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ
data[].direct_deposit_account_token string Conditionally returned	Unique identifier of the affected deposit account. Allowable Values: 36 char max
data[].individual_identification_number string Conditionally returned	Accounting number by which the recipient is known to the direct deposit originator. Allowable Values: 15 or 22 char max, depending on the value of `standard_entry_class_code`
data[].individual_name string Conditionally returned	Identity of the direct deposit recipient. Allowable Values: 22 char max
data[].last_modified_time datetime Conditionally returned	Date and time when the direct deposit record was last updated. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ
data[].settlement_date datetime Conditionally returned	Date and time when the credit or debit is applied. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ
data[].standard_entry_class_code string Conditionally returned	Three-letter code identifying the type of entry. Allowable Values: `ACK`, `ADV`, `ARC`, `ATX`, `BOC`, `CCD`, `CIE`, `COR`, `CTX`, `DNE`, `ENR`, `IAT`, `MTE`, `POP`, `POS`, `PPD`, `RCK`, `SHR`, `TEL`, `TRC`, `TRX`, `WEB`, `XCK`
data[].state string Conditionally returned	Current status of the direct deposit record. Allowable Values: `PENDING`, `APPLIED`, `REVERSED`, `REJECTED`
data[].state_reason string Conditionally returned	Explanation of why the direct deposit record is in the current state. Allowable Values: 255 char max
data[].state_reason_code string Conditionally returned	Standardized code describing the reason for the current state. Allowable Values: See ACHR return reason codes for the full list of supported codes and the grace period associated with each.
data[].token string Conditionally returned	Unique identifier of the direct deposit record. Allowable Values: 36 char max
data[].type string Conditionally returned	Whether funds are being debited from or credited to the account. Allowable Values: `CREDIT`, `DEBIT`
data[].user_token string Conditionally returned	Unique identifier of the user or business associated with the direct deposit record. Allowable Values: Existing user token
data[].trace_number string Conditionally returned	15-digit number used to track inbound and outbound ACH transfers. Allowable Values: 15 char max
data[].early_direct_deposit string Conditionally returned	Boolean value that indicates whether this is a qualifying early pay transaction. If the early pay feature is not enabled for this program, this value will always be `false`. Allowable Values: `true`, `false`
data[].originator_status_code string Conditionally returned	Numeric value that identifies the originator of the direct deposit record: - 1: Originator is not a US federal government entity. - 2: Originator is a US federal government entity, such as the IRS. Allowable Values: 1, 2
end_index integer Conditionally returned	Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer
is_more boolean Conditionally returned	A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. Allowable Values: `true`, `false`
start_index integer Conditionally returned	Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer

Create direct deposit transition

Action: POST
Endpoint: /directdeposits/transitions Create a direct deposit transition. Sending a POST request to this endpoint will initiate sending a Direct Deposit Transition webhook. For more information, see Direct Deposit Transition Events on the Event Types page.

Request body

Fields	Description
channel string Required	Mechanism by which the transaction was initiated. Allowable Values: `API`, `SYSTEM`, `PROD_SUPPORT`
direct_deposit_token string Required	Unique identifier of the direct deposit record. Allowable Values: 36 char max
reason string Required	Explanation of why the direct deposit transition record was created. Allowable Values: 255 char max
reason_code string Optional	A standard code describing the reason for the transition. NOTE: The reason code is optional when transitioning a direct deposit to the `APPLIED` state. It is required for the `REVERSED` state. Allowable Values: `R01`, `R02`, `R03`, `R04`, `R06`, `R07`, `R08`, `R09`, `R10`, `R11`, `R14`, `R15`, `R16`, `R17`, `R18`, `R20`, `R23`, `R24`, `R29` See ACHR return reason codes for the full list of supported codes and the grace period associated with each.
state string Required	The states for which to return transition records. To list transition records for more than one state, create a comma-delimited list. Allowable Values: `APPLIED`, `REVERSED`
token string Optional	Unique identifier of this direct deposit transition. If you do not include a token, the system generates one automatically. This token is used in other API calls, so rather than let the system generate a string, enter a string that you can remember. This value cannot be updated. Allowable Values: 36 char max

Response body

Fields	Description
channel string Conditionally returned	Mechanism by which the transaction was initiated. Allowable Values: `API`, `SYSTEM`, `PROD_SUPPORT`
token string Conditionally returned	Unique identifier of the direct deposit transition record. Allowable Values: 36 char max
reason string Conditionally returned	Explanation of why the direct deposit record is in the current state. Allowable Values: 255 char max
type string Conditionally returned	Whether funds are being debited from or credited to the account. Allowable Values: `CREDIT`, `DEBIT`
direct_deposit_token string Conditionally returned	Unique identifier of the direct deposit record. Allowable Values: 36 char max
transaction_token string Conditionally returned	Unique identifier of the transaction record. Allowable Values: 36 char max
state string Conditionally returned	Current status of the direct deposit record. Allowable Values: `PENDING`, `APPLIED`, `REVERSED`, `REJECTED`
created_time datetime Conditionally returned	Date and time when the direct deposit record was created. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ
direct_deposit_account_token string Conditionally returned	Unique identifier of the direct deposit account record. Allowable Values: 36 char max
last_modified_time datetime Conditionally returned	Date and time when the resource was last updated. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ
amount decimal Conditionally returned	Amount being debited or credited. Allowable Values: number Format: 0.00
settlement_date datetime Conditionally returned	Date when the credit or debit is applied. Allowable Values: datetime Format: yyyy-mm-ddThh:mm:ssZ
reason_code string Conditionally returned	Standardized code describing the reason for the current state. Allowable Values: See ACHR return reason codes for the full list of supported codes and the grace period associated with each.
user_token string Conditionally returned	Unique identifier of the user associated with the direct deposit record Allowable Values: Existing user token
business_token string Conditionally returned	Unique identifier of the business associated with the direct deposit record. Allowable Values: Existing business token
standard_entry_class_code string Conditionally returned	Three-letter code identifying the type of entry. Allowable Values: `ACK`, `ADV`, `ARC`, `ATX`, `BOC`, `CCD`, `CIE`, `COR`, `CTX`, `DNE`, `ENR`, `IAT`, `MTE`, `POP`, `POS`, `PPD`, `RCK`, `SHR`, `TEL`, `TRC`, `TRX`, `WEB`, `XCK`
company_name string Conditionally returned	Name of the direct deposit originator. Allowable Values: 16 char max
company_discretionary_data string Conditionally returned	Company-specific data provided by the direct deposit originator. Allowable Values: 20 char max
company_identification string Conditionally returned	Alphanumeric code that identifies the direct deposit originator. Allowable Values: 10 char max
company_entry_description string Conditionally returned	Description of the purpose of the direct deposit. Allowable Values: 10 char max
individual_identification_number string Conditionally returned	Accounting number by which the recipient is known to the direct deposit originator. Allowable Values: 15 or 22 char max, depending on the value of `standard_entry_class_code`
individual_name string Conditionally returned	Identity of the direct deposit recipient. Allowable Values: 22 char max
trace_number string Conditionally returned	15-digit number used to track inbound and outbound ACH transfers. Allowable Values: 15 char max
early_direct_deposit string Conditionally returned	Boolean value that indicates whether this is a qualifying early pay transaction. If the early pay feature is not enabled for this program, this value will always be `false`. Allowable Values: `true`, `false`
originator_status_code string Conditionally returned	Numeric value that identifies the originator of the direct deposit record: - 1: Originator is not a US federal government entity. - 2: Originator is a US federal government entity, such as the IRS. Allowable Values: 1, 2

List direct deposit transitions

Action: GET
Endpoint: /directdeposits/transitions Retrieve a list of direct deposit transition records.

URL query parameters

Fields	Description
count integer Optional	Number of direct deposit transitions to retrieve. Allowable Values: 100 max
user_token string Optional	Unique identifier of the user. Pass either a `user_token` or a `business_token`, not both. Send a `GET` request to `/users` to retrieve user tokens. Allowable Values: Existing user token
business_token string Optional	Unique identifier of the business. Pass either a `business_token` or a `user_token`, not both. Send a `GET` request to `/businesses` to retrieve business tokens. Allowable Values: Existing business token
direct_deposit_token string Optional	Direct deposit credit or debit for which to return transition records. Allowable Values: Existing direct deposit record token
start_index integer Optional	Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer
sort_by string Optional	Fields by which to sort. Use any fields in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`. Prefix a field name with a hyphen ( `-` ) to sort in descending order. Omit the hyphen to sort in ascending order. Allowable Values: `createdTime`, `lastModifiedTime`

Response body

Fields	Description
count integer Conditionally returned	The number of resources returned. Allowable Values: 0–100
data array of objects Conditionally returned	List of direct deposit transitions. Allowable Values: 100 max
data[].channel string Conditionally returned	Mechanism by which the transaction was initiated. Allowable Values: `API`, `SYSTEM`, `PROD_SUPPORT`
data[].token string Conditionally returned	Unique identifier of the direct deposit transition record. Allowable Values: 36 char max
data[].reason string Conditionally returned	Explanation of why the direct deposit record is in the current state. Allowable Values: 255 char max
data[].type string Conditionally returned	Whether funds are being debited from or credited to the account. Allowable Values: `CREDIT`, `DEBIT`
data[].direct_deposit_token string Conditionally returned	Unique identifier of the direct deposit record. Allowable Values: 36 char max
data[].transaction_token string Conditionally returned	Unique identifier of the transaction record. Allowable Values: 36 char max
data[].state string Conditionally returned	Current status of the direct deposit record. Allowable Values: `PENDING`, `APPLIED`, `REVERSED`, `REJECTED`
data[].created_time datetime Conditionally returned	Date and time when the direct deposit record was created. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ
data[].direct_deposit_account_token string Conditionally returned	Unique identifier of the direct deposit account record. Allowable Values: 36 char max
data[].last_modified_time datetime Conditionally returned	Date and time when the resource was last updated. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ
data[].amount decimal Conditionally returned	Amount being debited or credited. Allowable Values: number Format: 0.00
data[].settlement_date datetime Conditionally returned	Date when the credit or debit is applied. Allowable Values: datetime Format: yyyy-mm-ddThh:mm:ssZ
data[].reason_code string Conditionally returned	Standardized code describing the reason for the current state. Allowable Values: See ACHR return reason codes for the full list of supported codes and the grace period associated with each.
data[].user_token string Conditionally returned	Unique identifier of the user associated with the direct deposit record Allowable Values: Existing user token
data[].business_token string Conditionally returned	Unique identifier of the business associated with the direct deposit record. Allowable Values: Existing business token
data[].standard_entry_class_code string Conditionally returned	Three-letter code identifying the type of entry. Allowable Values: `ACK`, `ADV`, `ARC`, `ATX`, `BOC`, `CCD`, `CIE`, `COR`, `CTX`, `DNE`, `ENR`, `IAT`, `MTE`, `POP`, `POS`, `PPD`, `RCK`, `SHR`, `TEL`, `TRC`, `TRX`, `WEB`, `XCK`
data[].company_name string Conditionally returned	Name of the direct deposit originator. Allowable Values: 16 char max
data[].company_discretionary_data string Conditionally returned	Company-specific data provided by the direct deposit originator. Allowable Values: 20 char max
data[].company_identification string Conditionally returned	Alphanumeric code that identifies the direct deposit originator. Allowable Values: 10 char max
data[].company_entry_description string Conditionally returned	Description of the purpose of the direct deposit. Allowable Values: 10 char max
data[].individual_identification_number string Conditionally returned	Accounting number by which the recipient is known to the direct deposit originator. Allowable Values: 15 or 22 char max, depending on the value of `standard_entry_class_code`
data[].individual_name string Conditionally returned	Identity of the direct deposit recipient. Allowable Values: 22 char max
data[].trace_number string Conditionally returned	15-digit number used to track inbound and outbound ACH transfers. Allowable Values: 15 char max
data[].early_direct_deposit string Conditionally returned	Boolean value that indicates whether this is a qualifying early pay transaction. If the early pay feature is not enabled for this program, this value will always be `false`. Allowable Values: `true`, `false`
data[].originator_status_code string Conditionally returned	Numeric value that identifies the originator of the direct deposit record: - 1: Originator is not a US federal government entity. - 2: Originator is a US federal government entity, such as the IRS. Allowable Values: 1, 2
end_index integer Conditionally returned	Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer
is_more boolean Conditionally returned	A value of `true` indicates that more unreturned resources exist. A value of `false` indicates that no more unreturned resources exist. This field is returned if there are resources in your returned array. Allowable Values: `true`, `false`
start_index integer Conditionally returned	Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer

Retrieve direct deposit transition

Action: GET
Endpoint: /directdeposits/transitions/{token} Retrieve a direct deposit transition. Include the token path parameter to specify the record to return.

URL path parameters

Fields	Description
token string Required	Identifies the direct deposit transition record to retrieve. Allowable Values: Existing direct deposit transition token

Response body

Fields	Description
channel string Conditionally returned	Mechanism by which the transaction was initiated. Allowable Values: `API`, `SYSTEM`, `PROD_SUPPORT`
token string Conditionally returned	Unique identifier of the direct deposit transition record. Allowable Values: 36 char max
reason string Conditionally returned	Explanation of why the direct deposit record is in the current state. Allowable Values: 255 char max
type string Conditionally returned	Whether funds are being debited from or credited to the account. Allowable Values: `CREDIT`, `DEBIT`
direct_deposit_token string Conditionally returned	Unique identifier of the direct deposit record. Allowable Values: 36 char max
transaction_token string Conditionally returned	Unique identifier of the transaction record. Allowable Values: 36 char max
state string Conditionally returned	Current status of the direct deposit record. Allowable Values: `PENDING`, `APPLIED`, `REVERSED`, `REJECTED`
created_time datetime Conditionally returned	Date and time when the direct deposit record was created. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ
direct_deposit_account_token string Conditionally returned	Unique identifier of the direct deposit account record. Allowable Values: 36 char max
last_modified_time datetime Conditionally returned	Date and time when the resource was last updated. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ
amount decimal Conditionally returned	Amount being debited or credited. Allowable Values: number Format: 0.00
settlement_date datetime Conditionally returned	Date when the credit or debit is applied. Allowable Values: datetime Format: yyyy-mm-ddThh:mm:ssZ
reason_code string Conditionally returned	Standardized code describing the reason for the current state. Allowable Values: See ACHR return reason codes for the full list of supported codes and the grace period associated with each.
user_token string Conditionally returned	Unique identifier of the user associated with the direct deposit record Allowable Values: Existing user token
business_token string Conditionally returned	Unique identifier of the business associated with the direct deposit record. Allowable Values: Existing business token
standard_entry_class_code string Conditionally returned	Three-letter code identifying the type of entry. Allowable Values: `ACK`, `ADV`, `ARC`, `ATX`, `BOC`, `CCD`, `CIE`, `COR`, `CTX`, `DNE`, `ENR`, `IAT`, `MTE`, `POP`, `POS`, `PPD`, `RCK`, `SHR`, `TEL`, `TRC`, `TRX`, `WEB`, `XCK`
company_name string Conditionally returned	Name of the direct deposit originator. Allowable Values: 16 char max
company_discretionary_data string Conditionally returned	Company-specific data provided by the direct deposit originator. Allowable Values: 20 char max
company_identification string Conditionally returned	Alphanumeric code that identifies the direct deposit originator. Allowable Values: 10 char max
company_entry_description string Conditionally returned	Description of the purpose of the direct deposit. Allowable Values: 10 char max
individual_identification_number string Conditionally returned	Accounting number by which the recipient is known to the direct deposit originator. Allowable Values: 15 or 22 char max, depending on the value of `standard_entry_class_code`
individual_name string Conditionally returned	Identity of the direct deposit recipient. Allowable Values: 22 char max
trace_number string Conditionally returned	15-digit number used to track inbound and outbound ACH transfers. Allowable Values: 15 char max
early_direct_deposit string Conditionally returned	Boolean value that indicates whether this is a qualifying early pay transaction. If the early pay feature is not enabled for this program, this value will always be `false`. Allowable Values: `true`, `false`
originator_status_code string Conditionally returned	Numeric value that identifies the originator of the direct deposit record: - 1: Originator is not a US federal government entity. - 2: Originator is a US federal government entity, such as the IRS. Allowable Values: 1, 2

Create stop payment order

Action: POST
Endpoint: /directdeposits/stop-payment Send a POST request to the /directdeposits/stop-payment endpoint to create a stop payment order when your cardholder wants to halt a future payment. By creating a stop payment order, future matching transactions will be automatically declined by the Marqeta platform, with STOP_PAYMENT given as the decline reason in the transaction authorization.

Request body

Fields	Description
token string Required	Unique identifier for each stop payment order. This value is not present in the direct deposit transition webhook. Allowable Values: 36 char max
ddaToken string Required	Unique identifier for the account in the system. This value is referred to as the `direct_deposit_account_token` in the direct deposit transition webhook. Allowable Values: 36 char max
amount decimal Optional	Amount of the stop payment order. This value is referred to as the `amount` in the direct deposit transition webhook. Allowable Values: decimal Format: 0.00
companyId string Required	Alphanumeric code that identifies the direct deposit originator. This value is referred to as the `company_identification` in the direct deposit transition webhook. Allowable Values: 10 char max
companyName string Optional	Name of the direct deposit originator. This value is referred to as the `company_name` in the direct deposit transition webhook. Allowable Values: 16 char max
withdrawOrder boolean Optional	Flag indicating whether the stop payment order is withdrawn. This value is not present in the direct deposit transition webhook. Allowable Values: `true`, `false`

Sample request body

JSON

{
  "token": "00acce2b-cefg-45ab-8417-f8a62326c0d6",
  "ddaToken" : "d5bd5921-048a-44c1-ba48-fe8ee0418f2d",
  "amount": "50.75",
  "companyId": "9876543210",
  "companyName": "Friendship Inc.",
  "withdrawOrder": false
}

Response body

Fields	Description
token string Conditionally returned	Unique identifier for each stop payment order. Allowable Values: 36 char max
ddaToken string Returned	Unique identifier for the account in the system. Allowable Values: 36 char max
amount decimal Conditionally returned	Amount of the stop payment order. Allowable Values: decimal Format: 0.00
companyId string Returned	Alphanumeric code that identifies the direct deposit originator. Allowable Values: 10 char max
companyName string Conditionally returned	Name of the direct deposit originator. Allowable Values: 16 char max
withdrawOrder boolean Conditionally returned	Flag indicating whether the stop payment order is withdrawn. Allowable Values: `true`, `false`
createdTime datetime Conditionally returned	Date and time when the resource was created. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ
lastModifiedTime datetime Conditionally returned	Date and time when the resource was last updated. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ

Sample response body

JSON

{
  "ddaToken": "d5bd5921-048a-44c1-ba48-fe8ee0418f2d",
  "companyId": "9876543210",
  "token": "00acce2b-cefg-45ab-8417-f8a62326c0d6",
  "amount": 50.75,
  "companyName": "Friendship Inc.",
  "withdrawOrder": false,
  "createdTime": "2025-01-31T18:46:46Z",
  "lastModifiedTime": "2025-01-31T18:46:46Z"
}

Update stop payment order

Action: PUT
Endpoint: /directdeposits/stop-payment/{token} Use this endpoint to update an existing stop payment order.

URL path parameters

Fields	Description
token string Required	Unique identifier of the stop payment order to be updated. Allowable Values: Existing stop payment order token

Request body

Fields	Description
withdrawOrder boolean Required	Flag indicating whether the stop payment order is withdrawn. Allowable Values: `true`, `false`

Sample request body

JSON

{
    "withdrawOrder" : true
}

Response body

Fields	Description
token string Conditionally returned	Unique identifier for each stop payment order. Allowable Values: 36 char max
withdrawOrder boolean Conditionally returned	Flag indicating whether the stop payment order is withdrawn. Allowable Values: `true`, `false`
createdTime datetime Conditionally returned	Date and time when the resource was created. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ
lastModifiedTime datetime Conditionally returned	Date and time when the resource was last updated. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ

Sample response body

JSON

{
    "token": "00acce2b-cefg-45ab-8417-f8a62326c0d6",
    "withdrawOrder": true,
    "createdTime": "2025-01-31T18:46:46Z",
    "lastModifiedTime": "2025-01-31T18:47:51Z"
}

Retrieve stop payment order details

Action: GET
Endpoint: /directdeposits/stop-payment/{token} Use this endpoint to retrieve stop payment order details.

URL path parameters

Fields	Description
token string Required	Unique identifier of the stop payment order to be retrieved. Allowable Values: Existing stop payment order token

Response body

Fields	Description
token string Conditionally returned	Unique identifier for each stop payment order. Allowable Values: 36 char max
ddaToken string Returned	Unique identifier for the account in the system. Allowable Values: 36 char max
amount decimal Conditionally returned	Amount of the stop payment order. Allowable Values: decimal Format: 0.00
companyId string Returned	Alphanumeric code that identifies the direct deposit originator. Allowable Values: 10 char max
companyName string Conditionally returned	Name of the direct deposit originator. Allowable Values: 16 char max
withdrawOrder boolean Conditionally returned	Flag indicating whether the stop payment order is withdrawn. Allowable Values: `true`, `false`
createdTime datetime Conditionally returned	Date and time when the resource was created. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ
lastModifiedTime datetime Conditionally returned	Date and time when the resource was last updated. Allowable Values: string Format: yyyy-mm-ddThh:mm:ssZ

Sample response body

JSON

{
  "ddaToken": "d5bd5921-048a-44c1-ba48-fe8ee0418f2d",
  "companyId": "9876543210",
  "token": "00acce2b-cefg-45ab-8417-f8a62326c0d6",
  "amount": 50.75,
  "companyName": "Friendship Inc.",
  "withdrawOrder": true,
  "createdTime": "2025-01-31T18:46:46Z",
  "lastModifiedTime": "2025-01-31T18:47:51Z"
}

Core API Basics

SDKs

Credentials

Account Holders

Funding

Just-in-Time Funding

Cards

Digital Wallets

Spend Control

Accounts

Transactions

3D Secure

Real-Time Decisioning

Disputes

Digital Banking

Credit Programs

Credit Account Management

Credit Account Servicing

Credit Reward Accounts

Testing

Webhooks

​Retrieve direct deposit record

​URL path parameters

​Response body

​List direct deposit records

​URL query parameters

​Response body

​Create direct deposit transition

​Request body

​Response body

​List direct deposit transitions

​URL query parameters

​Response body

​Retrieve direct deposit transition

​URL path parameters

​Response body

​Create stop payment order

​Request body

​Sample request body

​Response body

​Sample response body

​Update stop payment order

​URL path parameters

​Request body

​Sample request body

​Response body

​Sample response body

​Retrieve stop payment order details

​URL path parameters

​Response body

​Sample response body

Retrieve direct deposit record

URL path parameters

Response body

List direct deposit records

URL query parameters

Response body

Create direct deposit transition

Request body

Response body

List direct deposit transitions

URL query parameters

Response body

Retrieve direct deposit transition

URL path parameters

Response body

Create stop payment order

Request body

Sample request body

Response body

Sample response body

Update stop payment order

URL path parameters

Request body

Sample request body

Response body

Sample response body

Retrieve stop payment order details

URL path parameters

Response body

Sample response body