createPaymentToken
The /payment_initiation/payment/token/create endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, link_token-based flow. The recommended flow is to provide the payment_id to /link/token/create, which returns a link_token used to initialize Link.
The /payment_initiation/payment/token/create is used to create a payment_token, which can then be used in Link initialization to enter a payment initiation flow. You can only use a payment_token once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input.
Authorization
PLAID-CLIENT-ID PLAID-SECRET Plaid-Version In: header
In: header
In: header
Request Body
application/json
PaymentInitiationPaymentTokenCreateRequest defines the request schema for /payment_initiation/payment/token/create
Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.
Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
The payment_id returned from /payment_initiation/payment/create.
1 <= lengthResponse Body
application/json
curl -X POST "https://example.com/payment_initiation/payment/token/create" \ -H "Content-Type: application/json" \ -d '{ "payment_id": "string" }'{ "payment_token": "payment-token-sandbox-feca8a7a-5591-4aef-9297-f3062bb735d3", "payment_token_expiration_time": "2020-01-01T00:00:00Z", "request_id": "4ciYVmesrySiUAB"}paymentInitiationPaymentGet POST
The `/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the `/payment_initiation/payment/get` endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order.
paymentInitiationPaymentList POST
The `/payment_initiation/payment/list` endpoint can be used to retrieve all created payments. By default, the 10 most recent payments are returned. You can request more payments and paginate through the results using the optional `count` and `cursor` parameters.