action plaid_payment_profile_get {
  label: "Get payment profile"
  description: "Use `/payment_profile/get` endpoint to get the status of a given Payment Profile."
  provider: plaid
  method: POST
  path: "/payment_profile/get"
  encoding: json
  input: {
    type: "object"
    description: "PaymentProfileGetRequest defines the request schema for `/payment_profile/get`"
    required: ["payment_profile_token"]
    properties: {
      client_id: {
        type: "string"
        description: "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."
      }
      payment_profile_token: {
        type: "string"
        description: "A payment profile token associated with the Payment Profile data that is being requested."
      }
      secret: {
        type: "string"
        description: "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."
      }
    }
  }
  output: {
    type: "object"
    description: "PaymentProfileGetResponse defines the response schema for `/payment_profile/get`"
    required: ["created_at", "deleted_at", "request_id", "status", "updated_at"]
    properties: {
      created_at: {
        type: "string"
        format: "date-time"
        description: "Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:mm:ssZ`) indicating the time the given Payment Profile was created at"
      }
      deleted_at: {
        type: "string"
        format: "date-time"
        description: "Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:mm:ssZ`) indicating the time the given Payment Profile was deleted at. Always `null` if the Payment Profile has not been deleted"
      }
      request_id: {
        type: "string"
        description: "A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive."
      }
      status: {
        type: "string"
        description: "The status of the given Payment Profile.\n\n`READY`: This Payment Profile is ready to be used to create transfers using `/transfer/authorization/create` and `/transfer/create`.\n\n`PENDING`: This Payment Profile is not ready to be used. You’ll need to call `/link/token/create` and provide the `payment_profile_token` in the `transfer.payment_profile_token` field to initiate the account linking experience.\n\n`REMOVED`: This Payment Profile has been removed."
        enum: ["PENDING", "READY", "REMOVED"]
      }
      updated_at: {
        type: "string"
        format: "date-time"
        description: "Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:mm:ssZ`) indicating the last time the given Payment Profile was updated at"
      }
    }
  }
}