REST APIFiatPlaid

POST

Exchanges a public token received from Plaid Link for secure storage. After a user completes the Plaid Link flow, the client receives a public token which must be exchanged using this endpoint to complete the bank account linking process.

Body Params

object

  • enterpriseId string required
    The ID of the enterprise

    at least 1 characters

  • publicToken string required
    The public token received from the Plaid Link Widget

    at least 1 characters

  • linkToken string required
    The link token used to initiate the Plaid Link flow

    at least 1 characters

  • ipAddress string ipv4
    IP address of the end-user who completed the Plaid Link flow. Although optional, it is highly recommended to provide this value as it may impact the user's trust score.

Responses

200
OK

Response Body

object

  • data object required
    data object
    • publicToken string required
      The public token that was exchanged
    • linkToken string required
      The link token associated with this exchange
400
Bad Request - Missing required parameters

Response Body

object

  • errorName string required
  • error string required
404
Not Found - Enterprise or link token not found

Response Body

object

  • errorName string required
  • error string required
500
Internal Server Error

Response Body

object

  • errorName string required
  • error string required