POST /processor/signal/decision/report
After calling /processor/signal/evaluate
, call /processor/signal/decision/report
to report whether the transaction was initiated.
If you are using the Plaid Transfer product to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was initiated.
Servers
- https://production.plaid.com
- https://sandbox.plaid.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
decision_outcome |
String | No |
The payment decision from the risk assessment.
Possible values: Possible values:
|
client_id |
String | No |
Your Plaid API |
processor_token |
String | Yes |
The processor token obtained from the Plaid integration partner. Processor tokens are in the format: |
initiated |
Boolean | Yes |
This field must be returned as a boolean. If formatted incorrectly, this will result in an |
client_transaction_id |
String | Yes |
Must be the same as the |
payment_method |
String | No |
The payment method to complete the transaction after the risk assessment. It may be different from the default payment method.
Possible values: Possible values:
|
days_funds_on_hold |
Integer | No |
The actual number of days (hold time) since the ACH debit transaction that you wait before making funds available to your customers. The holding time could affect the ACH return rate. For example, use 0 if you make funds available to your customers instantly or the same day following the debit transaction, or 1 if you make funds available the next day following the debit initialization. |
secret |
String | No |
Your Plaid API |
amount_instantly_available |
Number | No |
The amount (in USD) made available to your customers instantly following the debit transaction. It could be a partial amount of the requested transaction (example: 102.05). |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.